Making requests | Documentation | Reverse WHOIS API | WhoisXML API

Making requests

API endpoint

POST https://reverse-whois.whoisxmlapi.com/api/v2
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.

POST request body sample

{
    "apiKey": "YOUR_API_KEY",
    "searchType": "current",
    "mode": "purchase",
    "punycode": true,
    "basicSearchTerms": {
        "include": [
            "Airbnb, Inc.",
            "US"
        ],
        "exclude": [
            "Europe",
            "EU"
        ]
    }
}

You can provide up to four include and exclude search terms within one request. With several include/exclude search terms, the output includes domains having all the include terms and none of the exclude terms.

The output includes domains having the terms in any of WHOIS fields.

Headers

X-Authentication-Token

You can use this header or apiKey parameter for API calls.

Get your personal API KEY on My products page.

Input parameters

apiKey

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

basicSearchTerms.include

Required. Array of search strings. All of them should be present in the domain's WHOIS details. Maximum 4 items. Case insensitive.

basicSearchTerms.exclude

Optional. Array of search strings. All of them should NOT be present in the domain's WHOIS details. Maximum 4 items. Case insensitive.

searchType

Optional. Type of search.

current – search in the current WHOIS records only.

historic – search in both actual and historical WHOIS records.

Acceptable values: current | historic

Default: current

mode

Optional.

preview – return only the number of domains. No credits deducted.

purchase – return the actual list of domains (limited to 10,000). 1 request costs 1 DRS credit.

Acceptable values: preview | purchase

Default: preview

punycode

Optional. If true, domain names in the response will be encoded to Punycode.

Acceptable values: false | true

Default: true

includeAuditDates

Optional. If true, each domain name in the output will be supplemented with the corresponding audit dates. Note: the parameter changes the output: array of domain names (if false) -> array of objects (if true) that contain the domain name and audit dates.

Read more about the API output here.

Acceptable values: false | true

Default: false

responseFormat

Optional. Response output format.

Acceptable values: json | xml

Default: json

createdDateFrom

Optional. Date in "YYYY-MM-DD" format.

If present, search through domains created after the given date.

createdDateTo

Optional. Date in "YYYY-MM-DD" format.

If present, search through domains created before the given date.

updatedDateFrom

Optional. Date in "YYYY-MM-DD" format.

If present, search through domains created after the given date.

updatedDateTo

Optional. Date in "YYYY-MM-DD" format.

If present, search through domains updated before the given date.

expiredDateFrom

Optional. Date in "YYYY-MM-DD" format.

If present, search through domains expired after the given date.

expiredDateTo

Optional. Date in "YYYY-MM-DD" format.

If present, search through domains expired before the given date.

searchAfter

Optional. Since every response is limited to 10,000 records, you can retrieve the next page by using this parameter. The value should be taken from the nextPageSearchAfter output field. All the domain names in the result are sorted by the dates they appeared in our databases in descending order.

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.