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

Twitch API: Профиль — Метрики видео по имени пользователя

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

Операция «Метрики видео по имени пользователя» подходит для дашбордов, скоринга и регулярной отчётности, когда важен компактный срез показателей.

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

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

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

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

Ответ содержит готовую сводку по сущности «Профиль»: ключевые счётчики и показатели в структуре выбранной версии API.

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

Операция «Метрики видео по имени пользователя» подходит для дашбордов, скоринга и регулярной отчётности, когда важен компактный срез показателей.

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

Продуктовые дашборды

Показывайте основные показатели Twitch без загрузки и обработки полной коллекции.

Динамика и мониторинг

Сохраняйте периодические срезы и сравнивайте изменение метрик во времени.

Скоринг объектов

Используйте готовые показатели как признаки для внутренних рейтингов и правил.

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

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

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

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

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

V1 Недоступно

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

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

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

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

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

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

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

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

Общие параметры
Параметр Обязателен Тип Пример Описание
username Да str value Публичное имя пользователя без символа @.

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

V2

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

GET /api/v2/twitch.tv/profile/videos-metrics-by-username

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

Примеры кода

curl --request GET \
  --url "https://www.scrapestorm.net/api/v2/twitch.tv/profile/videos-metrics-by-username" \
  --header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
  --get --data-urlencode 'username=value'
Пример ответа

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

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

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

V2 — JSON

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

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

