Инструкция по Twitch API

Twitch API: Поиск — Videos By Query

Находите объекты сущности «Поиск» в Twitch по пользовательскому запросу и подключайте результаты к поиску, каталогу или исследовательскому интерфейсу.

Операция «Videos By Query» нужна, когда точный ID объекта ещё неизвестен и сначала требуется найти подходящие результаты.

Метод GET
Сущность Поиск
Версии 2
Что делает этот эндпоинт

Что можно сделать с этим API-методом

Сначала оцените результат и сценарии применения, затем переходите к параметрам и рабочему примеру запроса.

Результат запроса

Ответ содержит найденные объекты «Поиск», их публичный контекст и данные для продолжения поиска, если доступна пагинация.

Когда использовать

Операция «Videos By Query» нужна, когда точный ID объекта ещё неизвестен и сначала требуется найти подходящие результаты.

Типовые сценарии использования

Поиск в продукте

Добавляйте поиск по данным Twitch в клиентский или внутренний интерфейс.

Формирование каталога

Находите кандидатов по запросам и сохраняйте релевантные объекты для дальнейшего обогащения.

Исследование рынка

Собирайте поисковую выдачу для анализа тем, авторов и конкурентного окружения.

Доступные версии

Версия ответа

Обе версии решают одну и ту же задачу и принимают одинаковые параметры. Переключатель нужен, чтобы сравнить структуру ответа и выбрать версию, которую ожидает ваш клиент.

Версия ответа V2

Переключайте версии на этой странице, чтобы сравнивать структуру ответа без смены URL инструкции.

Что остается одинаковым

Аутентификация, обязательные параметры и форма запроса одинаковы для V1 и V2. Версия задаётся в пути запроса и определяет структуру ответа.

Что меняется между версиями

Главное отличие — envelope ответа. Для новых интеграций лучше использовать V2, а V1 оставлять только для совместимости с уже существующей клиентской интеграцией.

Как использовать

Как вызвать метод

Для обеих версий используется один заголовок API-ключа и одинаковые параметры строки запроса. Ниже сначала показаны общие параметры, затем путь и примеры кода для выбранной версии.

Входные параметры

Общие параметры
Параметр Обязателен Тип Пример Описание
query Да str gaming Поисковый запрос пользователя.
cursor Нет str | None MTU= Курсор следующей страницы из предыдущего ответа. Не передавайте его для первой страницы.

Путь запроса для выбранной версии

V2

Версию имеет смысл выбирать, когда вы копируете точный путь эндпоинта, пример URL и фрагмент кода. Список параметров выше при этом остается тем же самым.

GET /api/v2/twitch.tv/search/videos-by-query

Нормализованный формат

Примеры кода

curl --request GET \
  --url "https://www.scrapestorm.net/api/v2/twitch.tv/search/videos-by-query" \
  --header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
  --get --data-urlencode 'query=gaming' \
  # Optional parameters:
  # --data-urlencode 'cursor=MTU='
Пример ответа

Пример ответа по версиям

Пример сокращён до ключевых полей и первых элементов коллекций, чтобы структуру ответа можно было быстро оценить. Переключатель версии меняет формат JSON.

Пример ответа

V2 — JSON

Проверенный пример

Компактный JSON-пример сформирован из последней успешной проверки версии V2.

{
  "success": true,
  "status": "ok",
  "pagination": {
    "cursor": "MTU=",
    "has_more": true
  },
  "search_context": {
    "query": "gaming"
  },
  "data": {
    "videos": {
      "count": 15,
      "items": [
        {
          "rank": 1,
          "video_id": "2899728610",
          "title": "🟥EL MEJOR STREAMER🟥20K SUBS🟥FOREST MAÑANA🟥MINECRAFT HARDCORE🟥CON VERITY🟥NADIE MAS🟥ROBLOX🟥FORTNITE🟥ROCKET LEAGUE🟥GAMING🟥ACCION🟥FA",
          "video_url": "https://www.twitch.tv/videos/2899728610",
          "preview_thumbnail_url": "https://example.com/image.jpg",
          "published_at": "2026-10-13T15:24:36Z",
          "duration_seconds": 22650,
          "view_count": 858496,
          "game": {
            "game_id": "509658",
            "slug": "just-chatting",
            "name": "Just Chatting",
            "display_name": "Just Chatting"
          },
          "owner": {
            "user_id": "182714869",
            "username": "peereira7",
            "display_name": "Peereira7",
            "channel_url": "https://www.twitch.tv/peereira7",
            "is_partner": true
          }
        },
        {
          "rank": 2,
          "video_id": "2899783903",
          "title": "BONSOIR LES MARDIIIIIZZZ un merveilleux programme de GAMING nous attend ce soir mesdames et messieurs",
          "video_url": "https://www.twitch.tv/videos/2899783903",
          "preview_thumbnail_url": "https://example.com/image.jpg",
          "published_at": "2026-10-13T16:41:58Z",
          "duration_seconds": 15168,
          "view_count": 118427,
          "game": {
            "game_id": "509658",
            "slug": "just-chatting",
            "name": "Just Chatting",
            "display_name": "Just Chatting"
          },
          "owner": {
            "user_id": "41719107",
            "username": "zerator",
            "display_name": "ZeratoR",
            "channel_url": "https://www.twitch.tv/zerator",
            "is_partner": true
          }
        },
        {
          "_more_items": 13
        }
      ]
    }
  }
}
Что делать дальше

Продолжить оценку API-метода

Используйте инструкцию как первую точку принятия решения, а затем переходите к покрытию, стоимости и общим правилам интеграции перед запуском API-метода.

Открыть страницу Twitch API

Сравните соседние сущности, группы API-методов и связанные инструкции перед внедрением.

Открыть страницу платформы

Сравнить стоимость API-методов

Посмотрите, где этот API-метод находится в публичной таблице цен, прежде чем масштабировать использование.

Открыть тарифы

Проверить правила интеграции

Откройте стартовую документацию, чтобы быстро проверить аутентификацию, версионирование, повторы запросов и различия между тестовым и рабочим API.

Открыть документацию
FAQ

Вопросы, которые команды задают до внедрения

Эти ответы помогают понять, подходит ли API-метод под ваш сценарий, выбор версии и запуск.

Какие данные возвращает этот метод Twitch API?

Метод выполняет операцию «Videos By Query» для сущности «Поиск». Точный набор полей показан в компактном примере ответа ниже.

Какую версию ответа выбрать: V1 или V2?

Для новой интеграции выбирайте V2 с нормализованной структурой. V1 нужен только для совместимости с клиентами, которые уже используют исходный формат платформы.

Что нужно для первого запроса?

Создайте API-ключ, передайте его в заголовке и заполните обязательные параметры из таблицы. Готовые примеры кода уже содержат правильный путь и структуру запроса.