API: DomainSearch
This API call returns registered and previously registered domain names based on one or more keywords. This is a Premium API call, you have to buy API credits here (https://dnslytics.com/api).
API request and parameters
https://api.dnslytics.net/v1/domainsearch/<keyword>?apikey=<apikey>
Parameters:
- keyword:
One or more keywords separated by the pipe symbol (|). Minimal length per keyword is 3 characters. Regex symbols ^ and $ are supported in a keyword.
- apikey:
Your API key
Optional parameters:
- active:
Filter on only registered domains (active=1), only previously registered domains (active=0) or by default all domains (active=all).
- tld:
Filter on single Top Level Domain name like COM (tld=com) or UK (tld=uk) or return all domains (default, tld=all).
- minlength:
Minimal length of the domain name. Minlength value can be between 3 and 256 (default, minlength=3).
- maxlength:
Maximum length of the domain name. Maxlength value can be between 3 and 256 (default, maxlength=256).
- fromdate:
Only return domain names added to the zone file after this date, example fromdate=20180401 will only return new domains found after 20180401. This date will normally match the registration date of a domain name.
- page:
A single API call returns a maximum of 2,500 domains. With the page parameter you can step through the results and get results up to 100,000 domains. Page value can be between 1 and 40.
API response
A JSON object with the following fields:
- status:
Status of API call: succeed or error.
- question:
Array of the question data with the following fields: terms, page, tld, active, minlength, maxlength.
- typeinfo:
Data type returned, always ‘domainsearch’.
- ndomains:
Total number of domains found.
- domains:
Domain names found with the following fields (domain, length, active). Maximum of 2,500 domains are returned. Use the page parameter to get up to 100,000 domain names.
Example
$ https://api.dnslytics.net/v1/domainsearch/dns|lytics?apikey=<apikey>&tld=com&active=1
{
"status": "succeed",
"data":
{
"question":
{
"terms": "dns|lytics",
"page": 1,
"tld": "com",
"active": "1",
"minlength": 3,
"maxlength": 256
},
"typeinfo": "domainsearch",
"ndomains": 11,
"domains":[
{
"domain": "dnslytics.com",
"length": 9,
"active": true
},
{"..."}
]
}
}