Twitch
GET /v1/twitch/user-schedule

Twitch User Schedule API

List Twitch user schedule with full metadata for each item.

1 credit per request
TL;DR
List Twitch user schedule with full metadata for each item. 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?

The Twitch User Schedule API lets you list items in bulk with metadata for Twitch user schedule with a single REST call. No OAuth, no infrastructure to maintain, and no platform SDKs — send the request, get clean structured JSON back. Pass cache=true to serve from the 24h shared cache (0 credits on hit); default is always fresh.

What you get

  • Bulk list of user schedule with metadata
  • Dates, URLs, and engagement fields when available
  • Configurable result limit
  • Ideal for monitoring and content pipelines

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

Sign in to run live
curl "https://api.captapi.com/v1/twitch/user-schedule?url=https%3A%2F%2Fwww.twitch.tv%2Fshroud" \
  -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",
    "schedule": [
      {
        "title": "Age of Umbra: Sallowlands",
        "startAt": "2026-07-17T02:00:00Z",
        "endAt": "2026-07-17T06:00:00Z",
        "game": "Tabletop RPGs"
      }
    ]
  }
}

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 (e.g. youtube, instagram).
  • usernameAccount username / handle.

Schedule

Each item in schedule contains:

  • titleTitle of the item.
  • startAtStart at. Example: "2026-07-17T02:00:00Z".
  • endAtEnd at. Example: "2026-07-17T06:00:00Z".
  • gameGame or category being streamed.

Parameters

NameTypeRequiredDescription
urlstringYesTwitch 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.
cachebooleanNoSet true to serve from the 24h response cache. Default false — always fetch fresh data.

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

Use cases

Content Pipelines

Ingest a channel's catalog in bulk.

Monitoring

Detect new uploads automatically.

Archiving

Snapshot a creator's full library.

Analytics

Aggregate performance across many videos.

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 shared cache (0 credits on hit); default is always fresh. 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 shared cache (0 credits on hit); default is always fresh. Use it for analytics, monitoring, and content automation.

More Twitch APIs

Ready to use the Twitch User Schedule API?

Sign up, grab your key, and make your first call in 60 seconds.