Get Twitch Stream Details by Channel Login

View all Twitch Channel, Clips, Videos & Stream Data endpoints →

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.

API Features

Live or offline in one GET Send a channel login and read data.user.stream: it was null for an offline channel in the probe, and a populated object signals an active broadcast. No Twitch developer app or client-credentials token is needed.
Explicit offline notice For an offline channel the envelope returns status 'ok' with HTTP 200 and a message saying the channel is currently offline, so your code can show an offline state instead of treating the answer as an error.
User id returned even when offline data.user.id and __typename come back whether or not the channel is broadcasting, so you can confirm the login resolved to a real Twitch user and key your own records on the id.
Request id on every response The envelope includes a request_id string next to status and message, which you can log per poll to trace a specific go-live check later.
Snapshot, not a recording The result describes the channel at request time only. Nothing is recorded or downloaded, so schedule your own polls and store the retrieval timestamp with each answer.

Live API Demo

GET /api/project/twitch-scraper/get-stream-details

Request cost is temporarily unavailable. No price is assumed.

View pricing

API Response (JSON)

{}
curl -X GET 'https://api.opendata-api.com/api/project/twitch-scraper/get-stream-details?key=<API_KEY>&channel=ninja'
📢
Need Help?
If you encounter API issues or need other API requirements, please contact us.
Contact Us

Use Cases

Frequently asked questions

What does data.user.stream = null mean?

In the probe for channel ninja the stream value was null while the channel was offline. A null stream means the channel is not broadcasting, or that no stream payload was available when the request was made. It is a valid answer with status 'ok', not a failed request.

Is the 'channel is currently offline' message an error?

No. The probe returned HTTP 200 and status 'ok' with a message noting the channel is currently offline. Among the three stream operations only Get Stream Details adds this message, so it is a convenient tie-breaker between an offline channel and a request that did not resolve.

How do I tell an offline channel from a failed request?

Check the HTTP status, the envelope status field and the message together. An offline channel returns status 'ok', a data.user object with its id, stream set to null and an offline message. A failed request does not return that populated user object.

Which fields come back when the channel is live?

The populated live-stream branch was not observed in the probe, so its field names are not documented here. Call the endpoint while a channel is broadcasting and inspect data.user.stream before you build a mapping, and treat any field you do not see as optional.

What do I pass as the channel parameter?

Pass the channel login shown in the public Twitch URL, for example ninja. A display name or free text is not a login; if you only know a name, run Search Channels first and use the login from the result.

Does this endpoint record or download the stream?

No. It returns a point-in-time lookup of the broadcast metadata and does not record, capture or download the stream. It also does not guarantee continuous live status, so poll again when you need a fresh answer.

Where do I get the viewer count and the stream tags?

Use Get Stream Viewer Count for the audience snapshot and List Stream Tags for the classification labels. Both take the same channel login and, in the probe, returned the same data.user shape with a null stream for an offline channel.

Related operations

Guides

View Subscription Plans →