Наша собственная статистика посещений включена всегда. Google Analytics помогает нам понять, как пользуются нашими публичными страницами (но не вашим рабочим пространством после входа), и включается только с вашего разрешения. См. нашу политику конфиденциальности.

API Twitch

Получение профилей каналов Twitch, активных трансляций, популярных клипов и игр для мониторинга прямых эфиров.

Передавайте логин канала, а не URL twitch.tv. При неверном периоде для клипов используется последняя неделя.

Доступность платформы

Состояние за 24 ч
Норма
Норма

За последние 30 дней

Доступные возможности

Все действия Twitch: что делает каждое, сколько стоит и как работало за последние 24 часа. Откройте действие, чтобы увидеть параметры, поля ответа и примеры кода.

ВозможностьОписаниеЗа 1000Состояние за 24 часа
ПоискsearchНаходите каналы Twitch по ключевому слову: число подписчиков, статус Partner или Affiliate, наличие эфира и данные последней трансляции.$1.39 за 1 000 запросовНорма
ПрофилиprofileПолучите профиль канала Twitch, статус Partner или Affiliate, данные текущей трансляции и последнего эфира.$1.39 за 1 000 запросовНорма
КлипыclipsПолучите клипы, нарезанные с канала Twitch.$1.39 за 1 000 запросовНорма
ТрансляцииstreamsПолучите список каналов Twitch, которые сейчас в эфире в определённой категории: название трансляции, число зрителей, число подписчиков и время начала.$1.39 за 1 000 запросовНорма
Топ трансляцийtop_streamsСмотрите топ прямых трансляций на Twitch: канал, название, игра, число зрителей и время начала, без входных параметров.$1.39 за 1 000 запросовНорма
Топ игрtop_gamesОтслеживайте топ игр на Twitch с числом зрителей и стримеров и обложками, без входных параметров.$1.39 за 1 000 запросовНорма

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

Какие параметры принимает каждое действие API Twitch?

Каждый ответ ниже описывает одно вызываемое действие и его фактические входные данные. Значение параметров и допустимые значения зависят от действия: знакомое имя параметра не обязательно означает одно и то же на всех платформах.

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

ДействиеОбязательныеНеобязательныеСпособ получения результатаЛимитЗа 1 000Поля ответа
search

Поиск

Находите каналы Twitch по ключевому слову: число подписчиков, статус Partner или Affiliate, наличие эфира и данные последней трансляции. Поиск идёт по каналам, а не по чату, а is_live отражает момент вызова и ничего не гарантирует.

keyword—Режим выдачи: SyncЗначения в каталоге: defaultLimit=10, maxLimit=30. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей.$1.39 за 1 000 запросовuser_id · username · display_name · bio · url · avatar_url · banner_url · follower_count · is_partner · is_affiliate · is_live · current_viewers · stream_title · current_game · stream_started_at · last_broadcast_title · last_broadcast_game · last_broadcast_at · created_at · platform
profile

Профили

Получите профиль канала Twitch, статус Partner или Affiliate, данные текущей трансляции и последнего эфира. Недавние видео и топ-клипы возвращаются по умолчанию. Чтобы убрать эти разделы, задайте include_videos или include_clips логическим значением false. Доходы, имена подписчиков и закрытая аналитика недоступны.

usernameinclude_clips, include_videosРежим выдачи: Sync—$1.39 за 1 000 запросовuser_id · username · display_name · bio · url · avatar_url · banner_url · follower_count · is_partner · is_affiliate · is_live · current_viewers · stream_title · current_game · stream_started_at · last_broadcast_title · last_broadcast_game · last_broadcast_at · created_at · recent_videos · top_clips · platform
clips

Клипы

Получите клипы, нарезанные с канала Twitch. У каждого клипа есть название, просмотры, длительность, игра и зритель, который его создал. period задаёт период: последний день, неделю (по умолчанию), месяц или всё время. Результат за выбранный период может содержать не все клипы.

