Twitch User Videos
Видео Twitch User Videos — это публичные архивы трансляций, хайлайты и загруженные видео канала с описаниями, контекстом автора, ссылками на медиафайлы, длительностью, временем публикации и видимой вовлеченностью. Эти записи помогают каталогизировать видео канала, сравнивать форматы, исследовать публикационную активность и готовить отчеты об эффективности на определенный момент.
Возможности Twitch User Videos API
- Каталог по имени пользователяПревращает одно публичное имя пользователя Twitch в записи видео, которые источник возвращает для этого канала в одном запросе.
- Фильтры архивов, хайлайтов и загрузокВыбирайте все видео или сужайте запрос к источнику допустимыми значениями archive, highlight или upload и их формами во множественном числе.
- Сортировка по времени или просмотрамУпорядочивайте возвращенную страницу источника по времени или видимым просмотрам, чтобы изучать последние публикации или записи видео с большим числом просмотров.
- Нормализованные записи видеоВозвращает ID видео, публичный URL, описание, контекст автора, медиафайлы, длительность, время публикации, метаданные аудио и видимую вовлеченность в структуре ReelVideoItem.
Параметры Twitch User Videos API
| Параметры | Обязательный | Описание |
|---|---|---|
username | Обязательный | Одно публичное имя пользователя Twitch, при необходимости начинающееся с @, из 1–64 символов: буквы, цифры, точки, подчеркивания или дефисы. |
filter_by | Необязательный | Необязательный тип в источнике: all, archive, archives, highlight, highlights, upload или uploads. Формы типа в единственном и множественном числе соответствуют одной категории провайдера. |
sort_by | Необязательный | Необязательный порядок в источнике: time или views. |
Как использовать Twitch User Videos API
Передайте имя пользователя Twitch с необязательными параметрами типа видео и сортировки, затем прочитайте одну страницу источника через стандартный асинхронный процесс задачи.
- Выберите публичное имя пользователя Twitch и решите, должна ли страница источника охватывать все видео или один допустимый тип видео.
- Отправьте username, filter_by и sort_by методом POST на /v1/twitch/user-videos и сохраните возвращенный ID задачи.
- Опрашивайте /v1/tasks/{task_id}, пока задача не завершится успешно или с ошибкой; не отправляйте запрос повторно, если ID задачи уже есть.
- Читайте записи ReelVideoItem из results.items и используйте next_cursor только для постраничного чтения сохраненных строк задачи.
curl -X POST "https://api.socq.ai/v1/twitch/user-videos" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"username":"ninja","filter_by":"all","sort_by":"time"}'
# Poll GET /v1/tasks/{task_id}
# Read GET /v1/tasks/{task_id}?limit=50Сценарии использования Twitch User Videos API
- Каталогизация видео канала: Используйте ID видео, публичные URL, описания, ссылки на медиафайлы, длительность и контекст автора, чтобы составить актуальный каталог известного канала.
- Обзор соотношения форматов: Запускайте допустимые фильтры по типу по отдельности и сравнивайте записи архивов, хайлайтов и загрузок по времени публикации и длительности.
- Снимки публикаций и просмотров: Объединяйте метки времени публикации с видимыми метриками просмотров или воспроизведений и collected_at, чтобы зафиксировать снимок канала на определенный момент.
Практические советы по Twitch User Videos API
- Передавая имя пользователя, убирайте URL профиля и оставляйте только необязательный @ и допустимые 1–64 символа имени.
- Используйте time, чтобы изучать последние публикации, и views, чтобы находить записи с большим числом просмотров на возвращенной странице источника.
- В сохраненных определениях запросов последовательно используйте либо единственное, либо множественное число типов, потому что каждая пара соответствует одной и той же категории источника.
- Не добавляйте cursor или results_limit в тело запроса на отправку: вызов провайдера возвращает одну страницу, а курсор результатов задачи листает только строки, уже сохраненные SocQ.
- Убирайте дубли в долгосрочных сборах по ID видео и учитывайте, что поля текста, медиа, аудио, автора, меток времени и метрик могут быть null.
Связанные API
Помимо Twitch User Videos API, используйте эти API, когда нужен другой тип публичных данных Twitch.
- Twitch Profile API — Преобразуйте одно публичное имя пользователя Twitch в нормализованную запись аккаунта с доступными данными аккаунта, описанием, изображениями, признаками аккаунта, видимыми метриками и контекстом сбора.
- Twitch Clip Downloader API — Получайте публичный клип Twitch по ссылке на него: название, просмотры, длительность, время создания, профиль стримера и скачиваемую MP4-ссылку с превью.