You can find API v0 documentation here.
Authentication: You can authorize using API key.
Response header HTTP status:
Response body: On success "status" = "OK", "response" = "OK". On error "status" = "ERROR" and "response" contains error description.
Method | API key access level |
Calls per second | Calls per minute | Calls per hour |
Get blacklist monitor (IP, domain) | Any | 5 | 120 | 2,000 |
List blacklist monitors (IP, domain) | Any | 5 | 20 | 200 |
Get blacklist monitor and blacklists (IP, Domain) | Any | 5 | 120 | 1,000 |
List blacklist monitors and blacklists (IP, Domain) | Any | 5 | 20 | 200 |
Create blacklist monitor (IP, Domain) | Unrestricted | 5 | 200 | Not limited |
Delete blacklist monitor (IP, Domain) | Unrestricted | 5 | 200 | Not limited |
Blacklist Check | Any | 5+ | 60+ | Not limited |
Blacklist monitors | ISP plan Get + List |
Basic plan Get + List |
Professional plan Get + List |
Standard plan Get + List |
Plus plan Get + List |
Premium plan Get + List |
Create | Delete | Blacklist Check |
2 | 1,000 | 200 | |||||||
3 | 2,000 | 5,000 | 100 | 100 | 300 | ||||
5, 7 | 2,000 | 8,000 | 100 | 100 | 300 | ||||
10 | 1,000 | 4,000 | 8,000 | 15,000 | 200 | 200 | 300 | ||
20 | 2,000 | 8,000 | 15,000 | 30,000 | 200 | 200 | 300 | ||
30 | 1,000 | 3,000 | 12,000 | 25,000 | 45,000 | 200 | 200 | 300 | |
50 | 1,000 | 5,000 | 20,000 | 40,000 | 75,000 | 300 | 300 | 500 | |
100 | 10,000 | 40,000 | 75,000 | 150,000 | 500 | 500 | 700 | ||
200 | 1,000 | 75,000 | 150,000 | 1,000 | 1,000 | 800 | |||
300 | 20,000 | 115,000 | 230,000 | 1,500 | 1,500 | 1,000 | |||
400 | 150,000 | 300,000 | 2,000 | 2,000 | 1,000 | ||||
600 | 2,000 | 30,000 | 230,000 | 450,000 | 3,000 | 3,000 | 1,500 | ||
1,024 | 3,000 | 30,000 | 240,000 | 450,000 | 4,000 | 4,000 | 2,000 | ||
2,048 | 10,000 | 10,000 | 40,000 | 250,000 | 500,000 | 6,000 | 6,000 | 2,000 | |
4,096 | 10,000 | 20,000 | 50,000 | 300,000 | 600,000 | 10,000 | 10,000 | 3,000 | |
8,192 | 10,000 | 30,000 | 50,000 | 15,000 | 15,000 | 3,000 | |||
16,384 | 10,000 | 50,000 | 100,000 | 25,000 | 25,000 | 5,000 | |||
32,768 | 10,000 | 40,000 | 40,000 | 7,000 | |||||
65,536 | 10,000 | 70,000 | 70,000 | 10,000 |
For annual billing plans, monthly API usage counters are reset on the first day of each month at 0:00 UTC. For monthly payment plans, monthly API usage counters are reset at the time the next monthly payment is received.
If the rate limit is exceeded, API responds with a HTTP 429 Too Many Requests response code:
HTTP/1.1 429 Too Many Requests
Content-Type: application/json
{
"status": "ERROR",
"response": "Too Many Requests"
}
List IP address blacklist monitors https://www.blacklistmaster.com/restapi/v1/ip?apikey=<APIKey>
Get IP address blacklist monitor https://www.blacklistmaster.com/restapi/v1/ip/<IPAddress>?apikey=<APIKey>
HTTP method: GET
Example request: Get all IP addresses, API key "12345"
curl https://www.blacklistmaster.com/restapi/v1/ip?apikey=12345
Example Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "SUCCESS",
"API_calls_remaining": 19996,
"response": "OK",
"IPs":
[
{
"ip": "1.1.1.1",
"group_name": "",
"ip_description": "Web server",
"last_test_date_UTC": "2013-03-26 11:28:15",
"blacklist_cnt": "3",
"new_blacklist_cnt": "3",
},
{
"ip": "2.2.2.2",
"group_name": "",
"ip_description": "Mail server",
"last_test_date_UTC": "2013-03-26 11:28:15",
"blacklist_cnt": "3",
"new_blacklist_cnt": "3",
}
]
}
Get IP address 1.2.3.4, API key "12345"
curl https://www.blacklistmaster.com/restapi/v1/ip/1.2.3.4?apikey=12345
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "SUCCESS",
"API_calls_remaining": 19990,
"response": "OK",
"IPs": [
{
"ip": "1.2.3.4",
"group_name": "Test",
"ip_description": "Web server",
"last_test_date_UTC": "2013-10-21 14:02:17",
"blacklist_cnt": "2",
"new_blacklist_cnt": "1",
}
],
"blacklists": [
{
"blacklist": "dnsbl.example.com",
"blacklist_name": "Example RBL",
"blacklist_url": "http://www.example.com",
"is_new": "0"
},
{
"blacklist": "some.rbl.org",
"blacklist_name": "Some RBL",
"blacklist_url": "http://www.rbl.org",
"is_new": "1"
}
]
}
List IP address blacklist monitors and blacklists https://www.blacklistmaster.com/restapi/v1/ipbl?apikey=<APIKey>
Get IP address blacklist monitor and blacklists https://www.blacklistmaster.com/restapi/v1/ipbl/<IPAddress>?apikey=<APIKey>
List IP address blacklist monitors, blacklisting severity and blacklists IPs listed in. Blacklisting severity is maximum severity level of RBLs the IP is listed in. It's possible to set Medium or High severity level to every blacklist.
HTTP method: GET
Example request: Get all IP addresses, API key "12345"
curl https://www.blacklistmaster.com/restapi/v1/ipbl?apikey=12345
Example Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "SUCCESS",
"API_calls_remaining": 19996,
"response": "OK",
"IPs":
[
{
"ip": "1.2.3.4",
"group_name": "Mail servers",
"ip_description": "Mail server",
"last_test_date_UTC": "2017-09-02 13:01:02",
"blacklist_cnt": "3",
"new_blacklist_cnt": "0"
"severity": "High",
"blacklists":
[
{
"blacklist": "rbl.somerbl.org",
"blacklist_name": "Some RBL",
"blacklist_url": "http://somerbl.org",
"is_new": "0",
"severity": "Medium"
},
{
"blacklist": "dnsbl.powerrbl.net",
"blacklist_name": "Power RBL",
"blacklist_url": "http://www.powerrbl.net",
"is_new": "0",
"severity": "High"
},
]
},
{
"ip": "4.3.2.1",
"group_name": "Web servers",
"ip_description": "Company.com website",
"last_test_date_UTC": "2017-09-02 13:41:25",
"blacklist_cnt": "0",
"new_blacklist_cnt": "0"
"severity": "",
"blacklists":
[
]
},
]
}
https://www.blacklistmaster.com/restapi/v1/ip?apikey=<APIKey>
HTTP method: POST
POST variables: id - IP address, ip_description - IP address description, group_id - Group ID, contactlist - Contact List ID.
To find Contact List ID and Group ID please visit your Contact Lists and Groups page.
Example requests: Add IP address "1.1.1.1", IP address description: "Mail server 01", Group ID "2", contact list ID 1, API key "12345"
curl -X POST -d "id=1.1.1.1&ip_description=Mail server 01&group_id=2&contactlist=1" https://www.blacklistmaster.com/restapi/v1/ip?apikey=12345
Add IP address 1.1.1.1, empty description, empty group, contact list 2, API key "12345"
curl -X POST -d "id=1.1.1.1&contactlist=2" https://www.blacklistmaster.com/restapi/v1/ip?apikey=12345
Example Response:
HTTP/1.1 201 Created
Content-Type: application/json
{
"status": "SUCCESS",
"API_calls_remaining": 199,
"response": "OK"
}
https://www.blacklistmaster.com/restapi/v1/ip/<IPAddress>?apikey=<APIKey>
HTTP method: DELETE
Example request: Delete IP address 1.1.1.1, API key "12345"
curl -X DELETE https://www.blacklistmaster.com/restapi/v1/ip/1.1.1.1?apikey=12345
Example Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "SUCCESS",
"API_calls_remaining": 199,
"response": "OK"
}
List domain name blacklist monitors https://www.blacklistmaster.com/restapi/v1/domain?apikey=<APIKey>
Get domain name blacklist monitor https://www.blacklistmaster.com/restapi/v1/domain/<domain>?apikey=<APIKey>
HTTP method: GET
Example requests: Get all domain names, API key "12345"
curl https://www.blacklistmaster.com/restapi/v1/domain?apikey=12345
Get example.com, API key "12345"
curl https://www.blacklistmaster.com/restapi
Example Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "SUCCESS",
"API_calls_remaining": 19996,
"response": "OK",
"domains":
[
{
"domain": "example.com",
"last_test_date_UTC": "2013-03-26 11:28:15",
"group_name": "Webservers",
"blacklist_cnt": "3",
"new_blacklist_cnt": "3"
},
{
"domain": "domain.com",
"group_name": "",
"last_test_date_UTC": "2013-03-26 11:28:15",
"blacklist_cnt": "5",
"new_blacklist_cnt": "3"
}
]
}
List domain name blacklist monitors and blacklists https://www.blacklistmaster.com/restapi/v1/domainbl?apikey=<APIKey>
Get domain name blacklist monitor and blacklists https://www.blacklistmaster.com/restapi/v1/domainbl/<domain>?apikey=<APIKey>
List domain name blacklist monitors, blacklisting severity and blacklists domain names listed in. Blacklisting severity is maximum severity level of RBLs domain name is listed in. It's possible to set Medium or High severity level to every blacklist.
HTTP method: GET
Example requests: Get all domain names, API key "12345"
curl https://www.blacklistmaster.com/restapi/v1/domainbl?apikey=12345
Example Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "SUCCESS",
"API_calls_remaining": 19956,
"response": "OK",
"domains":
[
{
"domain": "domain.com",
"last_test_date_UTC": "2017-09-02 15:01:41",
"blacklist_cnt": "0",
"new_blacklist_cnt": "0",
"severity": "",
"blacklists":
[
]
},
{
"domain": "example.com",
"last_test_date_UTC": "2017-09-02 15:16:53",
"blacklist_cnt": "3",
"new_blacklist_cnt": "1",
"severity": "Medium",
"blacklists":
[
{
"blacklist": "bl.rbl1.org",
"blacklist_name": "rbl1.org blacklist",
"blacklist_url": "http://www.rbl1.org",
"is_new": "1",
"severity": "Medium"
},
{
"blacklist": "bl.rbl2.org",
"blacklist_name": "rbl2.org blacklist",
"blacklist_url": "http://rbl2.org",
"is_new": "0",
"severity": "Medium"
},
{
"blacklist": "bl.rbl3.org",
"blacklist_name": "rbl3.org blacklist",
"blacklist_url": "http://rbl3.org",
"is_new": "0",
"severity": "Medium"
}
]
}
]
}
https://www.blacklistmaster.com/restapi/v1/domain?apikey=<APIKey>
HTTP method: POST
POST variables: id - domain name, group_id - Group ID, contactlist - Contact List ID.
To find Contact List ID and Group ID please visit your Contact Lists and Groups page.
Example request: Add domain name example.com, contact list 1, API key "12345"
curl -X POST -d "id=example.com&contactlist=1" https://www.blacklistmaster.com/restapi/v1/domain?apikey=12345
Example Response:
HTTP/1.1 201 Created
Content-Type: application/json
{
"status": "SUCCESS",
"API_calls_remaining": 199,
"response": "OK"
}
https://www.blacklistmaster.com/restapi/v1/domain/<domain>?apikey=<APIKey>
HTTP method: DELETE
Example request: Delete domain name example.com, API key "12345"
curl -X DELETE https://www.blacklistmaster.com/restapi
Example Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "SUCCESS",
"API_calls_remaining": 199,
"response": "OK"
}
https://www.blacklistmaster.com/restapi/v1/blacklistcheck/ip/<IP_Address>?apikey=<APIKey>
https://www.blacklistmaster.com/restapi/v1/blacklistcheck/domain/<DomainName>?apikey=<APIKey>
HTTP method: GET
Response body: On success "response" is "OK". On error "response" contains error description. If blacklisted, "status" is "Blacklisted", "blacklist_cnt" contains number of blacklists, "blacklist_severity" contains maximum severity level of RBLs the IP or domain is listed in ("High" or "Medium"). If not, "status" is "Not blacklisted", "blacklist_cnt" is 0, "blacklist_severity" is empty string.
Example request: Check IP address "1.2.3.4", API key "12345"
curl https://www.blacklistmaster.com/restapi
Example Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "Blacklisted",
"blacklist_cnt": 2,
"blacklist_severity": "High",
"API_calls_remaining": 1241,
"response": "OK",
"blacklists":
[
{
"blacklist": "rbl.somerbl.org",
"blacklist_name": "Some RBL",
"blacklist_url": "http://www.somerbl.org"
"blacklist_severity": "Medium"
},
{
"blacklist": "dnsbl.powerrbl.net",
"blacklist_name": "Power RBL",
"blacklist_url": "http://www.powerrbl.net"
"blacklist_severity": "High"
}
]
}