API docs

Making requests

POSThttps://brand-alert-api.whoisxmlapi.com/api/v2
- It takes up to 2 minutes to activate your account after Sign Up. - Note that the search results are limited to 10,000 records. If you'd like to get more relevant results, try optimizing your search query.

Request body sample

        {
    "apiKey": "YOUR_API_KEY",
    "sinceDate": "2018-05-01",
    "mode": "purchase",
    "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: required

apiKey
Get your personal API KEY on My products page.
includeSearchTerms
Array of search terms which should be present in the domain name. Maximum 4 items. Case insensitive.

Input parameters: optional

excludeSearchTerms
Optional. Array of search terms which 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" (default) – 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.
responseFormat
Optional.

"json" (default) – response format will be JSON.

"xml" – response format will be XML.

Sample output

JSON
XML
                            {
   "domainsCount": 2,
   "domainsList": [
        {
            "domainName": "blogginggoogle.com",
            "action": "added"
        },
        {
            "domainName": "googleblog.asia",
            "action": "dropped"
        }
    ]
}
                        
                            <xml>
<domainsCount>2</domainsCount>
<domainsList>
   <item>
      <domainName>blogginggoogle.com</domainName>
      <action>added</action>
   </item>
   <item>
      <domainName>googleblog.asia</domainName>
      <action>dropped</action>
   </item>
</domainsList>
</xml>
                        
domainsCount
The number of domains matching the criteria.
domainsList
The list of domains matching the criteria. This section is present for the "purchase" mode only.
domainsList[k].domainName
Full domain name
domainsList[k].action
"added" for the registered and "dropped" for the expired domains.

Account balance information

GEThttps://user.whoisxmlapi.com/service/account-balance?apiKey=YOUR_API_KEY
apiKey
Required. Get your personal API KEY on My products page.
productId
Optional. A list of the products' IDs can be found in the response.

- You can always check your account balance on the My products page. - Note that the following products use the same WHOIS credits: WHOIS API, Bulk WHOIS API, Domain Availability API. - Note that the following products use the same Domain Research Suite credits: Brand Alert API, Registrant Alert API, Reverse WHOIS API, WHOIS History API.

List of possible errors

400 Bad Request
Invalid JSON received.
403 Forbidden
Access restricted. Check credits balance or enter the correct API key.
422 Unprocessable Entity
Input correct search term.
429 Too Many Requests
Too Many Requests. Try your call again later.
5XX
Internal server error. Try your call again or contact us.

Try Brand Alert API for free

Have questions?
support@whoisxmlapi.com
We will get back to you within a day.
WHOIS API, Inc.

California
USA

Contact us