Twitch Profile
Публичный профиль Twitch может содержать имя пользователя, отображаемое имя, описание профиля, изображения профиля, сайт, признаки верификации или приватности, сведения о местоположении и видимые счетчики аккаунта. Нормализованная запись аккаунта помогает обогащать данные об авторах, проверять профили и делать повторяемые снимки публичных данных, но не дает управлять каналом и не выполняет действий от имени авторизованного аккаунта.
Возможности Twitch Profile API
- Поиск по точному имени пользователяПередайте одно обязательное имя пользователя длиной от 1 до 64 допустимых символов, с одним необязательным начальным @.
- Нормализованные публичные данные аккаунтаПолучайте доступные ID профиля, публичный URL, имя пользователя, отображаемое имя, описание профиля, аватар, обложку и сайт в спецификации AccountItem.
- Признаки состояния аккаунтаСохраняет доступные признаки верификации и приватности как поля, которые могут быть null, а не додумывает значения, если провайдер их не предоставляет.
- Видимые метрики профиляИспользуйте доступное число подписчиков, подписок и публикаций как отдельные необязательные метрики, привязанные ко времени сбора.
- Асинхронная обработка задачПередайте имя пользователя, сохраните task_id, опрашивайте общий эндпоинт чтения задач и после успешного завершения получите сохраненный нормализованный результат.
- Фиксированная оплата запросаУспешная задача стоит фиксированные 0,19 кредита SocQ независимо от того, какие необязательные поля доступны.
Параметры Twitch Profile API
| Параметры | Обязательный | Описание |
|---|---|---|
username | Обязательный | Обязательное имя пользователя Twitch. После обрезки пробелов оно может начинаться с одного @, а затем должно содержать от 1 до 64 символов: латинские буквы ASCII, цифры, точки, подчеркивания или дефисы. |
Как использовать Twitch Profile API
Передайте одно допустимое имя пользователя Twitch, отслеживайте асинхронную задачу и прочитайте единственный сохраненный результат профиля через общий ответ с курсором.
- Выберите одно публичное имя пользователя Twitch, которое соответствует правилу допустимых символов.
- Отправьте username методом POST на /v1/twitch/profile и сохраните возвращенный task_id.
- Опрашивайте /v1/tasks/{task_id}, пока задача не завершится успешно или не сообщит об ошибке.
- Читайте data.results.items; поиск профиля дает не более одной записи из источника, но обертка сохраненного результата всё равно содержит has_more и next_cursor.
curl -X POST "https://api.socq.ai/v1/twitch/profile" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"username":"ninja"}'
# Poll GET /v1/tasks/{task_id}
# Read the normalized account in data.results.itemsСценарии использования Twitch Profile API
- Обогащение записей об авторах: Добавляйте доступные данные об аккаунте Twitch, описание профиля, изображения, сайт, признаки аккаунта и публичные счетчики к записи об известном авторе.
- Проверка имен пользователей: Превращайте переданное имя в нормализованный публичный профиль, прежде чем связывать его с внутренней сущностью или объектом исследования.
- Сравнение публичных аккаунтов: Сравнивайте видимое число подписчиков, подписок и публикаций для отдельно переданных имен пользователей в одинаковой структуре AccountItem.
- Мониторинг изменений профиля: Сохраняйте поля идентификации и метрики, которые могут быть null, вместе с collected_at, чтобы последующие запуски оставались различимыми публичными снимками.
Практические советы по Twitch Profile API
- Передавайте имя пользователя, а не URL канала Twitch; url и results_limit не являются допустимыми полями запроса для этого эндпоинта.
- Используйте не более одного необязательного начального @; пробелы, слеши, символы вне ASCII и повторяющиеся @ не проходят проверку имени пользователя.
- Ожидайте ноль или одну запись профиля из источника. Не считайте параметр limit при чтении задачи способом расширить профиль до видео или подписчиков.
- Обрабатывайте ID, URL, описание профиля, изображения, сайт, признаки аккаунта, местоположение и каждую метрику как поля, которые могут быть null, и сохраняйте collected_at для сравнения снимков.
- Для видео или клипов используйте отдельные эндпоинты контента Twitch, если они доступны; этот эндпоинт только читает профиль и не выполняет вход, публикацию, модерацию или управление каналом.
Связанные API
Помимо Twitch Profile API, используйте эти API, когда нужен другой тип публичных данных Twitch.
- Twitch User Videos API
- Twitch Clip Downloader API — Получайте публичный клип Twitch по ссылке на него: название, просмотры, длительность, время создания, профиль стримера и скачиваемую MP4-ссылку с превью.