Data API / DataForSEO / Domain Analytics

Domain Whois Overview

Whois records enriched with SEO metrics. Each item carries domain, created_datetime, changed_datetime, expiration_datetime, updated_datetime, first_seen, epp_status_codes, tld, registered, registrar, plus metrics and backlinks_info. Paged with limit, offset and offset_token, filtered over the fields in get_dataforseo_domains_whois_available_filters.

Parameters

No path, query, or header parameters.

Request body

limitintegerOptional
the maximum number of returned domains optional field default value: 100 maximum value: 1000
offsetintegerOptional
offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items; Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead
offset_tokenstringOptional
token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center
filtersarrayOptional
array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, , , >, >=, =, , in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters
order_bystring[]Optional
results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order the comma is used as a separator example: ["metrics.organic.pos_1,desc"] default rule: ["metrics.organic.count,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["expiration_datetime,asc","metrics.organic.etv,desc","metrics.organic.pos_1,desc"]
tagstringOptional
user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/domain_analytics/whois/overview/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "limit": 0,
  "offset": 0,
  "offset_token": "<string>",
  "filters": "<string>",
  "order_by": [
    "<string>"
  ],
  "tag": "<string>"
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
status_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
total_countintegerOptional
total amount of results in our database relevant to your request
items_countintegerOptional
the number of results returned in the items array
offsetintegerOptional
results offset value specified in POST request
offset_tokenobjectOptional
token for subsequent requests by specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task
itemsstring[]Optional
contains ranking and traffic data
domainstringOptional
domain name
created_datetimestringOptional
date and time of registration date and time (in the ISO 8601 format) when the domain was first registered example: "1997-03-29 03:00:00 +00:00"
changed_datetimestringOptional
date and time when the domain entry was changed date and time (in the ISO 8601 format) when the domain entry was last modified example: "2021-01-14 08:36:28 +00:00"
expiration_datetimestringOptional
date and time when the domain will expire date and time (in the ISO 8601 format) when the domain is due to expire example: "2022-11-26 17:21:23 +00:00"
updated_datetimestringOptional
date and time when the domain was updated date and time (in the ISO 8601 format) when the domain was last updated example: "2021-01-29 13:59:38 +00:00"
first_seenstringOptional
date and time when our crawler found the domain for the first time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: "2019-11-15 12:57:46 +00:00"
epp_status_codesstring[]Optional
extensive provisioning protocol status codes the status of a domain name registration as defined by ICANN
tldstringOptional
top-level domain top-level domain in the DNS root zone
registeredbooleanOptional
domain registration status if false, the domain name registration has expired Note: expired domains will remain in the database for only a short period of time
registrarstringOptional
domain registrar if null, the domain registrar is unknown example: NameCheap, Inc.
metricsobjectOptional
ranking data relevant to the specified domain
organicobjectOptional
ranking and traffic data from organic search
pos_1integerOptional
number of organic SERPs where the domain ranks #1
pos_2_3integerOptional
number of organic SERPs where the domain ranks #2-3
pos_4_10integerOptional
number of organic SERPs where the domain ranks #4-10
pos_11_20integerOptional
number of organic SERPs where the domain ranks #11-20
pos_21_30integerOptional
number of organic SERPs where the domain ranks #21-30
pos_31_40integerOptional
number of organic SERPs where the domain ranks #31-40
pos_41_50integerOptional
number of organic SERPs where the domain ranks #41-50
pos_51_60integerOptional
number of organic SERPs where the domain ranks #51-60
pos_61_70integerOptional
number of organic SERPs where the domain ranks #61-70
pos_71_80integerOptional
number of organic SERPs where the domain ranks #71-80
pos_81_90integerOptional
number of organic SERPs where the domain ranks #81-90
pos_91_100integerOptional
number of organic SERPs where the domain ranks #91-100
etvnumberOptional
estimated traffic volume estimated organic monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article
countintegerOptional
total count of organic SERPs that contain the domain
estimated_paid_traffic_costnumberOptional
estimated cost of converting organic search traffic into paid represents the estimated monthly cost of running ads (USD) for all keywords a domain ranks for the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search learn more about how the metric is calculated in this help center article
paidobjectOptional
ranking and traffic data from paid search
pos_1integerOptional
number of paid SERPs where the domain ranks #1
pos_2_3integerOptional
number of paid SERPs where the domain ranks #2-3
pos_4_10integerOptional
number of paid SERPs where the domain ranks #4-10
pos_11_20integerOptional
number of paid SERPs where the domain ranks #11-20
pos_21_30integerOptional
number of paid SERPs where the domain ranks #21-30
pos_31_40integerOptional
number of paid SERPs where the domain ranks #31-40
pos_41_50integerOptional
number of paid SERPs where the domain ranks #41-50
pos_51_60integerOptional
number of paid SERPs where the domain ranks #51-60
pos_61_70integerOptional
number of paid SERPs where the domain ranks #61-70
pos_71_80integerOptional
number of paid SERPs where the domain ranks #71-80
pos_81_90integerOptional
number of paid SERPs where the domain ranks #81-90
pos_91_100integerOptional
number of paid SERPs where the domain ranks #91-100
etvnumberOptional
estimated traffic volume estimated paid monthly traffic to the domain calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for learn more about how the metric is calculated in this help center article
countintegerOptional
total count of paid SERPs that contain the domain
estimated_paid_traffic_costnumberOptional
estimated cost of monthly search traffic represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values learn more about how the metric is calculated in this help center article
backlinks_infoobjectOptional
backlink data for the returned domain
referring_domainsintegerOptional
number of referring domains
referring_main_domainsintegerOptional
number of referring main domains
referring_pagesintegerOptional
number of referring pages
dofollowintegerOptional
number of dofollow links
backlinksintegerOptional
total number of backlinks the total number of backlinks, including dofollow and nofollow links
time_updatestringOptional
date and time when backlink data was updated in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00" example: 2019-11-15 12:57:46 +00:00