Making requests | Documentation | Brand Alert API | Whois XML API

Making requests

POST https://brand-alert.whoisxmlapi.com/api/v2
It takes up to a minute to activate your account after the registration.

POST request body sample

{
    "apiKey": "YOUR_API_KEY",
    "sinceDate": "2020-06-25",
    "mode": "purchase",
    "withTypos": false,
    "responseFormat": "json",
    "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 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 1,000 DRS credits.

Learn more: Typo generation FAQ

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 100 DRS credits per month.

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.

Have questions?

We are here to listen. For a quick response, please select your request type or check our Contact us page for more information. By submitting a request, you agree to our Terms of Service and Privacy Policy.

Or shoot us an email to