Twitch

GET /v1/twitch/user-schedule

Twitch User Schedule API

Twitch channel schedule — segment id, isRecurring, canceledUntil, startedAt/endedAt (1 credit).

1 credit per request

Try in Playground Get your API key — free Read the docs

TL;DR

Twitch channel schedule — segment id, isRecurring, canceledUntil, startedAt/endedAt (1 credit). The Twitch User Schedule API (Twitch) is a single authenticated GET request to /v1/twitch/user-schedule that responds with clean JSON and costs 1 credit. Pass cache=true for a free 24h cache hit; default is always fresh. Start with 100 free credits — no credit card.

What is the Twitch User Schedule API?

Pass a Twitch channel URL or username and get upcoming schedule segments as clean JSON. Each segment: id (stable segment key for dedup), title, startedAt/endedAt (canonical — same tense as stream.startedAt; startAt/endAt kept as deprecated aliases), game/gameId, isRecurring, isCancelled, canceledUntil (skip segments where this is set — a canceled broadcast still appears in Twitch's list), firstOccurrenceAt. This is the canonical full schedule; twitch/profile.schedule[] is only a short preview (up to 10). Anonymous GQL does not expose timezone or vacation mode. Flat 1 credit. Pass limit (default 50, max 100).

What you get

Segment id + isRecurring + canceledUntil / isCancelled
startedAt/endedAt (startAt/endAt deprecated aliases)
game + gameId when the segment has a category
Canonical full schedule — profile.schedule[] is a lean preview only

Platform limits

Honest ceilings from the upstream platform surface — not Captapi bugs. Unexpected truncation here is usually the platform, not us.

timezone and vacation mode are not on Twitch's anonymous Schedule type — not inventable here.
Canceled segments still appear; filter client-side on canceledUntil / isCancelled.

Try it

Open in Playground

Fill in the parameters below and copy a ready-to-run request, or open the live Playground to run it against your account (no API key paste).

Parameters

url*stringTwitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble.limitoptionalintegerMax schedule segments to return (default 50, max 100). Flat 1 credit per call.cacheoptionalbooleanSet true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. Envelope includes cached + cachedAt on hits.

API keyoptionalPaste your key to get a ready-to-run snippet. It stays in your browser.Sign in to run live

curl "https://api.captapi.com/v1/twitch/user-schedule?url=https%3A%2F%2Fwww.twitch.tv%2Fcriticalrole" \
  -H "Authorization: Bearer capt_live_..."
# or: -H "x-api-key: capt_live_..."

Edit the parameters and the code updates instantly. Switch languages and hit copy.

Example response

{
  "success": true,
  "data": {
    "platform": "twitch",
    "username": "criticalrole",
    "totalReturned": 1,
    "schedule": [
      {
        "id": "eyJzZWdtZW50SUQiOiI1MWYyNGJjNS02ZmY2LTRhOTgtYjk4Ni04ZGIyNzVhMWE2MmEiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjozMn0=",
        "title": "Age of Umbra: Sallowlands",
        "startedAt": "2026-08-07T02:00:00Z",
        "endedAt": "2026-08-07T06:00:00Z",
        "startAt": "2026-08-07T02:00:00Z",
        "endAt": "2026-08-07T06:00:00Z",
        "game": "Tabletop RPGs",
        "gameId": "509664",
        "isRecurring": false,
        "isCancelled": false,
        "firstOccurrenceAt": "2026-08-07T02:00:00Z"
      }
    ]
  }
}

Billing metadata is returned in response headers: X-Captapi-Credits (credits charged), X-Captapi-Cache (hit or miss), and X-Captapi-Source. Failed requests (4xx/5xx) are never charged. See the full list of error codes in the error reference.

Response structure

A successful call returns success, cached, creditsUsed, and a data object with the following fields:

Top-level fields

platformPlatform identifier for this response (matches the endpoint's platform).
usernameAccount username / handle.
totalReturnedNumber of items returned in this response.

Schedule

Each item in schedule contains:

idStable schedule segment id — use for dedup and change tracking.
titleTitle of the item.
startedAtSegment start (ISO-8601 UTC). Canonical; matches stream.startedAt naming. startAt is a deprecated alias.
endedAtSegment end (ISO-8601 UTC). Canonical; endAt is a deprecated alias.
startAtDeprecated alias of startedAt — prefer startedAt.
endAtDeprecated alias of endedAt — prefer endedAt.
gameCategory / game name string for the segment.
gameIdTwitch game/category id.
isRecurringWhether the segment is a weekly recurring series (derived from Twitch repeatEndsAfterCount).
isCancelledWhether this occurrence is cancelled.
firstOccurrenceAtFirst occurrence of a recurring series when Twitch exposes it.

Parameters

Name	Type	Required	Description
url	string	Yes	Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble.
limit	integer	No	Max schedule segments to return (default 50, max 100). Flat 1 credit per call.
cache	boolean	No	Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. Envelope includes cached + cachedAt on hits.

Authentication: send your key as Authorization: Bearer capt_live_.... A typical call costs 1 credit. Pass cache=true for a free 24h cache hit; default is always fresh.

Using an AI agent? This endpoint is the MCP tool twitch_user_schedule via @captapi/mcp. Set it up →

How it works

1. Sign up — get 100 free credits, no card required.
2. Create a key from your dashboard.
3. Send one request to /v1/twitch/user-schedule and parse the JSON response.

Use cases

Calendar sync

Build a stream calendar; skip rows where canceledUntil or isCancelled is set.

Recurring series

Use isRecurring + id to track weekly slots without mistaking one-offs.

Category planning

Read game/gameId per segment for upcoming content mix.

Preview vs full

profile.schedule[] is a short preview — this endpoint is the canonical full schedule.

Frequently asked questions

What does the Twitch User Schedule API do?+

The Twitch User Schedule API lets you list items in bulk with metadata from a public Twitch user schedule using one GET request to /v1/twitch/user-schedule. It returns clean JSON — no OAuth or infrastructure setup required.

How many credits does the Twitch User Schedule API cost?+

Each successful call costs 1 credit. Pass cache=true to serve from the 24h cache (0 credits on hit); default is always fresh. Hits include cached + cachedAt. Selected profile endpoints also accept cacheMaxAge=1d|3d|7d|14d|30d. Failed or empty results are never charged.

Do I need a Twitch API key or OAuth?+

No. A single Captapi key works across every platform Captapi supports — YouTube, TikTok, Instagram, Facebook, Twitter/X, Reddit, Threads, Bluesky, Pinterest, LinkedIn, Rumble, Spotify, Kwai, and more. We handle proxies, rate limits, retries, and authentication for you.

Is the Twitch User Schedule API suitable for production use?+

Yes. It is a stable REST endpoint with predictable JSON and automatic retries. Pass cache=true to serve from the 24h cache (0 credits on hit); default is always fresh. Hits include cached + cachedAt. Selected profile endpoints also accept cacheMaxAge=1d|3d|7d|14d|30d. Use it for analytics, monitoring, and content automation.

More Twitch APIs

Twitch Profile API Twitch User Videos API Twitch Clip API

Ready to use the Twitch User Schedule API?

Get started free