twitch.category_streams

stable Advanced

Live streams in a Twitch category.

GET /v1/twitch/category_streams

What you get#

A list of Twitch results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`name`	string	yes	(required)	Twitch category name, e.g. Just Chatting	max 100 chars; must match `[^\x00-\x1f\"\\]{1,100}`; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/twitch/category_streams?name=Just%20Chatting" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Twitch response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "content": {
        "id": "318233159768",
        "title": "[DROPS ON] UNBANNED WOW FOREVER  BETA ACE COMBAT RELEASE BIG DAY HUGE DRAMA  TODAY NEW GAMES BIG NEWS  REACTS | @asmongold247",
        "createdAt": "2026-09-28T17:34:53Z",
        "category": "Just Chatting"
      },
      "engagement": {
        "views": 42973
      },
      "media": {
        "thumbnailUrl": "https://static-cdn.jtvnw.net/previews-ttv/live_user_zackrawrr-320x180.jpg"
      },
      "author": {
        "id": "552120296",
        "username": "zackrawrr",
        "displayName": "zackrawrr"
      }
    },
    {
      "content": {
        "id": "318809799654",
        "title": "⚽️BINGO FIFA 27 CON ZANO E MARZA💰300€ DI PACCHI🤑REACTIONS💥",
        "createdAt": "2026-09-28T19:09:18Z",
        "category": "Just Chatting"
      },
      "engagement": {
        "views": 41067
      },
      "media": {
        "thumbnailUrl": "https://static-cdn.jtvnw.net/previews-ttv/live_user_tumblurr-320x180.jpg"
      },
      "author": {
        "id": "77827128",
        "username": "tumblurr",
        "displayName": "Tumblurr"
      }
    }
  ],
  "metadata": {
    "platform": "twitch",
    "endpoint": "category_streams",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`node.id`	`content.id`	-
`node.title`	`content.title`	-
`node.viewersCount`	`engagement.views`	`toNumber`
`node.createdAt`	`content.createdAt`	`toIsoDate`
`node.previewImageURL`	`media.thumbnailUrl`	`safeUrl`
`node.broadcaster.id`	`author.id`	-
`node.broadcaster.login`	`author.username`	-
`node.broadcaster.displayName`	`author.displayName`	-
`node.game.name`	`content.category`	-

Caching and freshness#

Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
Between 30 seconds and 5 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 15 minutes more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).