{
  "success": true,
  "status": "ok",
  "search_context": {
    "username": "ninja"
  },
  "data": {
    "channel": {
      "channel_url": "https://www.twitch.tv/ninja",
      "user_id": "19571641",
      "username": "ninja",
      "display_name": "Ninja",
      "description": "Just want to make people happy. Co-Founder @DrinkNutcase.",
      "hashtags": [],
      "emails": [],
      "follower_count": 19252591,
      "is_partner": true,
      "last_broadcast_game": {
        "game_id": "1264310518",
        "slug": null,
        "name": null,
        "display_name": "Marvel Rivals"
      },
      "avatar_url": "https://example.com/image.jpg"
    },
    "analytics": {
      "all_posts": {
        "analyzed_posts_count": 100,
        "last_post_date": "2026-06-10T19:00:38+00:00",
        "total_engagement": 0,
        "avg_engagement_rate_per_post": 0.0,
        "peak_engagement_rate_per_post": 0.0,
        "avg_weighted_engagement_score": 0.0,
        "total_engagement_rate": 0.0,
        "median_engagement_per_post": 0.0,
        "max_engagement_per_post": 0,
        "avg_caption_length": 54,
        "avg_posts_per_week": 3,
        "avg_posts_per_month": 14,
        "posts_count_last_7_days": 0,
        "posts_count_last_30_days": 0,
        "total_views": 15817982,
        "avg_views_per_post": 158180,
        "avg_views_per_video": 158180,
        "total_view_rate": 82.160277,
        "follower_count": 19252591,
        "median_views_per_video": 162716.0,
        "min_views": 4902,
        "max_views": 597845,
        "average_view_rate_per_video": 0.821599,
        "average_duration_seconds": 20202.76,
        "_more_fields": "6 more fields"
      },
      "sponsored_posts": {
        "analyzed_posts_count": 1,
        "last_post_date": "2025-12-12T13:51:10+00:00",
        "total_engagement": 0,
        "avg_engagement_rate_per_post": 0.0,
        "peak_engagement_rate_per_post": 0.0,
        "avg_weighted_engagement_score": 0.0,
        "total_engagement_rate": 0.0,
        "median_engagement_per_post": 0.0,
        "max_engagement_per_post": 0,
        "avg_caption_length": 110,
        "avg_posts_per_week": 0,
        "avg_posts_per_month": 1,
        "posts_count_last_7_days": 0,
        "posts_count_last_30_days": 0,
        "total_views": 218793,
        "avg_views_per_post": 218793,
        "avg_views_per_video": 218793,
        "total_view_rate": 1.136434,
        "follower_count": 19252591,
        "median_views_per_video": 218793.0,
        "min_views": 218793,
        "max_views": 218793,
        "average_view_rate_per_video": 1.136434,
        "average_duration_seconds": 33685.0,
        "_more_fields": "6 more fields"
      },
      "organic_posts": {
        "analyzed_posts_count": 99,
        "last_post_date": "2026-06-10T19:00:38+00:00",
        "total_engagement": 0,
        "avg_engagement_rate_per_post": 0.0,
        "peak_engagement_rate_per_post": 0.0,
        "avg_weighted_engagement_score": 0.0,
        "total_engagement_rate": 0.0,
        "median_engagement_per_post": 0.0,
        "max_engagement_per_post": 0,
        "avg_caption_length": 53,
        "avg_posts_per_week": 3,
        "avg_posts_per_month": 14,
        "posts_count_last_7_days": 0,
        "posts_count_last_30_days": 0,
        "total_views": 15599189,
        "avg_views_per_post": 157568,
        "avg_views_per_video": 157568,
        "total_view_rate": 81.023842,
        "follower_count": 19252591,
        "median_views_per_video": 161266.0,
        "min_views": 4902,
        "max_views": 597845,
        "average_view_rate_per_video": 0.81842,
        "average_duration_seconds": 20066.58,
        "_more_fields": "6 more fields"
      },
      "segment_comparison": {
        "sponsored_content_share": 1.0,
        "organic_content_share": 99.0,
        "organic_vs_sponsored_engagement_rate_gap": 0.0,
        "sponsored_to_organic_avg_engagement_ratio": 0.0
      }
    },
    "feed": {
      "count": 100,
      "items": [
        {
          "url": "https://www.twitch.tv/videos/2793492428",
          "video_id": "2793492428",
          "title": "NEW FORTNITE SEASON W/ MY BRO JUST VIBING",
          "preview_thumbnail_url": "https://example.com/image.jpg",
          "animated_preview_url": "https://d1m7jfoe9zdc1j.cloudfront.net/8930b8733be938a812b5_ninja_319868118491_1781118033/storyboards/2793492428-strip-0.jpg",
          "published_at": "2026-06-10T19:00:38Z",
          "duration_seconds": 14683,
          "view_count": 184897,
          "game": {
            "game_id": "33214",
            "slug": "fortnite",
            "name": "Fortnite",
            "display_name": "Fortnite",
            "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/33214-40x56.jpg"
          },
          "owner": {
            "channel_url": "https://www.twitch.tv/ninja",
            "user_id": "19571641",
            "username": "ninja",
            "display_name": "Ninja",
            "is_partner": true,
            "avatar_url": "https://example.com/image.jpg"
          },
          "is_sponsored": false,
          "sponsored_detection_source": null,
          "sponsored_detection_confidence": null
        },
        {
          "url": "https://www.twitch.tv/videos/2792555053",
          "video_id": "2792555053",
          "title": "NEW FORTNITE SEASON W/ MY BRO JUST VIBING",
          "preview_thumbnail_url": "https://example.com/image.jpg",
          "animated_preview_url": "https://d1m7jfoe9zdc1j.cloudfront.net/80f5149b59d31a7254e8_ninja_319741192794_1781021015/storyboards/2792555053-strip-0.jpg",
          "published_at": "2026-06-09T16:03:40Z",
          "duration_seconds": 11216,
          "view_count": 128845,
          "game": {
            "game_id": "33214",
            "slug": "fortnite",
            "name": "Fortnite",
            "display_name": "Fortnite",
            "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/33214-40x56.jpg"
          },
          "owner": {
            "channel_url": "https://www.twitch.tv/ninja",
            "user_id": "19571641",
            "username": "ninja",
            "display_name": "Ninja",
            "is_partner": true,
            "avatar_url": "https://example.com/image.jpg"
          },
          "is_sponsored": false,
          "sponsored_detection_source": null,
          "sponsored_detection_confidence": null
        },
        {
          "_more_items": 98
        }
      ]
    }
  }
}
Что делать дальше

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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