# Domain Whois Overview **API:** Data API **Endpoint:** `POST /v1/beta/dataforseo/domain_analytics/whois/overview/live` **Tags:** DataForSEO 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`. ### Pricing reference - Metering: Reported response cost. - Reference request estimate: USD 0.012. - Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount. Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records. ## Base URL - `https://openapi.felo.ai` ## Authentication - `FeloBearerAuth` (http bearer, bearer format Felo API Key) - `FeloApiKey` (apiKey in header `X-API-Key`) ## Request body Required: **no** ### application/json Schema: ```json { "type": "array", "items": { "type": [ "object", "null" ], "oneOf": [ { "type": "object", "properties": { "limit": { "type": [ "integer", "null" ], "description": "the maximum number of returned domains
optional field
default value: 100
maximum value: 1000" }, "offset": { "type": [ "integer", "null" ], "description": "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_token": { "type": [ "string", "null" ], "description": "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" }, "filters": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ] }, "description": "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_by": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "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\"]" }, "tag": { "type": [ "string", "null" ], "description": "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": [ { "limit": 2, "filters": [ [ "epp_status_codes", "in", [ "client_transfer_prohibited", "client_update_prohibited" ] ] ] } ] } ] }, "example": [ { "limit": 2, "filters": [ [ "epp_status_codes", "in", [ "client_transfer_prohibited", "client_update_prohibited" ] ] ] } ] } ``` ## Responses ### 200 — Successful operation Headers: - `X-Request-Id` (string) — Request identifier to include when contacting Felo support. **application/json** Schema: object | null ```json { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo" } ] } ``` ### 400 — The request could not be processed. Check the request parameters. ### 401 — A valid Felo API key is required. ### 402 — The request cannot proceed because a billing requirement is not met. ### 403 — The account is not permitted to perform this operation. ### 429 — A request or spending limit has been reached. ### 502 — The service could not complete the request. ### 503 — The API or billing service is temporarily unavailable. ### 504 — The service timed out while processing the request. ### default — Error response; upstream passthrough responses may use provider formats **application/json** Schema: ```json {} ``` ## Schema definitions ### Response36Afe1097B20_BacklinksInfo `#/components/schemas/Response36Afe1097B20_BacklinksInfo` ```json { "type": "object", "properties": { "referring_domains": { "type": [ "integer", "null" ], "description": "average number of referring domains", "format": "int64" }, "referring_main_domains": { "type": [ "integer", "null" ], "description": "average number of referring main domains", "format": "int64" }, "referring_pages": { "type": [ "integer", "null" ], "description": "average number of referring pages", "format": "int64" }, "dofollow": { "type": [ "integer", "null" ], "description": "average number of dofollow links", "format": "int64" }, "backlinks": { "type": [ "integer", "null" ], "description": "average number of backlinks", "format": "int64" }, "time_update": { "type": [ "string", "null" ], "description": "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" } } } ``` ### Response36Afe1097B20_BaseResponseInfo `#/components/schemas/Response36Afe1097B20_BaseResponseInfo` ```json { "properties": { "version": { "type": [ "string", "null" ], "description": "the current version of the API" }, "status_code": { "type": [ "integer", "null" ], "description": "general status code\nyou can find the full list of the response codes here" }, "status_message": { "type": [ "string", "null" ], "description": "general informational message\nyou can find the full list of general informational messages here" }, "time": { "type": [ "string", "null" ], "description": "total execution time, seconds" }, "cost": { "type": [ "number", "null" ], "description": "total tasks cost, USD", "format": "double" }, "tasks_count": { "type": [ "integer", "null" ], "description": "the number of tasks in the tasks array", "format": "int64" }, "tasks_error": { "type": [ "integer", "null" ], "description": "the number of tasks in the tasks array returned with an error", "format": "int64" } } } ``` ### Response36Afe1097B20_BaseResponseTaskInfo `#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo` ```json { "properties": { "id": { "type": [ "string", "null" ], "description": "task identifier\nunique task identifier in our system in the UUID format" }, "status_code": { "type": [ "integer", "null" ], "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here" }, "status_message": { "type": [ "string", "null" ], "description": "informational message of the task\nyou can find the full list of general informational messages here" }, "time": { "type": [ "string", "null" ], "description": "execution time, seconds" }, "cost": { "type": [ "number", "null" ], "description": "total tasks cost, USD", "format": "double" }, "result_count": { "type": [ "integer", "null" ], "description": "number of elements in the result array", "format": "int64" }, "path": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] }, "description": "URL path" }, "data": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "object", "null" ] }, "description": "contains the same parameters that you specified in the POST request" } } } ``` ### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem `#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem` ```json { "type": "object", "properties": { "domain": { "type": [ "string", "null" ], "description": "domain name" }, "created_datetime": { "type": [ "string", "null" ], "description": "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_datetime": { "type": [ "string", "null" ], "description": "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_datetime": { "type": [ "string", "null" ], "description": "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_datetime": { "type": [ "string", "null" ], "description": "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_seen": { "type": [ "string", "null" ], "description": "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_codes": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] }, "description": "extensive provisioning protocol status codes
the status of a domain name registration as defined by ICANN" }, "tld": { "type": [ "string", "null" ], "description": "top-level domain
top-level domain in the DNS root zone" }, "registered": { "type": [ "boolean", "null" ], "description": "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" }, "registrar": { "type": [ "string", "null" ], "description": "domain registrar
if null, the domain registrar is unknown
example:
NameCheap, Inc." }, "metrics": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_MetricsBundleInfo" } ], "description": "ranking data relevant to the specified domain" }, "backlinks_info": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksInfo" } ], "description": "backlink data for the returned domain" } }, "description": "items array" } ``` ### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo `#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo` ```json { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveTaskInfo" } ] }, "description": "array of tasks" } } } ] } ``` ### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo `#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo` ```json { "type": "object", "properties": { "total_count": { "type": [ "integer", "null" ], "description": "total amount of results in our database relevant to your request", "format": "int64" }, "items_count": { "type": [ "integer", "null" ], "description": "the number of results returned in the items array", "format": "int64" }, "offset": { "type": [ "integer", "null" ], "description": " results offset value specified in POST request" }, "offset_token": { "type": [ "string", "null" ] }, "items": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem" } ] }, "description": "contains ranking and traffic data" } } } ``` ### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveTaskInfo `#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveTaskInfo` ```json { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo" } ] }, "description": "array of results" } } } ] } ``` ### Response36Afe1097B20_MetricsBundleInfo `#/components/schemas/Response36Afe1097B20_MetricsBundleInfo` ```json { "type": "object", "properties": { "organic": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_MetricsInfo" } ], "properties": { "is_new": { "type": [ "integer", "null" ], "description": "number of new ranked elements\nindicates how many new ranked elements were found for this domain", "format": "int64" }, "is_up": { "type": [ "integer", "null" ], "description": "rank went up\nindicates how many ranked elements of this domain went up in Google Search", "format": "int64" }, "is_down": { "type": [ "integer", "null" ], "description": "rank went down\nindicates how many ranked elements of this domain went down in Google Search", "format": "int64" }, "is_lost": { "type": [ "integer", "null" ], "description": "lost ranked elements\nindicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check", "format": "int64" } }, "description": "ranking and traffic data from organic search" }, "paid": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_MetricsInfo" } ], "description": "ranking and traffic data from paid search" } } } ``` ### Response36Afe1097B20_MetricsInfo `#/components/schemas/Response36Afe1097B20_MetricsInfo` ```json { "type": "object", "properties": { "pos_1": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #1" }, "pos_2_3": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #2-3" }, "pos_4_10": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #4-10" }, "pos_11_20": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #11-20" }, "pos_21_30": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #21-30" }, "pos_31_40": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #31-40" }, "pos_41_50": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #41-50" }, "pos_51_60": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #51-60" }, "pos_61_70": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #61-70" }, "pos_71_80": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #71-80" }, "pos_81_90": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #81-90" }, "pos_91_100": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain ranks #91-100" }, "etv": { "type": [ "number", "null" ], "description": "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" }, "count": { "type": [ "integer", "null" ], "description": "total count of organic SERPs that contain the domain", "format": "int64" }, "estimated_paid_traffic_cost": { "type": [ "number", "null" ], "description": "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" }, "is_new": { "type": [ "integer", "null" ], "description": "number of new ranked elements\nindicates how many new ranked elements were found for this domain", "format": "int64" }, "is_up": { "type": [ "integer", "null" ], "description": "rank went up\nindicates how many ranked elements of this domain went up in Google Search", "format": "int64" }, "is_down": { "type": [ "integer", "null" ], "description": "rank went down\nindicates how many ranked elements of this domain went down in Google Search", "format": "int64" }, "is_lost": { "type": [ "integer", "null" ], "description": "lost ranked elements\nindicates how many ranked elements of this domain were previously presented in SERPs, but weren’t found during the last check", "format": "int64" } } } ```