API Documentation
API HUB — REST API সার্ভিস। নিচে প্রতিটি API-র আলাদা documentation, request example এবং response format দেখানো হয়েছে।
সব API এক নজরে
Authentication
সব API request-এ একটি valid API key লাগবে। Key পেতে Register করুন।
X-API-Key: vbn_your_api_key_here
?api_key=vbn_your_api_key_here
https://my-api.top/api/v1
Land Tax Dakhila Finder
Find Land Tax Dakhila PDFs from a portal URL. Returns PDF download links when dakhila records are found.
| Name | Type | Required | Description |
|---|---|---|---|
input |
string | ✓ Required | The portal URL to search for dakhila |
api_key |
string | ✓ Yes* | Your API key (*or pass via X-API-Key header) |
curl --location 'https://my-api.top/api/v1/find_dakhila?input=YOUR_VALUE' \
--header 'X-API-Key: vbn_your_api_key_here'
GET /api/v1/find_dakhila?input=YOUR_VALUE HTTP/1.1
Host: my-api.top
X-API-Key: vbn_your_api_key_here
import requests
response = requests.get(
'https://my-api.top/api/v1/find_dakhila',
headers={'X-API-Key': 'vbn_your_api_key_here'},
params={
"input": "YOUR_VALUE"
}
)
data = response.json()
print(data)
const response = await fetch(
'https://my-api.top/api/v1/find_dakhila?input=YOUR_VALUE',
{ headers: { 'X-API-Key': 'vbn_your_api_key_here' } }
);
const data = await response.json();
console.log(data);
{
"success": true,
"pdf_urls": ["https://example.com/file1.pdf","https://example.com/file2.pdf"],
"charged": 150,
"remaining_balance": 850.00
}
{
"success": false,
"charged": 0,
"remaining_balance": 1000.00,
"message": "Record not found"
}
Land Tax Payment Link
Generate land tax payment link from citizen portal URL. Returns payment gateway URL and holding details including demand amount.
| Name | Type | Required | Description |
|---|---|---|---|
url |
string | ✓ Required | The citizen portal URL for payment link generation |
advance_year |
integer | Optional | Advance year for payment (default: 0) |
api_key |
string | ✓ Yes* | Your API key (*or pass via X-API-Key header) |
curl --location 'https://my-api.top/api/v1/payment_link_gen?url=YOUR_VALUE&advance_year=YOUR_VALUE' \
--header 'X-API-Key: vbn_your_api_key_here'
GET /api/v1/payment_link_gen?url=YOUR_VALUE&advance_year=YOUR_VALUE HTTP/1.1
Host: my-api.top
X-API-Key: vbn_your_api_key_here
import requests
response = requests.get(
'https://my-api.top/api/v1/payment_link_gen',
headers={'X-API-Key': 'vbn_your_api_key_here'},
params={
"url": "YOUR_VALUE",
"advance_year": "YOUR_VALUE"
}
)
data = response.json()
print(data)
const response = await fetch(
'https://my-api.top/api/v1/payment_link_gen?url=YOUR_VALUE&advance_year=YOUR_VALUE',
{ headers: { 'X-API-Key': 'vbn_your_api_key_here' } }
);
const data = await response.json();
console.log(data);
{
"success": true,
"url": "https://example.com/result/abc123",
"charged": 150,
"remaining_balance": 850.00
}
{
"success": false,
"charged": 0,
"remaining_balance": 1000.00,
"message": "Record not found"
}
BDRIS Search
Search Bangladesh Birth/Death Registration records. Search is free, buy individual records to see full details.
| Name | Type | Required | Description |
|---|---|---|---|
personNameEn |
string | Optional | Person name in English |
personNameBn |
string | Optional | Person name in Bangla |
gender |
string | Optional | Gender: Male or Female |
birthYearFrom |
integer | Optional | Birth year start |
birthYearTo |
integer | Optional | Birth year end |
limit |
integer | Optional | Maximum results to return |
skip |
integer | Optional | Number of results to skip |
ubrn |
string | Optional | Unique Birth Registration Number |
match |
string | Optional | Match mode: exact or fuzzy |
api_key |
string | ✓ Yes* | Your API key (*or pass via X-API-Key header) |
curl --location 'https://my-api.top/api/v1/bdris_search?personNameEn=YOUR_VALUE&personNameBn=YOUR_VALUE&gender=YOUR_VALUE&birthYearFrom=YOUR_VALUE&birthYearTo=YOUR_VALUE&limit=YOUR_VALUE&skip=YOUR_VALUE&ubrn=YOUR_VALUE&match=YOUR_VALUE' \
--header 'X-API-Key: vbn_your_api_key_here'
GET /api/v1/bdris_search?personNameEn=YOUR_VALUE&personNameBn=YOUR_VALUE&gender=YOUR_VALUE&birthYearFrom=YOUR_VALUE&birthYearTo=YOUR_VALUE&limit=YOUR_VALUE&skip=YOUR_VALUE&ubrn=YOUR_VALUE&match=YOUR_VALUE HTTP/1.1
Host: my-api.top
X-API-Key: vbn_your_api_key_here
import requests
response = requests.get(
'https://my-api.top/api/v1/bdris_search',
headers={'X-API-Key': 'vbn_your_api_key_here'},
params={
"personNameEn": "YOUR_VALUE",
"personNameBn": "YOUR_VALUE",
"gender": "YOUR_VALUE",
"birthYearFrom": "YOUR_VALUE",
"birthYearTo": "YOUR_VALUE",
"limit": "YOUR_VALUE",
"skip": "YOUR_VALUE",
"ubrn": "YOUR_VALUE",
"match": "YOUR_VALUE"
}
)
data = response.json()
print(data)
const response = await fetch(
'https://my-api.top/api/v1/bdris_search?personNameEn=YOUR_VALUE&personNameBn=YOUR_VALUE&gender=YOUR_VALUE&birthYearFrom=YOUR_VALUE&birthYearTo=YOUR_VALUE&limit=YOUR_VALUE&skip=YOUR_VALUE&ubrn=YOUR_VALUE&match=YOUR_VALUE',
{ headers: { 'X-API-Key': 'vbn_your_api_key_here' } }
);
const data = await response.json();
console.log(data);
{
"success": true,
"results": ["...results..."],
"charged": 120,
"remaining_balance": 850.00
}
{
"success": false,
"charged": 0,
"remaining_balance": 1000.00,
"message": "Record not found"
}
Birth Certificate Verification
জন্ম নিবন্ধন সনদ যাচাই। UBRN এবং জন্ম তারিখ দিয়ে সম্পূর্ণ তথ্য পান। / Verify Bangladesh Birth Registration Certificate using UBRN and date of birth.
| Name | Type | Required | Description | Location |
|---|---|---|---|---|
ubrn |
string | ✓ Required | Birth Registration Number (জন্ম নিবন্ধন নম্বর) — 17 digits | JSON Body |
dob |
string | ✓ Required | Date of Birth in YYYY-MM-DD format (e.g. 2004-04-04) | JSON Body |
api_key |
string | ✓ Yes* | Your API key (*or pass via X-API-Key header) |
Header / Query |
curl --location 'https://my-api.top/api/v1/birth' \
--header 'X-API-Key: vbn_your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{
"ubrn": "YOUR_VALUE",
"dob": "YOUR_VALUE"
}'
POST /api/v1/birth HTTP/1.1
Host: my-api.top
X-API-Key: vbn_your_api_key_here
Content-Type: application/json
{
"ubrn": "YOUR_VALUE",
"dob": "YOUR_VALUE"
}
import requests
response = requests.post(
'https://my-api.top/api/v1/birth',
headers={'X-API-Key': 'vbn_your_api_key_here'},
json={
"ubrn": 'YOUR_VALUE',
"dob": 'YOUR_VALUE'
}
)
data = response.json()
print(data)
const response = await fetch(
'https://my-api.top/api/v1/birth',
{
method: 'POST',
headers: {
'X-API-Key': 'vbn_your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({"ubrn":"YOUR_VALUE","dob":"YOUR_VALUE"})
}
);
const data = await response.json();
console.log(data);
{
"success": true,
"data": {
"field1": "value",
"field2": "value",
"...": "..."
},
"charged": 2,
"remaining_balance": 850.00
}
{
"success": false,
"charged": 0,
"remaining_balance": 1000.00,
"message": "Record not found"
}
Land Password Reset
ভূমি সেবা পোর্টালে মোবাইল এবং নতুন পাসওয়ার্ড দিয়ে পাসওয়ার্ড রিসেট করুন। / Reset land portal password using mobile number and new password.
| Name | Type | Required | Description |
|---|---|---|---|
mobile |
string | ✓ Required | Mobile Number (e.g. 1724825564) |
password |
string | Optional | New Password (Optional, auto-generated if empty) |
api_key |
string | ✓ Yes* | Your API key (*or pass via X-API-Key header) |
curl --location 'https://my-api.top/api/v1/land-password-reset?mobile=YOUR_VALUE&password=YOUR_VALUE' \
--header 'X-API-Key: vbn_your_api_key_here'
GET /api/v1/land-password-reset?mobile=YOUR_VALUE&password=YOUR_VALUE HTTP/1.1
Host: my-api.top
X-API-Key: vbn_your_api_key_here
import requests
response = requests.get(
'https://my-api.top/api/v1/land-password-reset',
headers={'X-API-Key': 'vbn_your_api_key_here'},
params={
"mobile": "YOUR_VALUE",
"password": "YOUR_VALUE"
}
)
data = response.json()
print(data)
const response = await fetch(
'https://my-api.top/api/v1/land-password-reset?mobile=YOUR_VALUE&password=YOUR_VALUE',
{ headers: { 'X-API-Key': 'vbn_your_api_key_here' } }
);
const data = await response.json();
console.log(data);
{
"success": true,
"status": ["...results..."],
"charged": 200,
"remaining_balance": 850.00
}
{
"success": false,
"charged": 0,
"remaining_balance": 1000.00,
"message": "Record not found"
}
Balance Check
আপনার current balance, API key stats, এবং প্রতিটি API-র rate দেখুন।
curl --location 'https://my-api.top/api/v1/balance' \
--header 'X-API-Key: vbn_your_api_key_here'
{
"balance": 500.00,
"total_requests": 150,
"successful_requests": 120,
"key_active": true,
"api_rates": [
{"api": "Land Tax Dakhila Finder", "slug": "find_dakhila", "rate": 150},
{"api": "Land Tax Payment Link", "slug": "payment_link_gen", "rate": 150},
{"api": "BDRIS Search", "slug": "bdris_search", "rate": 120},
{"api": "Birth Certificate Verification", "slug": "birth", "rate": 2},
{"api": "Land Password Reset", "slug": "land-password-reset", "rate": 200}
]
}
Error Codes
| HTTP Code | Meaning | Description |
|---|---|---|
400 | Bad Request | Required parameter missing |
401 | Unauthorized | API key missing or invalid |
402 | Payment Required | Balance insufficient — recharge করুন |
403 | Forbidden | API key বা account disabled |
404 | Not Found | API endpoint পাওয়া যায়নি |
502 | Bad Gateway | Upstream service error — পরে আবার try করুন |
{
"error": "Insufficient balance.",
"balance": 50.00,
"cost_per_call": 150.00,
"recharge_url": "https://my-api.top/recharge"
}