Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Domain Whois Overview

Felo API Support
MIT
Сервер:https://openapi.felo.ai
Клиентские библиотеки
Shell Curl

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Операции

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.

Тело
application/json
  • Тип: array object[]
    • filters
      Тип: array

      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

    • limit
      Тип: integer

      the maximum number of returned domains optional field default value: 100 maximum value: 1000

    • offset
      Тип: integer

      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
      Тип: string

      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

    • order_by
      Тип: array string[]

      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
      Тип: string

      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

Ответы
  • 200
    Тип: object

    Successful response

    • cost
      Тип: number

      total tasks cost, USD

    • status_code
      Тип: integer

      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_message
      Тип: string

      general informational message you can find the full list of general informational messages here

    • tasks
      Тип: array string[]

      array of tasks

    • tasks_count
      Тип: integer

      the number of tasks in the tasks array

    • tasks_error
      Тип: integer

      the number of tasks in the tasks array returned with an error

    • tasks.cost
      Тип: number

      cost of the task, USD

    • tasks.data
      Тип: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      Тип: string

      task identifier unique task identifier in our system in the UUID format

    • tasks.path
      Тип: array string[]

      URL path

    • tasks.result
      Тип: array string[]

      array of results

    • tasks.result_count
      Тип: integer

      number of elements in the result array

    • tasks.result.items
      Тип: array string[]

      contains ranking and traffic data

    • tasks.result.items_count
      Тип: integer

      the number of results returned in the items array

    • Тип: object

      backlink data for the returned domain

    • Тип: integer

      total number of backlinks the total number of backlinks, including dofollow and nofollow links

    • Тип: integer

      number of dofollow links

    • Тип: integer

      number of referring domains

    • Тип: integer

      number of referring main domains

    • Тип: integer

      number of referring pages

    • Тип: string

      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

    • tasks.result.items.changed_datetime
      Тип: string

      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"

    • tasks.result.items.created_datetime
      Тип: string

      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"

    • tasks.result.items.domain
      Тип: string

      domain name

    • tasks.result.items.epp_status_codes
      Тип: array string[]

      extensive provisioning protocol status codes the status of a domain name registration as defined by ICANN

    • tasks.result.items.expiration_datetime
      Тип: string

      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"

    • tasks.result.items.first_seen
      Тип: string

      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"

    • tasks.result.items.metrics
      Тип: object

      ranking data relevant to the specified domain

    • tasks.result.items.metrics.organic
      Тип: object

      ranking and traffic data from organic search

    • tasks.result.items.metrics.organic.count
      Тип: integer

      total count of organic SERPs that contain the domain

    • tasks.result.items.metrics.organic.estimated_paid_traffic_cost
      Тип: number

      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

    • tasks.result.items.metrics.organic.etv
      Тип: number

      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

    • tasks.result.items.metrics.organic.pos_1
      Тип: integer

      number of organic SERPs where the domain ranks #1

    • tasks.result.items.metrics.organic.pos_11_20
      Тип: integer

      number of organic SERPs where the domain ranks #11-20

    • tasks.result.items.metrics.organic.pos_2_3
      Тип: integer

      number of organic SERPs where the domain ranks #2-3

    • tasks.result.items.metrics.organic.pos_21_30
      Тип: integer

      number of organic SERPs where the domain ranks #21-30

    • tasks.result.items.metrics.organic.pos_31_40
      Тип: integer

      number of organic SERPs where the domain ranks #31-40

    • tasks.result.items.metrics.organic.pos_4_10
      Тип: integer

      number of organic SERPs where the domain ranks #4-10

    • tasks.result.items.metrics.organic.pos_41_50
      Тип: integer

      number of organic SERPs where the domain ranks #41-50

    • tasks.result.items.metrics.organic.pos_51_60
      Тип: integer

      number of organic SERPs where the domain ranks #51-60

    • tasks.result.items.metrics.organic.pos_61_70
      Тип: integer

      number of organic SERPs where the domain ranks #61-70

    • tasks.result.items.metrics.organic.pos_71_80
      Тип: integer

      number of organic SERPs where the domain ranks #71-80

    • tasks.result.items.metrics.organic.pos_81_90
      Тип: integer

      number of organic SERPs where the domain ranks #81-90

    • tasks.result.items.metrics.organic.pos_91_100
      Тип: integer

      number of organic SERPs where the domain ranks #91-100

    • tasks.result.items.metrics.paid
      Тип: object

      ranking and traffic data from paid search

    • tasks.result.items.metrics.paid.count
      Тип: integer

      total count of paid SERPs that contain the domain

    • tasks.result.items.metrics.paid.estimated_paid_traffic_cost
      Тип: number

      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

    • tasks.result.items.metrics.paid.etv
      Тип: number

      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

    • tasks.result.items.metrics.paid.pos_1
      Тип: integer

      number of paid SERPs where the domain ranks #1

    • tasks.result.items.metrics.paid.pos_11_20
      Тип: integer

      number of paid SERPs where the domain ranks #11-20

    • tasks.result.items.metrics.paid.pos_2_3
      Тип: integer

      number of paid SERPs where the domain ranks #2-3

    • tasks.result.items.metrics.paid.pos_21_30
      Тип: integer

      number of paid SERPs where the domain ranks #21-30

    • tasks.result.items.metrics.paid.pos_31_40
      Тип: integer

      number of paid SERPs where the domain ranks #31-40

    • tasks.result.items.metrics.paid.pos_4_10
      Тип: integer

      number of paid SERPs where the domain ranks #4-10

    • tasks.result.items.metrics.paid.pos_41_50
      Тип: integer

      number of paid SERPs where the domain ranks #41-50

    • tasks.result.items.metrics.paid.pos_51_60
      Тип: integer

      number of paid SERPs where the domain ranks #51-60

    • tasks.result.items.metrics.paid.pos_61_70
      Тип: integer

      number of paid SERPs where the domain ranks #61-70

    • tasks.result.items.metrics.paid.pos_71_80
      Тип: integer

      number of paid SERPs where the domain ranks #71-80

    • tasks.result.items.metrics.paid.pos_81_90
      Тип: integer

      number of paid SERPs where the domain ranks #81-90

    • tasks.result.items.metrics.paid.pos_91_100
      Тип: integer

      number of paid SERPs where the domain ranks #91-100

    • tasks.result.items.registered
      Тип: boolean

      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

    • tasks.result.items.registrar
      Тип: string

      domain registrar if null, the domain registrar is unknown example: NameCheap, Inc.

    • tasks.result.items.tld
      Тип: string

      top-level domain top-level domain in the DNS root zone

    • tasks.result.items.updated_datetime
      Тип: string

      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"

    • tasks.result.offset
      Тип: integer

      results offset value specified in POST request

    • tasks.result.offset_token
      Тип: object

      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

    • tasks.result.total_count
      Тип: integer

      total amount of results in our database relevant to your request

    • tasks.status_code
      Тип: integer

      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

    • tasks.status_message
      Тип: string

      informational message of the task you can find the full list of general informational messages here

    • tasks.time
      Тип: string

      execution time, seconds

    • time
      Тип: string

      execution time, seconds

    • version
      Тип: string

      the current version of the API

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 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

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/domain_analytics/whois/overview/live
curl https://openapi.felo.ai/v1/beta/dataforseo/domain_analytics/whois/overview/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "limit": 1,
    "offset": 1,
    "offset_token": "",
    "filters": [],
    "order_by": [
      ""
    ],
    "tag": ""
  }
]'

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.total_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.offset": 1,
  "tasks.result.offset_token": {},
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.domain": "string",
  "tasks.result.items.created_datetime": "string",
  "tasks.result.items.changed_datetime": "string",
  "tasks.result.items.expiration_datetime": "string",
  "tasks.result.items.updated_datetime": "string",
  "tasks.result.items.first_seen": "string",
  "tasks.result.items.epp_status_codes": [
    "string"
  ],
  "tasks.result.items.tld": "string",
  "tasks.result.items.registered": true,
  "tasks.result.items.registrar": "string",
  "tasks.result.items.metrics": {},
  "tasks.result.items.metrics.organic": {},
  "tasks.result.items.metrics.organic.pos_1": 1,
  "tasks.result.items.metrics.organic.pos_2_3": 1,
  "tasks.result.items.metrics.organic.pos_4_10": 1,
  "tasks.result.items.metrics.organic.pos_11_20": 1,
  "tasks.result.items.metrics.organic.pos_21_30": 1,
  "tasks.result.items.metrics.organic.pos_31_40": 1,
  "tasks.result.items.metrics.organic.pos_41_50": 1,
  "tasks.result.items.metrics.organic.pos_51_60": 1,
  "tasks.result.items.metrics.organic.pos_61_70": 1,
  "tasks.result.items.metrics.organic.pos_71_80": 1,
  "tasks.result.items.metrics.organic.pos_81_90": 1,
  "tasks.result.items.metrics.organic.pos_91_100": 1,
  "tasks.result.items.metrics.organic.etv": 1,
  "tasks.result.items.metrics.organic.count": 1,
  "tasks.result.items.metrics.organic.estimated_paid_traffic_cost": 1,
  "tasks.result.items.metrics.paid": {},
  "tasks.result.items.metrics.paid.pos_1": 1,
  "tasks.result.items.metrics.paid.pos_2_3": 1,
  "tasks.result.items.metrics.paid.pos_4_10": 1,
  "tasks.result.items.metrics.paid.pos_11_20": 1,
  "tasks.result.items.metrics.paid.pos_21_30": 1,
  "tasks.result.items.metrics.paid.pos_31_40": 1,
  "tasks.result.items.metrics.paid.pos_41_50": 1,
  "tasks.result.items.metrics.paid.pos_51_60": 1,
  "tasks.result.items.metrics.paid.pos_61_70": 1,
  "tasks.result.items.metrics.paid.pos_71_80": 1,
  "tasks.result.items.metrics.paid.pos_81_90": 1,
  "tasks.result.items.metrics.paid.pos_91_100": 1,
  "tasks.result.items.metrics.paid.etv": 1,
  "tasks.result.items.metrics.paid.count": 1,
  "tasks.result.items.metrics.paid.estimated_paid_traffic_cost": 1,
  "tasks.result.items.backlinks_info": {},
  "tasks.result.items.backlinks_info.referring_domains": 1,
  "tasks.result.items.backlinks_info.referring_main_domains": 1,
  "tasks.result.items.backlinks_info.referring_pages": 1,
  "tasks.result.items.backlinks_info.dofollow": 1,
  "tasks.result.items.backlinks_info.backlinks": 1,
  "tasks.result.items.backlinks_info.time_update": "string"
}

Successful response

Domain Whois Overview