Skip to content
scrapeatlas.Dashboard

Live streaming

Twitch API

Retrieve Twitch profiles, live status, individual videos, channel videos and clips, weekly schedules and clip details.

7 endpointsx-api-key

Read Twitch channel identity and live status, explore videos and clips, and retrieve individual video metadata and weekly schedules.

API availability: Available

Base URL · local workerhttp://localhost:3012Public API: https://api.scrapeatlas.com.
Authenticationx-api-keyCustomer key from your account. See Authentication.

Endpoints

GET/v1/twitch/profile

Get a Twitch profile

Retrieve profile identity, biography, social links, followers, partner status, current stream, videos, home-page video shelves and similar streamers. Social names become lowercase top-level keys.

Reference
GET/v1/twitch/profile/basic

Get basic profile and live status

Retrieve channel identity, biography, avatar, followers, partner status and the current live stream in a compact profile response.

Reference
GET/v1/twitch/user/videos

Get user videos

Retrieve a page of Twitch videos with type and sort filters, hasNextPage and cursor metadata.

Reference
GET/v1/twitch/user/schedule

Get user schedule

Retrieve the current calendar week, Monday 00:00 UTC through the next Monday. Includes schedule segments, cancellation metadata, interruption, next segment, current stream and this week’s recent broadcasts.

Reference
GET/v1/twitch/clip

Get a Twitch clip

Retrieve public Twitch clip and playback metadata. Numeric keys group clip information, related clips and viewer data.

Reference
GET/v1/twitch/video

Get video metadata

Retrieve one Twitch video by numeric ID or public video URL. Supply exactly one of id or url.

Reference
GET/v1/twitch/user/clips

Get channel clips

Retrieve a channel’s clip cards with broadcaster, curator, game, views, duration, thumbnail and source page metadata. Choose the number of cards with limit.

Reference

Quick start

Create an API key on your account page, then call the public API. Values below are placeholders.

Terminal
curl "https://api.scrapeatlas.com/v1/twitch/profile?handle=example" \
  -H "x-api-key: YOUR_API_KEY"

Coverage & limits

  • Profile identity, biography, social links, partner status, followers and current stream.
  • Compact profile identity and live status with an explicitly nullable stream.
  • Channel video collections and individual video metadata by ID or URL.
  • Channel clip cards and individual clip details with broadcaster, curator and game metadata.
  • Weekly channel schedules and broadcast metadata.
  • Source fields, nulls, ordering, timestamps and GraphQL type names are preserved.
Error codes
12
HTTPfailure.codeMeaning
200partialPrimary clip data is usable but a related-clips or viewer GraphQL query returned source errors.
400invalid_requestMissing or unsafe input, unknown parameters, invalid filter/sort, or duplicate parameters.
401unauthorizedMissing or invalid dedicated worker API key.
403restricted_pageUnpublished clip, denied or expired playback token, or unexpected authenticated viewer.
404not_foundThe requested channel, video or clip is missing, or the route is unknown.
429upstream_rate_limitedTwitch rate limited retrieval.
502upstream_challenged public_client_unavailableTwitch challenged the request or its public client identifier could not be determined.
502upstream_graphql_error unsupported_pagePrimary query failure or incomplete, unexpected or mismatched data.
502response_too_large payload_too_complexByte, depth or JSON node limit exceeded.
502unsafe_redirect request_limit upstream_errorBounded transport could not complete.
503busyAll worker admission slots are occupied.
504timeoutThe total request deadline expired.