Making requests | Documentation | Reverse DNS API | WhoisXML API

Making requests

API endpoint

POST https://reverse-dns.whoisxmlapi.com/api/v1
It takes up to a minute to activate your account after the registration.

Postman collection

Postman is a desktop and web application that allows you to make requests to an API from a graphical user interface. We recommend using Postman with WhoisXML APIs endpoints when exploring the APIs functionality, as well as when you are troubleshooting issues with your application.

The WhoisXML API Postman collection is available at the following links:

The collection includes a preconfigured environment. You will need to set up the api_key variable to fire each request. Get your personal API KEY on the My products page. If you have questions related to the API, contact us.

The API returns DNS records matching the given search criteria. One request to the API returns DNS records of one type, which shall be specified in the recordType input parameter.


Request body example

{
    "apiKey": "YOUR_API_KEY",
    "limit": 1000,
    "includeAdditionalChecks": 1,
    "recordType": "soa",
    "terms": [
        {
            "field": "domain",
            "term": "google.com"
        }
    ]
}

This request returns all SOA records for the "google.com" domain.

You can also use wildcard search. In this case, the term input parameter looks like "google*". Such requests take longer to process, thus try avoiding too wide searches.

Input parameters

apiKey

Required. Get your personal API key on the My products page.

recordType

Required. Type of DNS records among which the search is performed.

Acceptable values: soa | txt | cname

Default: undefined

terms

Required. Array of search terms. Maximum 4 items.

terms.*.field

Required. The field by which the search is performed among the DNS recordType records.

domain – Domain name search.

value – DNS record value search.

Acceptable values: domain | value

terms.*.term

Required. The target search term.

terms.*.exclude

Optional. If true, then the matching DNS records will be excluded from the search results.

Acceptable values: false | true

Default: false

limit

Optional. Max count of returned records.

Acceptable values: 1 - 1000

Default: 1000

includeAdditionalChecks

Optional. By default, no additional checks are performed.

0 – The response is returned as normal. 1 request costs 5 DRS credits.

1 – In this mode, the API performs two additional DNS checks: wildcard check and domain activeness check. Such a query takes a bit longer to execute and 1 request costs 7 DRS credits.

wildcard check – The API checks if the DNS record is part of a wildcard entry.

domain activeness check – The API checks if the domain's DNS records can be retrieved.

Acceptable values: 0 | 1

Default: 0

outputFormat

Optional. Response output format.

Acceptable values: JSON | XML

Default: JSON

Free access

After Sign Up you automatically get a free subscription plan limited to 500 DRS credits.

Usage limits and requests throttling

The maximum number of requests per second is 30. In case that the limit is breached, your subsequent requests will be rejected until the next second.

This API is also available with a dedicated load balancer and premium endpoint to enable faster querying as part of our Premium API Services and Enterprise API Packages.