usernameperiodРежим выдачи: SyncЗначения в каталоге: defaultLimit=10, maxLimit=30. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей.$1.39 за 1 000 запросовid · title · url · view_count · duration_seconds · duration_sec · game · channel_username · channel_name · curator_username · curator_name · thumbnail_url · created_at · platform
streams

Трансляции

Получите список каналов Twitch, которые сейчас в эфире в определённой категории: название трансляции, число зрителей, число подписчиков и время начала. В game нужно указать точное название категории, например Just Chatting; число зрителей фиксируется на момент вызова.

game—Режим выдачи: SyncЗначения в каталоге: defaultLimit=10, maxLimit=30. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей.$1.39 за 1 000 запросовstream_id · username · display_name · follower_count · title · viewer_count · game · started_at · url · avatar_url · platform
top_streams

Топ трансляций

Смотрите топ прямых трансляций на Twitch: канал, название, игра, число зрителей и время начала, без входных параметров. Порядок не является ни постоянным рейтингом, ни нашей рекомендацией.

—Режим выдачи: SyncЗначения в каталоге: defaultLimit=10, maxLimit=30. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей.$1.39 за 1 000 запросовstream_id · username · display_name · follower_count · title · viewer_count · game · started_at · url · avatar_url · platform
top_games

Топ игр

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

—Режим выдачи: SyncЗначения в каталоге: defaultLimit=10, maxLimit=200. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей.$1.39 за 1 000 запросовid · name · viewer_count · broadcaster_count · box_art_url · url · platform

Что означают параметры действия search в API Twitch?

Находите каналы Twitch по ключевому слову: число подписчиков, статус Partner или Affiliate, наличие эфира и данные последней трансляции. Поиск идёт по каналам, а не по чату, а is_live отражает момент вызова и ничего не гарантирует.

Полный справочник API: параметры, примеры кода, пример ответа и состояние
keywordОбязательный
Ключевое слово для поиска каналов в search. Эндпоинт streams требует точное название игры или категории в game, а не произвольные слова из названий трансляций.

Что означают параметры действия profile в API Twitch?

Получите профиль канала Twitch, статус Partner или Affiliate, данные текущей трансляции и последнего эфира. Недавние видео и топ-клипы возвращаются по умолчанию. Чтобы убрать эти разделы, задайте include_videos или include_clips логическим значением false. Доходы, имена подписчиков и закрытая аналитика недоступны.

Полный справочник API: параметры, примеры кода, пример ответа и состояние
usernameОбязательный
Логин канала Twitch для profile или clips, можно с префиксом @. Полные URL twitch.tv не разбираются.
Twitch: логин, отображаемое имя и тип вещателя — Официальная документация Twitch отдельно определяет login, display_name и broadcaster_type. Здесь параметр username должен содержать короткое имя канала: отображаемое имя и тип Partner/Affiliate не являются логином. Другие параметры, поддерживаемые официальными запросами данных пользователей, не добавляются в этот API автоматически. · Проверено
include_clipsНеобязательный
Логическое значение (по умолчанию true): включать ли в ответ profile подборку клипов. Период здесь отличается от отдельного эндпоинта clips.
include_videosНеобязательный
Логическое значение (по умолчанию true): включать ли в ответ profile данные о недавних видео из архива. Чтобы исключить этот раздел, передайте false; не передавайте строку "false".

Что означают параметры действия clips в API Twitch?

Получите клипы, нарезанные с канала Twitch. У каждого клипа есть название, просмотры, длительность, игра и зритель, который его создал. period задаёт период: последний день, неделю (по умолчанию), месяц или всё время. Результат за выбранный период может содержать не все клипы.

