/twitch/channels

POST /api/twitch/channels

Price: 1 credit

Get Twitch channel details by login or URL

How to use it

Get full details of a Twitch channel by login or channel URL. Returns display name, avatar, bio, follower count, partner/affiliate status, social links, team, the last broadcast category, and the current live stream (title, category, viewer count, start time) if the channel is broadcasting.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• login string required — Twitch channel login (e.g. 'shroud') or channel URL (examples: "shroud", "https://www.twitch.tv/shroud"; minLength: 1)

Response

• @type string (default: "TwitchChannel")
• id string required
• login string required
• display_name string nullable
• url string required
• description string nullable
• image string nullable
• primary_color string nullable
• follower_count integer (default: 0)
• is_partner boolean (default: false)
• is_affiliate boolean (default: false)
• is_staff boolean (default: false)
• is_live boolean (default: false)
• banner string nullable
• team object nullable
  • @type string (default: "TwitchTeam")
  • id string required
  • name string required
  • display_name string nullable
• social_links array (default: [])
  • @type string (default: "TwitchSocialMedia")
  • name string required
  • url string required
• last_broadcast_id string nullable
• last_broadcast_game object nullable
  • @type string (default: "TwitchGame")
  • id string required
  • name string required
  • alias string nullable
  • image string nullable
• stream object nullable
  • @type string (default: "TwitchChannelStream")
  • id string required
  • viewer_count integer (default: 0)
  • started_at string nullable
  • game object nullable
    • @type string (default: "TwitchGame")
    • id string required
    • name string required
    • alias string nullable
    • image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Channel not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.