Domain Score API Documentation

How To Use Domain Score API

Domain Score API use case

In case you are dealing with a lot of signups on your website, and you want to give special treatment to VIP users our Domain Score API can detect high-profile domains. If you would like to see an example of our Domain Score API in action, you can find it here.

For detailed code examples that will help you use Domain Score API, see our code examples page.

Domain Score API

Scoring is not a real-time process as we are doing multiple checks before returning the result to you. For this reason, there are 2 steps:

1. Send domain for scoring (Set task API);
2. Check the scoring state (Get result API).

These two APIs are described in detail below.

Keep in mind that making a request to “Get result API” and skipping the first step will result in an empty reply.

We provide a webhook solution if you would like to get notified when the result is ready.

More details are below.

Set Task API

Domain Score How to Use

Get Result API

Domain Score How to Use 2

Webhook Support

If you like to receive the processing result to your URL as soon as it’s ready add “webhook_url” parameter to the API request like this:

https://api.whoapi.com/?domain=whoapi.com&r=domainscore&apikey=yourkey&webhook_url=https://yourwebsite.com/yourscript

Our system will make POST request to the specified URL passing JSON in the request body, like this:

[{“id”:9673,”domain”:”whoapi.com”,”overall_score”:68,”temp_email_service”:false,”score_description”:”Good”}]

The body will contain Array of all domains as Objects. Object fields match API reply fields.

Webhook system supports requests resending in case your URL is not accessible (any HTTP error). In this case we will make 5 retries with the following delays: 5, 15, 30, 60, 60 minutes.

Let’s make an example request:

http://api.whoapi.com/?domain=whoapi.com&r=domainscore&apikey=demokey

Output in JSON format:

{
  "status": 0,
  "results": [ {
    "id": 123,
    "domain": "whoapi.com"
 } ],
  "requests_available": 100
}

http://api.whoapi.com/?domain=whoapi.com&r=domainscore&apikey=demokey&asxml

Output in XML format:

<?xml version="1.0"?>
<response>
  <status>0</status>
  <results>
        <item0>
          <id>123</id>
          <domain>whoapi.com</domain>
        </item0>
  </results>
  <requests_available>100</requests_available>
</response>

Parameters meaning

results – array of accepted entries.
id – ID of the accepted entry (used in webhook requests); domain – domain name.

http://api.whoapi.com/?domain=whoapi.com&r=domainscore-check&apikey=demokey

Output in JSON format:

nullhttp://api.whoapi.com/?domain=whoapi.com&r=domainscore-check&apikey=demokey&asxml

Output in XML format:

Parameters meaning

results – array of processed entries;
id – ID of the processed entry (same as in the initial request);
domain – domain name;
overall_score – score for the domain (higher is better);
temp_email_service – true in case this domain provides temp email services;
score_description – textual score description.