Twitch Channel, Clips, Videos & Stream Data APIs
Look up public Twitch channels by login, search for candidates, page through clips and past broadcasts, and read point-in-time stream status. An offline channel returns a null stream, which is a normal result rather than a failure.
Open the standalone Twitch demoInspect the ninja channel profile
Replace <API_KEY> with your authorized platform API key from the dashboard. Keep production calls server-side and redact key-bearing URLs from logs, shared examples and screenshots.
This read-only example sets channel=ninja, a channel login as it appears in the public Twitch URL, for a profile lookup that returned a successful response when it was recorded. No Twitch account, developer app or OAuth token is required. Follower totals and profile details change over time, so a populated response is not guaranteed. Loading the page, navigating, opening panels or copying an example sends no data request. Submit a request only when you intend to run it.
Base URL https://api.opendata-api.com
curl -X GET 'https://api.opendata-api.com/api/project/twitch-scraper/get-channel-details?key=<API_KEY>&channel=ninja'import requests
response = requests.request(
"GET",
"https://api.opendata-api.com/api/project/twitch-scraper/get-channel-details",
params={
"key": "<API_KEY>",
"channel": "ninja",
},
timeout=30,
)
response.raise_for_status()
print(response.json())const url = new URL("https://api.opendata-api.com/api/project/twitch-scraper/get-channel-details");
url.search = new URLSearchParams({
"key": "<API_KEY>",
"channel": "ninja",
}).toString();
const response = await fetch(url, {
method: "GET",
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());Channel logins, cursors and snapshot timing
- The channel field takes the login shown in the public Twitch URL, for example ninja, not the display title, which can differ in capitalization or spelling. Use channel search to recover a login from a name, confirm it with the profile lookup and keep the returned id for your own records.
- A null stream under data.user is the normal answer for an offline channel: HTTP 200, status ok and the user id still present. Only stream details adds a message saying the channel is offline. Store an absent value as null with a state label, never as zero viewers or an empty tag list, and treat a missing user or id as unresolved.
- Clips and videos continue with a numeric cursor returned by the previous response for the same channel. Omit it on the first request, then send it back unchanged together with the same channel on every page. Stop when a response gives no new cursor and deduplicate by item id. Channel search exposes no cursor.
- Stream details, tags and viewer count describe the channel only at the moment of the request, and no audience history is available. Record your own retrieval timestamp and a live, offline or unresolved state with every sample, then build peaks and averages from the snapshots you collect. Confirm you have the right to store and reuse the public channel data you keep.
Check status and message before using stream data
Inspect the HTTP status separately from the gateway's code, message and data business result. Gateway code 200 indicates business success, but HTTP 200 alone does not prove a channel is live or even that it exists. Inside the operation payload, also read status, message and data.user: an offline channel returned status ok with stream set to null, which is a normal result and not zero viewers. Keep offline channels, unresolved lookups and request failures as separate states.
Choose a Twitch data task
- Confirm a channel and read its profile
-
Supply the channel login from the public Twitch URL in the required channel field, not the display title. The profile returns the channel id, login, display name, profile imagery and a follower total. Run it first to confirm that a login resolves before you call clips, videos or stream operations. It reads one channel and does not list others.
- Find the login behind a name or keyword
-
Search takes free text in the required query field and returns a short list of candidate channels, 15 in the recorded probe, with no cursor for further pages. Compare each candidate's login, display name and description instead of accepting the first row, then pass the chosen login to the other operations. A popular name can match several channels.
- Page through clips and past broadcasts
-
Clips and videos are separate collections for the same channel login. Leave the optional cursor empty on the first request, then send back the numeric continuation value the previous response returned for that channel, unchanged. The recorded pages held 12 entries each. Neither collection is guaranteed to be the channel's complete history.
- Read live status, tags and viewer count
-
Stream details, stream tags and viewer count each take only the channel login and return a snapshot taken at request time. An offline channel returned status ok with data.user.stream set to null, and only stream details added a message saying so. The live branch was not observed, so inspect a response from a live channel before mapping its fields, and keep null distinct from zero.
Channel Content
/api/project/twitch-scraper/list-channel-clips List Twitch Channel Clips by Login
Full docs โDetails
Returns the public Twitch clips for one channel as a cursor-paginated collection that is separate from the channel's videos and live-stream data. Inputs: channel (required) is the channel login shown in the public Twitch URL, for example ninja, not a display title; cursor (optional, number) is the continuation value returned by a previous response for the same channel and is omitted on the first request. Observed in a live probe for channel ninja: the response is the standard envelope {status, request_id, message, data} with status 'ok' and a null message, and data.user holds the channel id, a clips array of 12 entries and a top-level cursor (an integer in the probe). Each clips entry is {cursor, node}; the per-entry cursor was null for the first eleven entries and a string on the last one. Each node carried id, slug, url, embedURL, title, viewCount, language, thumbnailURL, createdAt, durationSeconds and isFeatured, plus nested curator (id, login, displayName), game (id, slug, name, boxArtURL), broadcast (id, startedAt, title) and broadcaster (id, login, displayName, profileImageURL, primaryColorHex, roles) objects; champBadge and guestStarParticipants were null. These field names come from a single probe and may not be present on every clip, and the next-page behavior of the cursor was not exercised in the probe. Clip availability changes over time: a result does not guarantee downloadable media or perpetual access, and the list should not be assumed to contain every historical clip.
Explicitly submit this Twitch request 1 required ยท 1 optional
| Parameter | In | Value |
|---|---|---|
| query |
Optional continuation cursor (1)
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
Channel Profiles
/api/project/twitch-scraper/get-channel-details Get Twitch Channel Profile and Followers by Login
Full docs โDetails
Returns public profile metadata for one Twitch channel, looked up by its login. Use it to identify a channel before fetching clips, videos or stream information. Input: channel (required) is the channel login shown in the public Twitch URL, for example ninja, not a display title. Observed in a live probe for channel ninja: the response is the standard envelope {status, request_id, message, data} with status 'ok' and a null message, and data.user holds id, login, displayName, primaryColorHex, profileImageURL and bannerImageURL; followers.totalCount (an integer); roles with isPartner and isParticipatingDJ booleans; and a channel object with its own id, self (isAuthorized, restrictionType), trailer (video) and home.preferences.heroPreset. The stream field was null in the probe because the channel was offline at that moment; the populated live-stream branch was not observed, so its field names are not documented here and live status should be read from the stream operations. Identifiers should be kept as strings and optional profile fields kept as returned: a missing field does not prove the channel was deleted, and a channel that exists is not necessarily broadcasting.
Explicitly submit this Twitch request 1 required ยท 0 optional
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
Channel Discovery
/api/project/twitch-scraper/search-channels Search Twitch Channels by Name or Keyword
Full docs โDetails
Searches publicly discoverable Twitch channels by text and returns a short list of candidates so you can pick the intended channel. Input: query (required) is a channel name or free search text, for example ninja. No cursor or page parameter is exposed, and the response carries no cursor. Observed in a live probe for query ninja: the response is the standard envelope {status, request_id, message, data} with status 'ok' and a null message, and data.channels held 15 entries, each {trackingID, item}. Each item carried id, login, displayName, profileImageURL, description (a string, or null on 2 of the 15), followers.totalCount, roles (isPartner, isParticipatingDJ), broadcastSettings (id, title), lastBroadcast (id, startedAt), channel (id, schedule), latestVideo.edges[].node (id, title, lengthSeconds, preview thumbnail fields) and topClip.edges[].node (id, slug, title, durationSeconds, thumbnailURL); self, watchParty and channel.schedule were null. item.stream was null for one offline channel and an object for the other 14 in this search probe, with fields such as type, viewersCount, game and freeformTags; those live-stream fields were seen only in this search sample and are not verified for other operations. Keep the returned login and source ids: a display name may differ from the login that channel and stream lookups require. Results can change between calls and are not an exhaustive directory.
Explicitly submit this Twitch request 1 required ยท 0 optional
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
Live Stream Status
/api/project/twitch-scraper/get-stream-details Get Twitch Stream Details by Channel Login
Full docs โDetails
Looks up the current broadcast of one Twitch channel and returns it as a point-in-time snapshot. Input: channel (required) is the channel login shown in the public Twitch URL, for example ninja, not a display title. Observed in a live probe for channel ninja while the channel was offline: HTTP 200 with the standard envelope {status, request_id, message, data}; status was 'ok', message carried a notice that the channel is currently offline, and data.user held id (a string), stream set to null and __typename 'User'. A null stream therefore means the channel is not broadcasting, or that no stream payload was available at request time; it is a valid result, not a failed request, so use status and message to tell the two apart. The populated live-stream branch was not observed in the probe, so its field names are not documented here and should be checked against a real live response before you map them. The operation does not record or download the stream and does not guarantee continuous live status; for the audience figure use Get Stream Viewer Count, and for classification labels use List Stream Tags.
Explicitly submit this Twitch request 1 required ยท 0 optional
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
Live Stream Classification
/api/project/twitch-scraper/list-stream-tags List Twitch Stream Tags by Channel Login
Full docs โDetails
Returns the classification tags attached to the current stream of one Twitch channel, so you can group or filter broadcasts by the labels Twitch shows. Input: channel (required) is the channel login shown in the public Twitch URL, for example ninja, not a display title. Observed in a live probe for channel ninja while the channel was offline: HTTP 200 with the standard envelope {status, request_id, message, data}; status was 'ok', message was null, and data.user held id (a string), stream set to null and __typename 'User'. With a null stream there were no tags to read, and that is a documented valid result rather than an invalid channel. The populated branch was not observed in the probe, so the names of the tag identifier and label fields are not documented here; inspect a response from a live channel before mapping them, keep the returned identifiers and labels exactly as supplied and never infer tags that are not returned. Tags can change over time and do not prove the channel is still live when you display them later; use Get Stream Details for the broadcast context.
Explicitly submit this Twitch request 1 required ยท 0 optional
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
Live Audience Metrics
/api/project/twitch-scraper/get-stream-viewer-count Get Twitch Stream Viewer Count by Channel Login
Full docs โDetails
Returns the viewer-count information available for the current stream of one Twitch channel, as a snapshot taken at request time. Input: channel (required) is the channel login shown in the public Twitch URL, for example ninja, not a display title. Observed in a live probe for channel ninja while the channel was offline: HTTP 200 with the standard envelope {status, request_id, message, data}; status was 'ok', message was null, and data.user held id (a string), stream set to null and __typename 'User'. With a null stream there was no viewer figure in the response, which is a documented valid result. The populated live-stream branch was not observed in the probe, so the name of the viewer-count field is not documented here; inspect a response from a live channel before mapping it, and keep a missing value distinct from numeric zero. The number is the audience of the current stream, which is different from historical video views or total channel followers. The operation provides no audience history or time series, so record your own retrieval timestamp with every snapshot.
Explicitly submit this Twitch request 1 required ยท 0 optional
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
Channel Videos
/api/project/twitch-scraper/list-channel-videos List a Twitch channel's public past-broadcast videos
Full docs โDetails
Returns the public video (past broadcast) collection that is currently available for one Twitch channel, looked up by channel login. Send the required channel parameter (for example ninja) and, on later pages only, the optional numeric cursor returned for the same channel. The response is wrapped as {status, request_id, message, data}, and the records sit under data.user. Observed in a live probe for channel ninja: data.user.id (channel id), data.user.videos (12 edges per page), and data.user.cursor (an integer, 2 on the first page) as the page-level continuation value. Each edge carries an opaque cursor string and a node with id, title, publishedAt (ISO 8601 UTC), lengthSeconds, viewCount, previewThumbnailURL, animatedPreviewURL, game (id, name, displayName, slug, boxArtURL), owner (id, login, displayName, profileImageURL, primaryColorHex, roles.isPartner), self.isRestricted, resourceRestriction and contentTags. In that probe the videos came back newest first, resourceRestriction was null and contentTags was an empty list; populated values for those two fields, the second page, and the end of the collection were not observed. Pagination: omit cursor on the first request, keep channel identical, reuse the returned continuation value unchanged, stop when it is missing or repeats, and deduplicate by video id. Scope: the response reflects available video records, not a complete historical archive; deleted, expired or restricted recordings may be absent. The operation returns metadata and image links only and does not download media.
Explicitly submit this Twitch request 1 required ยท 1 optional
| Parameter | In | Value |
|---|---|---|
| query |
Optional continuation cursor (1)
| Parameter | In | Value |
|---|---|---|
| query |
Request cost is temporarily unavailable. No price is assumed.
Public channel profiles, clips, videos and live-stream snapshots
Read public Twitch data by channel login through a simple REST/JSON API: channel profiles, channel search, clips, past broadcasts and point-in-time stream status, with no Twitch developer app to register and no OAuth tokens to manage.
- Channel profile: user id, login, display name, profile imagery, follower total and partner flag for one channel
- Channel search: find candidate channels by name or keyword and recover the login for follow-up calls
- Clips and videos: cursor-paginated clip and past-broadcast collections for any public channel
- Live status: stream details, stream tags and viewer count snapshots, with an explicit null stream when the channel is offline
RESTful JSON API for creator-marketing shortlists, esports and game-publisher monitoring, go-live notification bots, stream overlays, clip curation and analytics dashboards.