# Обзор Whois домена
**API:** Data API
**Endpoint:** `POST /v1/beta/dataforseo/domain_analytics/whois/overview/live`
**Tags:** DataForSEO
Записи Whois, обогащённые SEO-метриками. Каждый элемент содержит `domain`, `created_datetime`, `changed_datetime`, `expiration_datetime`, `updated_datetime`, `first_seen`, `epp_status_codes`, `tld`, `registered`, `registrar`, а также `metrics` и `backlinks_info`. Постранично через `limit`, `offset` и `offset_token`, с фильтрацией по полям из `get_dataforseo_domains_whois_available_filters`.
### Справочная информация о ценах
- Тарификация: заявленная стоимость ответа.
- Справочная оценка запроса: USD 0.012.
- Справочный множитель для клиента: 1.0. Не применяйте его повторно к уже рассчитанной сумме клиента.
Только справочные метаданные, а не котировка для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.
## 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": "максимальное количество возвращаемых доменов
необязательное поле
значение по умолчанию: 100
максимальное значение: 1000"
},
"offset": {
"type": [
"integer",
"null"
],
"description": "смещение в массиве результатов возвращаемых элементов
необязательное поле
значение по умолчанию: 0
если указать значение 10, первые десять items в массиве результатов будут пропущены, а данные будут предоставлены для последующих элементов;
Примечание: этот параметр рекомендуется использовать только при получении до 10 000 результатов; для получения более 10 000 результатов используйте offset_token"
},
"offset_token": {
"type": [
"string",
"null"
],
"description": "токен для последующих запросов
необязательное поле
предоставляется в том же поле ответа на каждый запрос;
используйте этот параметр, чтобы избежать тайм-аутов при попытке получить более 100 000 результатов в одном запросе;
указав уникальное значение offset_token из массива ответа, вы получите последующие результаты исходной задачи;
значения offset_token уникальны для каждой последующей задачи
Примечание: если в запросе указан offset_token, все остальные параметры должны совпадать с предыдущим запросом
Подробнее об этом параметре в нашем Help Center"
},
"filters": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
]
},
"description": "массив параметров фильтрации результатов
необязательное поле
можно добавить несколько фильтров одновременно (не более 8)
между условиями нужно указать логический оператор and или or
поддерживаются следующие операторы:
regex, <, <=, >, >=, =, <>, in, not_in, like, not_like
оператор % можно использовать с like и not_like для сопоставления любой строки из нуля или более символов"
},
"order_by": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "правила сортировки результатов
необязательное поле
для сортировки результатов можно использовать те же значения, что и в массиве filters
возможные типы сортировки:
asc — результаты сортируются по возрастанию
desc — результаты сортируются по убыванию
разделителем служит запятая
пример:
[\"metrics.organic.pos_1,desc\"]
правило по умолчанию:
[\"metrics.organic.count,desc\"]
обратите внимание: в одном запросе можно задать не более трёх правил сортировки
несколько правил сортировки разделяются запятой
пример:
[\"expiration_datetime,asc\",\"metrics.organic.etv,desc\",\"metrics.organic.pos_1,desc\"]"
},
"tag": {
"type": [
"string",
"null"
],
"description": "пользовательский идентификатор задачи
необязательное поле
ограничение — 255 символов
этот параметр позволяет идентифицировать задачу и сопоставить её с результатом
указанное значение tag вы найдёте в объекте data ответа"
}
},
"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 — Успешная операция
Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo"
}
]
}
```
### 400 — Запрос не удалось обработать. Проверьте параметры запроса.
### 401 — Требуется действительный API-ключ Felo.
### 402 — Запрос не может быть выполнен: не выполнено требование биллинга.
### 403 — Аккаунту не разрешено выполнять эту операцию.
### 429 — Достигнут лимит запросов или расходов.
### 502 — Сервис не смог выполнить запрос.
### 503 — API или сервис биллинга временно недоступны.
### 504 — Истекло время ожидания обработки запроса.
### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера
**application/json**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_BacklinksInfo
`#/components/schemas/Response36Afe1097B20_BacklinksInfo`
```json
{
"type": "object",
"properties": {
"referring_domains": {
"type": [
"integer",
"null"
],
"description": "среднее количество ссылающихся доменов",
"format": "int64"
},
"referring_main_domains": {
"type": [
"integer",
"null"
],
"description": "среднее количество ссылающихся основных доменов",
"format": "int64"
},
"referring_pages": {
"type": [
"integer",
"null"
],
"description": "среднее количество ссылающихся страниц",
"format": "int64"
},
"dofollow": {
"type": [
"integer",
"null"
],
"description": "среднее количество dofollow-ссылок",
"format": "int64"
},
"backlinks": {
"type": [
"integer",
"null"
],
"description": "среднее количество обратных ссылок",
"format": "int64"
},
"time_update": {
"type": [
"string",
"null"
],
"description": "дата и время обновления данных об обратных ссылках
в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”;
пример:
2019-11-15 12:57:46 +00:00"
}
}
}
```
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "текущая версия API"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "общий код состояния.\nПолный список кодов ответа можно найти здесь."
},
"status_message": {
"type": [
"string",
"null"
],
"description": "общее информационное сообщение.\nПолный список общих информационных сообщений можно найти здесь."
},
"time": {
"type": [
"string",
"null"
],
"description": "общее время выполнения, секунды"
},
"cost": {
"type": [
"number",
"null"
],
"description": "общая стоимость задач, USD",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "число задач в массиве tasks",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "число задач в массиве tasks, возвращённых с ошибкой",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "идентификатор задачи\nуникальный идентификатор задачи в нашей системе в формате UUID"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "код состояния задачи\nформируется DataForSEO, может находиться в диапазоне 10000-60000\nПолный список кодов ответа можно найти здесь."
},
"status_message": {
"type": [
"string",
"null"
],
"description": "информационное сообщение задачи\nПолный список общих информационных сообщений можно найти здесь."
},
"time": {
"type": [
"string",
"null"
],
"description": "время выполнения, секунды"
},
"cost": {
"type": [
"number",
"null"
],
"description": "общая стоимость задач, USD",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "число элементов в массиве result",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "путь URL"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "содержит те же параметры, что вы указали в POST-запросе"
}
}
}
```
### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem
`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem`
```json
{
"type": "object",
"properties": {
"domain": {
"type": [
"string",
"null"
],
"description": "имя домена"
},
"created_datetime": {
"type": [
"string",
"null"
],
"description": "дата и время регистрации
дата и время (в формате ISO 8601), когда домен был впервые зарегистрирован
пример:
\"1997-03-29 03:00:00 +00:00\""
},
"changed_datetime": {
"type": [
"string",
"null"
],
"description": "дата и время изменения записи домена
дата и время (в формате ISO 8601), когда запись домена была изменена в последний раз
пример:
\"2021-01-14 08:36:28 +00:00\""
},
"expiration_datetime": {
"type": [
"string",
"null"
],
"description": "дата и время истечения срока действия домена
дата и время (в формате ISO 8601), когда истекает срок действия домена
пример:
\"2022-11-26 17:21:23 +00:00\""
},
"updated_datetime": {
"type": [
"string",
"null"
],
"description": "дата и время обновления домена
дата и время (в формате ISO 8601), когда домен был обновлён в последний раз
пример:
\"2021-01-29 13:59:38 +00:00\""
},
"first_seen": {
"type": [
"string",
"null"
],
"description": "дата и время, когда наш краулер впервые обнаружил домен
в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”
пример:
\"2019-11-15 12:57:46 +00:00\""
},
"epp_status_codes": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "коды состояния протокола Extensive Provisioning
статус регистрации доменного имени согласно определению ICANN"
},
"tld": {
"type": [
"string",
"null"
],
"description": "домен верхнего уровня
домен верхнего уровня в корневой зоне DNS"
},
"registered": {
"type": [
"boolean",
"null"
],
"description": "статус регистрации домена
если false, срок регистрации доменного имени истёк
Примечание: просроченные домены остаются в базе данных лишь на короткое время"
},
"registrar": {
"type": [
"string",
"null"
],
"description": "регистратор домена
если null, регистратор домена неизвестен
пример:
NameCheap, Inc."
},
"metrics": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_MetricsBundleInfo"
}
],
"description": "данные ранжирования, относящиеся к указанному домену"
},
"backlinks_info": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BacklinksInfo"
}
],
"description": "данные обратных ссылок по возвращённому домену"
}
},
"description": "массив items"
}
```
### 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": "массив задач"
}
}
}
]
}
```
### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo
`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo`
```json
{
"type": "object",
"properties": {
"total_count": {
"type": [
"integer",
"null"
],
"description": "общее количество результатов в нашей базе данных, соответствующих вашему запросу",
"format": "int64"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "количество результатов, возвращённых в массиве items",
"format": "int64"
},
"offset": {
"type": [
"integer",
"null"
],
"description": "значение смещения результатов, указанное в запросе POST"
},
"offset_token": {
"type": [
"string",
"null"
]
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem"
}
]
},
"description": "содержит данные ранжирования и трафика"
}
}
}
```
### 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": "массив результатов"
}
}
}
]
}
```
### 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": "количество новых ранжируемых элементов\nуказывает, сколько новых ранжируемых элементов было найдено для этого домена",
"format": "int64"
},
"is_up": {
"type": [
"integer",
"null"
],
"description": "позиция повысилась\nуказывает, сколько ранжируемых элементов этого домена повысились в Google Search",
"format": "int64"
},
"is_down": {
"type": [
"integer",
"null"
],
"description": "позиция понизилась\nуказывает, сколько ранжируемых элементов этого домена понизились в Google Search",
"format": "int64"
},
"is_lost": {
"type": [
"integer",
"null"
],
"description": "потерянные ранжируемые элементы\nуказывает, сколько ранжируемых элементов этого домена ранее присутствовали в SERP, но не были найдены во время последней проверки",
"format": "int64"
}
},
"description": "данные о позициях и трафике из органического поиска"
},
"paid": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_MetricsInfo"
}
],
"description": "данные о позициях и трафике из платного поиска"
}
}
}
```
### Response36Afe1097B20_MetricsInfo
`#/components/schemas/Response36Afe1097B20_MetricsInfo`
```json
{
"type": "object",
"properties": {
"pos_1": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #1"
},
"pos_2_3": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #2-3"
},
"pos_4_10": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #4-10"
},
"pos_11_20": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #11-20"
},
"pos_21_30": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #21-30"
},
"pos_31_40": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #31-40"
},
"pos_41_50": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #41-50"
},
"pos_51_60": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #51-60"
},
"pos_61_70": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #61-70"
},
"pos_71_80": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #71-80"
},
"pos_81_90": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #81-90"
},
"pos_91_100": {
"type": [
"integer",
"null"
],
"description": "количество органических SERP, где домен занимает #91-100"
},
"etv": {
"type": [
"number",
"null"
],
"description": "оценка объёма трафика
оценка ежемесячного органического трафика на домен
рассчитывается как произведение CTR (click-through-rate) и значений поискового объёма всех ключевых слов, по которым домен ранжируется
Подробнее о том, как рассчитывается эта метрика, — в этой статье справочного центра"
},
"count": {
"type": [
"integer",
"null"
],
"description": "общее число органических SERP, содержащих домен",
"format": "int64"
},
"estimated_paid_traffic_cost": {
"type": [
"number",
"null"
],
"description": "предполагаемая стоимость превращения органического поискового трафика в платный
представляет предполагаемую месячную стоимость показа рекламы (USD) по всем ключевым словам, по которым ранжируется домен
метрика рассчитывается как произведение значений органического etv и платного cpc и указывает стоимость привлечения предполагаемого объёма месячного органического трафика через PPC-рекламу в Google Search
подробнее о том, как рассчитывается метрика, — в этой статье справочного центра"
},
"is_new": {
"type": [
"integer",
"null"
],
"description": "количество новых ранжируемых элементов\nуказывает, сколько новых ранжируемых элементов было найдено для этого домена",
"format": "int64"
},
"is_up": {
"type": [
"integer",
"null"
],
"description": "позиция повысилась\nуказывает, сколько ранжируемых элементов этого домена повысились в Google Search",
"format": "int64"
},
"is_down": {
"type": [
"integer",
"null"
],
"description": "позиция понизилась\nуказывает, сколько ранжируемых элементов этого домена понизились в Google Search",
"format": "int64"
},
"is_lost": {
"type": [
"integer",
"null"
],
"description": "потерянные ранжируемые элементы\nуказывает, сколько ранжируемых элементов этого домена ранее присутствовали в SERP, но не были найдены во время последней проверки",
"format": "int64"
}
}
}
```