Making requests | Documentation | Brand Alert API | WhoisXML API

Making requests

API endpoint

POST https://brand-alert.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, you can ask them here: https://main.whoisxmlapi.com/contact-us

POST request body sample

{
    "apiKey": "YOUR_API_KEY",
    "sinceDate": "2022-11-30",
    "mode": "purchase",
    "withTypos": false,
    "responseFormat": "json",
    "punycode": true,
    "includeSearchTerms": [
        "google",
        "blog"
    ],
    "excludeSearchTerms": [
        "analytics"
    ]
}

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.

includeSearchTerms

Required. Array of search terms. All of them should be present in the domain name. Maximum 4 items. Case insensitive.

excludeSearchTerms

Optional. Array of search terms. All of them should NOT be present in the domain name. Maximum 4 items. Case insensitive.

sinceDate

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

Allowed dates are in the [Today minus 14 days — Today] interval.

Yesterday's date by default.

If present, search through activities discovered since the given date. Sometimes there is a latency between the actual added/renewal/expired date and the date when our system detected this change. We recommend using this field in your monitoring tools for filtering daily changes.

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 10 DRS credits.

Acceptable values: preview | purchase

Default: preview

withTypos

Optional. If true, the search terms set will be enriched with their possible typos. For example, for the term 'google', the typos might be: 'goigle', 'gokgle', 'golgle', 'gopgle', 'goglee', 'gooogle' etc.

Acceptable values: false | true

Default: false

With typos included - 1 request costs 300 DRS credits.

Learn more: Typo generation FAQ

punycode

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

Acceptable values: false | true

Default: true

responseFormat

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.