https://search.yahoo.com/search?p=rank+checker&n=100&vl=lang_en&vc=us&ei=UTF-8"
},
"keyword": {
"type": "string",
"description": "ключевое словоkeyword можно указать до 700 символовkeyword нужен символ \"%\", укажите его как \"%25\";keyword нужен символ «+», укажите его как «%2B»Подробнее о правилах и ограничениях полей keyword и keywords в API DataForSEO читайте в статье Help Center"
},
"location_name": {
"type": "string",
"description": "полное название местоположения поисковой системы
обязательное поле, если не указан location_code или location_coordinate
если используете это поле, location_code или location_coordinate указывать не нужно
список доступных местоположений с их location_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
пример:London,England,United Kingdom"
},
"location_code": {
"type": "integer",
"description": "код местоположения поисковой системы
обязательное поле, если не указан location_name или location_coordinate
если используете это поле, location_name или location_coordinate указывать не нужно
список доступных местоположений с их location_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
пример:2840"
},
"location_coordinate": {
"type": "string",
"description": "GPS-координаты местоположения
обязательное поле, если не указаны location_name или location_code
если используете это поле, location_name или location_code указывать не нужно
параметр location_coordinate должен быть указан в формате \"latitude,longitude,radius\"
максимальное число десятичных знаков для \"latitude\" и \"longitude\": 7
минимальное значение для \"radius\": 199.9 (мм)
максимальное значение для \"radius\": 199999 (мм)
пример:53.476225,-2.243572,200"
},
"language_name": {
"type": "string",
"description": "полное название языка поисковой системы
обязательное поле, если не указан language_code
если используете это поле, language_code указывать не нужно
список доступных языков поисковой системы с их language_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
пример:English"
},
"language_code": {
"type": "string",
"description": "код языка поисковой системы
обязательное поле, если не указан language_name
если используете это поле, language_name указывать не нужно
список доступных языков поисковой системы с их language_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages
пример:enn"
},
"device": {
"type": [
"string",
"null"
],
"description": "тип устройства
необязательное поле
возвращать результаты для определённого типа устройства
может принимать значения:desktop, mobile
значение по умолчанию: desktop"
},
"os": {
"type": [
"string",
"null"
],
"description": "операционная система устройства
необязательное поле
если в поле device указано desktop, выбирайте из значений: windows, macos
значение по умолчанию: windows
если в поле device указано mobile, выбирайте из значений: android, ios
значение по умолчанию: android"
},
"se_domain": {
"type": [
"string",
"null"
],
"description": "домен поисковой системы
необязательное поле
мы автоматически выбираем подходящий домен поисковой системы в соответствии с указанными вами местоположением и языком
однако в этом поле можно задать собственный домен поисковой системы
пример:au.search.yahoo.com, uk.search.yahoo.com, ca.search.yahoo.com и т. д."
},
"depth": {
"type": [
"integer",
"null"
],
"description": "глубина парсинга
необязательное поле
количество результатов в SERP
значение по умолчанию: 10
максимальное значение: 200
Оплата взимается за каждый SERP, содержащий до 10 результатов;
Установка глубины выше 10 может привести к дополнительным расходам, если поисковая система возвращает более 10 результатов;
Стоимость можно рассчитать на странице тарифов."
},
"max_crawl_pages": {
"type": [
"integer",
"null"
],
"description": "лимит обхода страниц
необязательное поле
количество страниц результатов поиска для обхода
значение по умолчанию: 1
максимальное значение: 100
Примечание: параметры max_crawl_pages и depth дополняют друг друга;
подробнее — в нашем справочном центре"
},
"search_param": {
"type": [
"string",
"null"
],
"description": "дополнительные параметры поискового запроса
необязательное поле
список доступных параметров и дополнительные сведения приведены здесь"
},
"stop_crawl_on_match": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"type": "object",
"properties": {
"match_value": {
"type": [
"string",
"null"
],
"description": "целевой домен или значение с подстановкой\nобязательное поле, если указан stop_crawl_on_match;\nукажите целевой домен или значение с подстановкой;\nПримечание: имя домена указывается без протокола запроса;\nпример: dataforseo.com"
},
"match_type": {
"type": [
"string",
"null"
],
"description": "тип сопоставления цели\nобязательное поле, если указан stop_crawl_on_match;\nтип сопоставления для match_value\nвозможные значения: domain, with_subdomains, wildcard"
}
}
}
]
},
"description": "массив целей для остановки обхода\nнеобязательное поле\nесли указано, ответ будет содержать результаты SERP до указанного match_value включительно;\nв этом массиве можно указать до 10 целевых значений\nпример:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nподробнее об этом параметре — в нашем справочном центре: https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nоплата взимается за каждый SERP, обойдённый по указанным целям"
}
},
"example": [
{
"language_code": "en",
"location_code": 2840,
"keyword": "albert einstein"
}
]
}
]
},
"example": [
{
"language_code": "en",
"location_code": 2840,
"keyword": "albert einstein"
}
]
}
```
## Responses
### 200 — Успешная операция
Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlResponseInfo"
}
]
}
```
### 400 — Запрос не удалось обработать. Проверьте параметры запроса.
### 401 — Требуется действительный API-ключ Felo.
### 402 — Запрос не может быть выполнен: не выполнено требование биллинга.
### 403 — Аккаунту не разрешено выполнять эту операцию.
### 429 — Достигнут лимит запросов или расходов.
### 502 — Сервис не смог выполнить запрос.
### 503 — API или сервис биллинга временно недоступны.
### 504 — Истекло время ожидания обработки запроса.
### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера
**application/json**
Schema:
```json
{}
```
## Schema definitions
### 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_HtmlItemInfo
`#/components/schemas/Response36Afe1097B20_HtmlItemInfo`
```json
{
"type": "object",
"properties": {
"page": {
"type": [
"integer",
"null"
],
"description": "порядковый номер возвращённой HTML-страницы"
},
"date": {
"type": [
"string",
"null"
],
"description": "дата и время сканирования HTML-страницы
в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”
пример:2019-11-15 12:57:46 +00:00"
},
"html": {
"type": [
"string",
"null"
],
"description": "HTML страница"
}
}
}
```
### Response36Afe1097B20_SerpYahooOrganicLiveHtmlResponseInfo
`#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlResponseInfo`
```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_SerpYahooOrganicLiveHtmlTaskInfo"
}
]
},
"description": "массив задач"
}
}
}
]
}
```
### Response36Afe1097B20_SerpYahooOrganicLiveHtmlResultInfo
`#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlResultInfo`
```json
{
"type": "object",
"properties": {
"keyword": {
"type": [
"string",
"null"
],
"description": "ключевое слово, полученное в POST-массиве
ключевое слово возвращается с декодированным %## (символ '+' будет декодирован как пробел)"
},
"type": {
"type": [
"string",
"null"
],
"description": "тип элемента"
},
"se_domain": {
"type": [
"string",
"null"
],
"description": "домен поисковой системы в массиве POST"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "код местоположения в массиве POST"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "код языка в массиве POST"
},
"datetime": {
"type": [
"string",
"null"
],
"description": "дата и время получения результата
в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”
пример:2019-11-15 12:57:46 +00:00"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "количество результатов, возвращённых в массиве items",
"format": "int64"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_HtmlItemInfo"
}
]
},
"description": "элементы результатов поиска, найденные в SERP"
}
}
}
```
### Response36Afe1097B20_SerpYahooOrganicLiveHtmlTaskInfo
`#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlTaskInfo`
```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_SerpYahooOrganicLiveHtmlResultInfo"
}
]
},
"description": "массив результатов"
}
}
}
]
}
```