Twitch streamer live status API
Whether a Twitch streamer is live right now, by handle: people watching now, the stream's title, game (Twitch's category), tags and start time, and the streamer's name, avatar and followers. A streamer who is not live answers with status offline and the title and start time of the last stream.
GEThttps://api.okdata.online/v1/twitch/live/users/get
Also calledis twitch streamer livetwitch live viewerstwitch stream status
- Price
- $0.004
- per call · bad parameters are free
- Returns
- One LiveRoom
- as data.item
- If a call fails
- Charged once
- When a data source fails, the next one is tried. A call that reached a source is charged once even if it fails; bad parameters are free.
- Status
- preview
- It may still change; any change is announced beforehand.
Parameters
| Name | Type | Description |
|---|---|---|
usernamerequired | string | The Twitch handle (login): the part after twitch.tv/, with or without @. |
view | stringbriefcompactstandardfull | How much of each object comes back. brief: IDs, title, the first 100 characters of the text, link, time and the main counts, for scanning a list (then get what you need by ID). compact leaves out empty fields and cuts long text at 500 characters. full adds platform-specific fields under ext. |
fields | string[] | Fields to keep, by path (author.name), to save tokens. In a query string: comma-separated. |
cursor, view and fields work the same on every endpoint: how requests work.
Request
cURL
curl -G "https://api.okdata.online/v1/twitch/live/users/get" \
-H "Authorization: Bearer $OKDATA_API_KEY" \
--data-urlencode 'username=bobross'Python
import os
import requests
resp = requests.get(
"https://api.okdata.online/v1/twitch/live/users/get",
headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
params={"username": "bobross"},
timeout=60,
)
body = resp.json()
if body["code"] != "ok":
raise RuntimeError(f"{body['code']}: {body['message']} (charged: {body['charged']})")
row = body["data"]["item"]
print(row["status"], row["title"], row["metrics"]["viewers"])
print("cost: $" + body["meta"]["billing"]["amount"])TypeScript
const url = new URL('https://api.okdata.online/v1/twitch/live/users/get');
url.searchParams.set('username', "bobross");
const res = await fetch(url, {
headers: {
Authorization: `Bearer ${process.env.OKDATA_API_KEY}`,
},
});
const body = await res.json();
if (body.code !== 'ok') throw new Error(`${body.code}: ${body.message}`);
const row = body.data.item;
console.log(row.status, row.title, row.metrics.viewers);
console.log('cost: $' + body.meta.billing.amount);MCPtools/call
{
"name": "call",
"arguments": {
"capability": "twitch.live.users.get",
"username": "bobross"
}
}Response
{
"code": "ok",
"request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
"data": {
"item": {
"id": "321451958240",
"url": "https://www.twitch.tv/trailkit",
"status": "live",
"title": "Winter camping, packing the sled",
"category": "Travel & Outdoors",
"cover_url": null,
"host": {
"id": "105458682",
"username": "trailkit",
"name": "TrailKit",
"avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/trailkit-profile_image-150x150.jpeg",
"followers": 182300,
"verified": null
},
"started_at": "2026-11-19T01:37:37Z",
"rank": null,
"metrics": {
"viewers": 805,
"total_viewers": null,
"likes": null,
"heat": null,
"products": null
}
}
},
"warnings": [],
"meta": {
"capability": "twitch.live.users.get",
"billing": {
"amount": "0.004",
"currency": "USD",
"balance_after": "9.996"
},
"unavailable": {},
"cached": false,
"replayed": false,
"fetched_at": "2026-11-11T08:00:00Z"
}
}Try it
This sends a real call to https://api.okdata.online and is billed as usual: at most $0.004, also when the data source comes back empty, not found or failed. Bad parameters are never charged. Your key goes only to that address and is never stored on this site.
Returned fields
data.item is one LiveRoom.
| Field | Type | View | Description |
|---|---|---|---|
id | string | null | compact | The room's ID; the endpoints that read a room take it. Null where the platform names no room: an account that is not live, or a board entry that links to the host only. |
url | string | null | compact | The room's web page; null where the platform gives the room none. |
status | string | compact | live: streaming now. offline: not streaming (the other fields then describe the last session, where the platform still shows it). |
title | string | null | compact | The room's title as the host set it. |
category | string | null | compact | The room's category or game, in the platform's words (Twitch's game, Bilibili's area); null where the platform gives none. |
cover_url | string | null | standard | Cover image. |
Show all 11 fieldsHide the other 5
| Field | Type | View | Description |
|---|---|---|---|
host | AccountRef | compact | The host's public account. |
started_at | string | null | compact | When the current (or last) session started, ISO 8601 in UTC. |
rank | integer | null | compact | Place on the board, from 1; null outside boards. |
metrics | LiveMetrics | compact | Room-level counts at fetch time; a count the platform does not show is null. |
ext | object | full | Platform-specific extras. Only returned with view=full. |
The view column is the smallest view a field comes back in: compact returns only compact fields, standard adds the standard ones, full returns everything. The default is standard.
When it is charged
One call costs $0.004 and returns one live_room. 1,000 lookups cost $4.00. A lookup that reached the data source is charged even when it is not found or the source fails; calls stopped before reaching a source are free.
Data comes back$0.004 per call
Bad parameters, too little balance, a paused endpointFree
| When | Charge |
|---|---|
| Most one call costs | $0.004 |
| An empty answer | $0.004 |
| Not found (the platform has no such item) | $0.004 |
| The data source fails or times out | $0.004 |
| Bad parameters, too little balance, a paused endpoint | Free |
| Resent with the same Idempotency-Key within 24 hours | Free when the kept result comes back |
A call that reached the data source costs $0.004 even when the answer is empty, not found or a failure of the source; a call stopped before that, such as for bad parameters, is free.
Prices from price book 53dd8ce13c359590. Every price on this platform →
Common errors
Every error has the same shape and says whether it was charged. The ones this endpoint can return:
| HTTP | Code | Meaning | Charged |
|---|---|---|---|
| 400 | invalid_params | A parameter is missing, has the wrong type or value, or the method is wrong. problems lists each one; param names the first.Retry: after a fix | no |
| 401 | unauthorized | The key is missing, malformed, revoked, disabled or expired (reason says which when known).Retry: no | no |
| 402 | insufficient_balance | The balance (available) cannot cover the most this call could cost (required).Retry: after a fix | no |
| 404 | not_found | The post, account or page does not exist or is not public. When the data source billed the lookup, or the endpoint's charge_when_not_found is above 0, this answer is charged: the body then says charged: true and amount.Retry: no | once, if it reached a data source |
| 429 | rate_limited | The account sent too many requests this minute (reason: rate) or has too many calls running (reason: concurrency).Retry: yes | no |
| 500 | settlement_unknown | The data came back, but the charge could not be confirmed.Retry: with the same Idempotency-Key | unknown until looked up |
| 502 | upstream_failed | Every data source for this endpoint failed on this request. If a source billed the attempt, it is charged once at the endpoint's price (charged: true and amount); otherwise nothing is charged.Retry: yes | once, if it reached a data source |
| 503 | capability_paused | This endpoint is paused right now; nothing ran.Retry: yes | no |
| 504 | timeout | The data did not come back in time. If the request had reached a data source that bills it, it is charged once at the endpoint's price (charged: true and amount); otherwise the hold is released.Retry: yes | once, if it reached a data source |
Questions
How much does the Twitch streamer live status API cost?
One call costs $0.004 and returns one live_room. 1,000 lookups cost $4.00. A lookup that reached the data source is charged even when it is not found or the source fails; calls stopped before reaching a source are free.
Do I need a Twitch account, cookies or a QR login?
No. You send only your okdata API key. The data is public data from Twitch; nothing is fetched with your own Twitch account.
Am I charged when a call fails?
Yes, once, when the call reached the data source: an empty answer, a not_found, a failure or a timeout of the source costs one call (one item for per-item endpoints), and the error says charged: true with amount. Calls refused before reaching a source, such as bad parameters or a low balance, cost nothing.
What if Twitch does not show a field?
The field is null, and meta.unavailable names it with the reason: platform (the platform never shows it) or capability (we cannot fetch it yet).
Use it in your AI
Paste this into Claude, ChatGPT, Cursor or any agent that can open a web page. It reads this endpoint’s page and calls it with your key.
Read https://okdata.online/apis/twitch/live/users/get.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use Twitch streamer live status and tell me whether it is live now, how many people are watching and since when.
With the MCP server connected, just ask: Use Twitch streamer live status and tell me whether it is live now, how many people are watching and since when.
Names and ID
- Name
- Twitch streamer live status API
- Short name
- Twitch streamer live status
- ID
twitch.live.users.get- Endpoint
GET /v1/twitch/live/users/get- Category
- Social media
- Also called
- is twitch streamer live, twitch live viewers, twitch stream status
- Returns
- LiveRoom: 11 fields