Free API
ImmuniWeb Community Edition provides a free API for the Dark Web Exposure Test. It shares the number of tests performed via web interface.
| Account type | Tests per day | Monthly subscription |
| No Account | 2 | Free |
| Free Account | 4 | Free |
Premium API
ImmuniWeb Community Edition also provide a premium API for a higher number of tests via API or web interface:
| Select package | Tests per day | Monthly subscription |
| 10 | $299 | |
| 50 | $1495 | |
| 100 | $2990 | |
| 250 | $7995 |
Total: $299
Get in touch for details.
Public schools, local governments and non-for-profit organizations may request a free access to the premium API.
API Documentation
API Specifications
| Field Name | Value |
| Protocol | HTTP/HTTPS |
| Request Type | POST |
| URL | https://www.immuniweb.com/darkweb/api/v1/scan/[ustamp].html - where "ustamp" is an arbitrary UNIX time-stamp (must be an integer). Such construction is done to prevent caching on client side. |
POST Data Specification
| Field Name | Value |
| api_key | secret token which you submit alongside with the request |
| domain | the domain name to be tested. |
| limit | limit the amount of results shown. |
| offset | offset if results are limited |
| no_limit | 0 or 1 |
| dnsr | "on" means that test results will be hidden, "off" means that test results will be displayed in statistics. |
| recheck | "false" will use results from cache if the server has been tested within the past 24 hours, "true" will perform a new test without looking at the cache. |
Example of Transaction Using CURL
# New test (not cached)
curl -d "domain=twitter.com&dnsr=off&recheck=false" "https://www.immuniweb.com/darkweb/api/v1/scan/1451425590.html"
{
"job_id": "2a9e1f1bc92dc0c7a4bde930dff488771eea6d36988208d34163c5496227b8dc",
"status": "test_started",
"status_id": 1,
"message": "Test has started"
}
"job_id": "2a9e1f1bc92dc0c7a4bde930dff488771eea6d36988208d34163c5496227b8dc",
"status": "test_started",
"status_id": 1,
"message": "Test has started"
}
curl -d "job_id=2a9e1f1bc92dc0c7a4bde930dff488771eea6d36988208d34163c5496227b8dc" "https://www.immuniweb.com/darkweb/api/v1/get_result/1451425590.html"
{
"job_id": "2a9e1f1bc92dc0c7a4bde930dff488771eea6d36988208d34163c5496227b8dc",
"status": "in_progress",
"status_id": 2,
"eta": 2,
"message": "Your test is in progress"
}
"job_id": "2a9e1f1bc92dc0c7a4bde930dff488771eea6d36988208d34163c5496227b8dc",
"status": "in_progress",
"status_id": 2,
"eta": 2,
"message": "Your test is in progress"
}
New test (cached)
curl -d "domain=twitter.com&dnsr=off&recheck=false" "https://www.immuniweb.com/darkweb/api/v1/scan/1451425590.html"
{
"test_id": "c84936eef26eeb8aaef5ffc43f38ddb91adfd90ac27fb416bd0b21fe2edb1004",
"status": "test_cached",
"status_id": 3,
"message": "Test is cached"
}
"test_id": "c84936eef26eeb8aaef5ffc43f38ddb91adfd90ac27fb416bd0b21fe2edb1004",
"status": "test_cached",
"status_id": 3,
"message": "Test is cached"
}
curl -d "id=c84936eef26eeb8aaef5ffc43f38ddb91adfd90ac27fb416bd0b21fe2edb1004" "https://www.immuniweb.com/darkweb/api/v1/get_result/1451425590.html"
{ ... }Example with error
curl -d "domain=0.0.0.0&dnsr=off&recheck=false" "https://www.immuniweb.com/darkweb/api/v1/scan/1451425590.html"
{
"error": "Domain name 0.0.0.0 was resolved in an invalid IP address",
"error_name": "invalid_ip_resolved",
"error_id": 16
}
"error": "Domain name 0.0.0.0 was resolved in an invalid IP address",
"error_name": "invalid_ip_resolved",
"error_id": 16
}
Download PDF
curl -d "api_key=your_api_key" "https://www.immuniweb.com/darkweb/gen_pdf/test_id/" > report.pdf