Domain Search API (V2)
Bulk Domain Search API Documentation
Domain Search - Send File
The domain-search/sendfile API allows you to send a file for bulk domain search. This guide will provide everything you need to know on how to find domains in bulk via API.
There is no restriction on the file size, number of emails, or number of files you can submit using this endpoint.
Each search will consume 20 credits if a valid email format is returned. If you are a monthly subscriber, the API call will consume 1 Email Finderⓘ query if a valid format is returned. As long as you have the available queries via subscription or the credits in your account to cover the number of searches submitted in the file, your file will be accepted.
To avoid API interruptions, consider activating AutoPay in your ZeroBounce account settings to ensure you never run out of credits.
POST /DOMAIN-SEARCH/SENDFILE
API URL: https://bulkapi.zerobounce.net/domain-search/sendfile
The Body content type needs to be multipart/form-data.
URL Parameters
- ParameterDescription
- fileThe csv or txt file. Byte array contents for the submitted file. The content's header is type of "text/csv"
- api_keyYour API Key, found in your account. (Required)
- domain_columnThe column index of the domain in the file. Index starts from 1. (Required)
- has_header_rowIf the first row from the submitted file is a header row. true or false (Optional)
ENDPOINT RESPONSE
Successful Response
Error Response
Need help sending your file for bulk domain search? Let us know – our team is available around the clock to assist you.
Domain Search - File Status
The domain search filestatus API returns the file processing status for the file that has been submitted using the domain search sendfile API.
GET /DOMAIN-SEARCH/FILESTATUS
API URL: https://bulkapi.zerobounce.net/domain-search/filestatus
URL Parameters
- ParameterDescription
- api_keyYour API Key, found in your account. (Required)
- file_idThe returned file ID when calling sendfile API.
If you want to call the API from your browser to test it, replace the API KEY parameter with your unique API key (found in your
https://bulkapi.zerobounce.net/domain-search/filestatus?api_key=[replacewithyours]&file_id=[replacewithyours]
ENDPOINT RESPONSE
Successful Response
Error Response
For each domain it verifies, the email finderⓘ API consumes 1 query (if you have an Email Deliverabilityⓘ Toolkit subscription active). If you have credits or use Pay-As-You-Go, Domain Search will consume 20 credits per successful result. If you use the API regularly, take measures to ensure your account is replenished periodically with credits to avoid interruptions.
Need help determining the status of your domain search API files? Please reach out to our Customer Support team. We are available around the clock to answer any questions and assist you.
Domain Search - Get File
The domain search getfile API allows you to get the results for the file you submitted using domain search sendfile API.
GET /DOMAIN-SEARCH/GETFILE
API URL: https://bulkapi.zerobounce.net/domain-search/getfile
URL Parameters
- ParameterDescription
- api_keyYour API Key, found in your account. (Required)
- file_idThe returned file ID when calling sendfile API.
If you want to call the API from your browser to test it, all you have to do is to replace the API KEY parameter with your API key (found in your ZeroBounce account settings ) and the FILE ID with the returned file ID from sendfile API:
https://bulkapi.zerobounce.net/email-finder/getfile?api_key=replacewithyours&file_id=[replacewithyours]
ENDPOINT RESPONSE
Successful Response
The domain search getfile API returns the domain search results file. The returned content type is "application/octet-stream". You can get the file name from response.Content.Headers.ContentDisposition.FileName. If you are calling the API directly from the browser, you can either save or open the results file from the browser.
Error Response
Need help getting your domain search API results? Our team is here to lend a hand. Reach out to us anytime. We offer 24/7 customer support.
Domain Search - Delete File
The domain search deletefile API allows you to delete the file that you submitted using the domain search sendfile API. Please note that the file can be deleted only when its status is Complete.
GET /DOMAIN-SEARCH/DELETEFILE
API URL: https://bulkapi.zerobounce$.net/domain-search/deletefile
URL Parameters
- ParameterDescription
- api_keyYour API Key, found in your account. (Required)
- file_idThe returned file ID when calling sendfile API.
ENDPOINT RESPONSE
Below you can find examples of both successful and errors responses.
Successful Response
Error Response
If you need help deleting your domain search API file, let us know. Our team is here 24/7 to answer any questions and make things easier for you.