API docs Advanced search API docs

Making requests

POSThttps://registrant-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 or using advanced search.

Request body sample

        {
    "apiKey": "YOUR_API_KEY",
    "sinceDate": "2018-03-01",
    "mode": "purchase",
    "basicSearchTerms":
    {
        "include": [
            "Airbnb",
            "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 added or dropped by registrants having the terms in any of the following fields:

Registrant contact fields

                            RegistrantContact.City,
RegistrantContact.Country,
RegistrantContact.Email,
RegistrantContact.Fax,
RegistrantContact.FaxExtension,
RegistrantContact.Name,
RegistrantContact.Organization,
RegistrantContact.PostalCode,
RegistrantContact.State,
RegistrantContact.StreetAddress,
RegistrantContact.Telephone,
RegistrantContact.TelephoneExtension

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

Get your personal API KEY on My products page.

basicSearchTerms.include

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

basicSearchTerms.exclude

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

sinceDate

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

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.

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 updated 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.

Advanced search API docs

Advanced search allows searching through concrete WHOIS fields.

Sample output

JSON

XML

                            {
   "domainsCount": 2,
   "domainsList": [
        {
            "domainName": "domain1.com",
            "action": "added"
        },
        {
            "domainName": "domain2.com",
            "action": "dropped"
        }
    ]
}

                            <xml>
<domainsCount>2</domainsCount>
<domainsList>
   <item>
      <domainName>domain1.com</domainName>
      <action>added</action>
   </item>
   <item>
      <domainName>domain2.com</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.

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.

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, Reverse IP/DNS API, Reverse MX API, Reverse NS 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 our Registrant Alert API for free

Get started

Have questions?

We work hard to improve our services for you. As part of that, we welcome your feedback, questions and suggestions. Please let us know your thoughts and feelings, and any way in which you think we can improve our product.

For a quick response, please select the request type that best suits your needs. For more info regarding the request types, see the Contact us page.

By submitting, you agree to the Terms of Service and Privacy Policy.