Domain Discovery API
The Domain Discovery API searches the WhoisFreaks database to retrieve domains that contain a specific keyword or match a pattern (using an asterisk *). For each matched domain, it provides registration and inactive‑from dates. The API also supports the label_length parameter, which lets you control the maximum length of the domain label returned. For example, setting label_length=5 will return only domains with labels shorter than or equal to five characters.
Authorization
You can make authorized requests to our API by passing API key as a query parameter. To get your API key, login to our billing dashboard and get your API key! If your API key has been compromised, you can change it by clicking on reset button in billing dashboard.
Required
- apiKey
Get your API key from our billing dashboard.
- keyword
Use this parameter to search for domain labels that match the specified keyword. Leave this parameter as null to enable use of the pattern parameter.
- pattern
Use this parameter to search for domain labels that match a specific pattern. Apply the asterisk (*) as a wildcard for pattern matching, for example, whois*fres returns all domains containing both 'whois' and 'fres'. Leave this parameter as null to enable use of the keyword parameter.
Optional
- label_length
Specify this parameter as a label length filter to retrieve all domains whose label length is less than or equal to the given value.
- page
Specify page number to access specific page's data. If you don't pass 'page' parameter, default page is 1.
Status Codes
Success Codes
- 200 Request is processed successfully.
Failure Codes
- 400 Please pass domain param correct value e.g. whoisfreaks.com, https://whoisfreaks.com, http://whoisfreaks.com
- 400 Please provide one of the keyword or pattern, both are not acceptable
- 400 Please provide keyword or pattern
- 401 Provided API key is invalid.
- 401 Provided API key is inactive.
- 401 Please buy a subscription plan or add api credits, then use this api key.
- 401 Your subscription is deactivated. Please buy new plan or add api credits for using whoisfreaks APIs.
- 401 Your subscription is deactivated due to much time payment failure. Please buy a new plan or add api credits for using whoisfreaks APIs.
- 401 Your account is deactivated.
- 401 You are blocked due to suspicious activity.
- 408 Unable to fetch whois data. Please try again.
- 412 You have exceeded the limit of api plan requests and your subscription is canceled.
- 413 You have exceeded the limit of api credits requests [allowed_request_no]. Please upgrade your plan.
- 413 You have exceeded the limit of Surcharge Requests [allowed_surcharge_request_no]. Please upgrade your plan.
- 429 Please slow down. Your maximum request limit per minute is reached.
- 500 Internal Server error occurred.
- 503 Service is unavailable. Please try after some time.
- 504 Request is timed-out.