Полный справочник API: параметры, примеры кода, пример ответа и состояние
usernameОбязательный
Логин канала Twitch для profile или clips, можно с префиксом @. Полные URL twitch.tv не разбираются.
periodНеобязательный
Период для клипов: LAST_DAY за последний день, LAST_WEEK за последнюю неделю (по умолчанию), LAST_MONTH за последний месяц или ALL_TIME без ограничений. Регистр значений не учитывается, недопустимые значения заменяются на LAST_WEEK.
Twitch: авторы клипов, исходные каналы и число просмотров — Официальная документация Twitch по клипам отдельно определяет broadcaster и creator, поле view_count — как число просмотров клипа, а duration — как длительность в секундах. Этот раздел служит только для сверки терминологии и не воспроизводит официальные параметры начальной и конечной даты, курсоры или параметры создания клипов. · Проверено

Что означают параметры действия streams в API Twitch?

Получите список каналов Twitch, которые сейчас в эфире в определённой категории: название трансляции, число зрителей, число подписчиков и время начала. В game нужно указать точное название категории, например Just Chatting; число зрителей фиксируется на момент вызова.

Полный справочник API: параметры, примеры кода, пример ответа и состояние
gameОбязательный
Точное название категории Twitch для streams, например Just Chatting. Возвращает каналы, которые сейчас ведут трансляции в этой категории, а не архив видео по игре.
Twitch: категории трансляций и текущее число зрителей — Официальная документация по трансляциям различает категории, каналы и текущие трансляции и определяет viewer_count как число пользователей, которые смотрят трансляцию в данный момент. Это не число просмотров клипа, не число подписчиков и не общее историческое число просмотров; официальный параметр game_id не заменяет название категории, которое требуется на этой странице. · Проверено

Что означают параметры действия top_streams в API Twitch?

Смотрите топ прямых трансляций на Twitch: канал, название, игра, число зрителей и время начала, без входных параметров. Порядок не является ни постоянным рейтингом, ни нашей рекомендацией.

Полный справочник API: параметры, примеры кода, пример ответа и состояние

У этого действия нет бизнес-параметров. Передайте только идентификаторы платформы и действия.

Что означают параметры действия top_games в API Twitch?

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

Полный справочник API: параметры, примеры кода, пример ответа и состояние

У этого действия нет бизнес-параметров. Передайте только идентификаторы платформы и действия.

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

  1. 01Выберите действие платформы в публичном каталоге.
  2. 02Передайте платформу, действие и обязательные параметры в POST-запросе на эндпоинт /api/v1/social.
  3. 03Получите результат из ответа. Для асинхронного действия опрашивайте статус по возвращённому ID задачи.
  4. 04Сохраните поля ответа, которые нужны вашему приложению.
twitch_search.sh
curl -X POST https://api.everyinfra.com/api/v1/social \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"twitch","action":"search","params":{"keyword":"<keyword>"}}'

Вопросы об API Twitch

Какие данные можно получить через API Twitch?

Укажите в platform значение twitch. В текущем каталоге: поиск, профили, клипы, трансляции, топ трансляций и more. Эти названия действий соответствуют разным объектам или представлениям Twitch; это не взаимозаменяемые режимы поиска.

Какие входные данные нужны для запроса search к платформе Twitch?

Ключевое слово для поиска каналов в search. Эндпоинт streams требует точное название игры или категории в game, а не произвольные слова из названий трансляций. Передайте это значение в поле keyword объекта params.

Какие поля может вернуть search на платформе Twitch?

Объявленная схема включает user_id, username, display_name и bio. Объявленное поле может отсутствовать в отдельной записи, а у каждого другого действия свой список полей.

Все ли действия Twitch возвращают результат сразу?

Действия с пометкой «асинхронное» возвращают ID задачи, по которому нужно опрашивать статус. Любое другое действие тоже можно запустить асинхронно: добавьте "mode": "async" в тело запроса, чтобы сразу получить ID задачи. Это удобно для длительных задач или запросов с большим лимитом. В текущем каталоге: режим выдачи: sync.