# Живая расширенная органическая выдача YouTube

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/youtube/organic/live/advanced`

**Tags:** DataForSEO

Синхронно возвращает ранжированные результаты по ключевому слову в YouTube. Возвращает `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` и `items`. `advanced` — вариант по умолчанию; берите `regular`, когда важен только ранжированный список, и `html` — только чтобы проверить, что потерял парсер. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200.

### Справочные цены

- Тарификация: стоимость ответа по данным провайдера.
- Справочная оценка запроса: USD 0.002.
- Справочный множитель для клиента: 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": {
          "keyword": {
            "type": "string",
            "description": "ключевое слово\nобязательное поле\nв поле keyword можно указать до 700 символов\nвсе %## будут декодированы (символ «+» декодируется в пробел)\nесли в keyword нужен символ «%», укажите его как «%25»;\nесли в keyword нужен символ «+», укажите его как «%2B»;\nподробнее о правилах и ограничениях полей keyword и keywords в API DataForSEO читайте в этой статье Help Center"
          },
          "location_code": {
            "type": [
              "integer",
              "null"
            ],
            "description": "код местоположения поисковой системы\nобязательное поле, если не указан location_name\nесли используете это поле, location_name указывать не нужно\nсписок доступных местоположений поисковых систем с их location_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/youtube/locations\nпример:\n2840"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "код языка поисковой системы\nобязательное поле, если не указан language_name\nесли используете это поле, language_name указывать не нужно\nсписок доступных языков поисковой системы с их language_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/youtube/languages\nпример:\nen"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "тип устройства\nнеобязательное поле\nвозвращать результаты для определённого типа устройства\nдоступные значения: desktop, mobile"
          },
          "block_depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "глубина парсинга\nнеобязательное поле\nколичество блоков результатов в SERP\nзначение по умолчанию: 20\nмаксимальное значение: 200\nПримечание: оплата взимается за каждый SERP, содержащий до 20 результатов;\nпоэтому установка глубины блоков выше 20 может привести к дополнительным расходам, если поисковая система возвращает более 20 результатов;\nесли указанная глубина блоков превышает количество результатов в ответе, разница автоматически вернётся на баланс вашего аккаунта"
          },
          "location_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "полное название местоположения поисковой системы\nобязательное поле, если не указан location_code\nесли используете это поле, location_code указывать не нужно\nсписок доступных местоположений поисковой системы с их location_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/youtube/locations\nпример:\nUnited States"
          },
          "language_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "полное название языка поисковой системы\nобязательное поле, если не указан language_code\nесли используете это поле, language_code указывать не нужно\nсписок доступных языков поисковой системы с их language_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/youtube/languages\nпример:\nEnglish"
          },
          "os": {
            "type": [
              "string",
              "null"
            ],
            "description": "операционная система устройства\nнеобязательное поле\nесли в поле device указано desktop, выберите одно из следующих значений: windows, macos\nзначение по умолчанию: windows\nесли в поле device указано mobile, выберите одно из следующих значений: android, ios\nзначение по умолчанию: android"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "пользовательский идентификатор задачи\nнеобязательное поле\nограничение — 255 символов\nэтот параметр позволяет идентифицировать задачу и сопоставить её с результатом\nуказанное значение tag можно найти в объекте data ответа"
          },
          "search_param": {
            "type": [
              "string",
              "null"
            ],
            "description": "дополнительные параметры поискового запроса\nнеобязательное поле\nпример:\nsp=EgIQAg%253D%253D"
          }
        },
        "example": [
          {
            "language_code": "en",
            "location_code": 2840,
            "keyword": "audi"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "language_code": "en",
      "location_code": 2840,
      "keyword": "audi"
    }
  ]
}
```

## Responses

### 200 — Успешная операция

Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResponseInfo"
    }
  ]
}
```

### 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_BaseSerpApiYoutubeOrganicElementItem

`#/components/schemas/Response36Afe1097B20_BaseSerpApiYoutubeOrganicElementItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип элемента"
    },
    "rank_group": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ранг группы в SERP</em><br>позиция внутри группы элементов с одинаковыми значениями <code>type</code><br>позиции элементов с другими значениями <code>type</code> не учитываются в <code>rank_group</code>"
    },
    "rank_absolute": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em> абсолютный ранг в SERP для целевого домена</em><br>абсолютная позиция среди всех элементов в SERP"
    },
    "block_rank": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>ранг блока в SERP</em><br>позиция среди всех блоков в SERP"
    },
    "block_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>название блока в SERP</em><br>пример:<br><code>\"People also watched\"</code><br>"
    },
    "channel_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ID канала</em>"
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>URL канала</em>"
    }
  },
  "additionalProperties": false,
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "youtube_channel": "#/components/schemas/Response36Afe1097B20_SerpApiYoutubeChannelElementItem",
      "youtube_video": "#/components/schemas/Response36Afe1097B20_SerpApiYoutubeVideoElementItem",
      "youtube_video_paid": "#/components/schemas/Response36Afe1097B20_SerpApiYoutubeVideoPaidElementItem",
      "youtube_playlist": "#/components/schemas/Response36Afe1097B20_SerpApiYoutubePlaylistElementItem"
    }
  }
}
```

### Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResponseInfo`

```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_SerpYoutubeOrganicLiveAdvancedTaskInfo"
              }
            ]
          },
          "description": "массив задач"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResultInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "ключевое слово, полученное в POST-массиве        ключевое слово возвращается с декодированным %## (символ '+' будет декодирован как пробел)"
    },
    "se_domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "домен поисковой системы в POST-массиве"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "код местоположения в массиве POST"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "код языка в массиве POST"
    },
    "check_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "прямой URL к результатам поисковой системы        его можно использовать, чтобы убедиться, что мы предоставили точные результаты"
    },
    "datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "дата и время получения результата            в формате UTC: “yyyy-mm-dd hh-mm-ss +00:00”            пример:            2019-11-15 12:57:46 +00:00"
    },
    "spell": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_SpellInfo"
        }
      ],
      "description": "автокоррекция поисковой системы            если поисковая система предоставила результаты для исправленного ключевого слова, мы укажем ключевое слово, исправленное поисковой системой, и тип автокоррекции"
    },
    "item_types": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "типы результатов поиска в SERP            содержит типы результатов поиска (items), найденных в SERP.            возможные типы элементов:            youtube_channel, youtube_video, youtube_video_paid, youtube_playlist"
    },
    "se_results_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "общее количество результатов в SERP",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "количество результатов, возвращённых в массиве items",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_BaseSerpApiYoutubeOrganicElementItem"
          }
        ]
      },
      "description": "элементы результатов поиска, найденных в SERP"
    }
  }
}
```

### Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicLiveAdvancedTaskInfo`

```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_SerpYoutubeOrganicLiveAdvancedResultInfo"
              }
            ]
          },
          "description": "массив результатов"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SpellInfo

`#/components/schemas/Response36Afe1097B20_SpellInfo`

```json
{
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "ключевое слово, полученное в результате автокоррекции поисковой системы\nрезультаты будут предоставлены для исправленного ключевого слова"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "тип автокоррекции\nвозможные значения:\ndid_you_mean, showing_results_for, no_results_found_for, including_results_for\nпримечание: Yahoo и Yandex поддерживают только следующий тип автокоррекции:\nincluding_results_for"
    }
  }
}
```