---
title: "Twitch User Schedule API"
method: GET
path: "/v1/twitch/user-schedule"
tags: ["Twitch"]
---

# Twitch User Schedule API

`GET /v1/twitch/user-schedule`

## Request

- Base URL: `https://api.captapi.com`
- URL: `https://api.captapi.com/v1/twitch/user-schedule`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Twitch channel schedule — startAt/endAt, title, game, isRecurring (0 credits when empty).

Pass a Twitch channel URL or username and get upcoming schedule segments as clean JSON. Each segment: id (stable segment key for dedup), title and game/gameId when Twitch exposes them, startAt/endAt (future-events tense — not startedAt/endedAt), isRecurring (false on one-offs, never null), isCancelled, canceledUntil (skip segments where this is set — a canceled broadcast still appears in Twitch's list), firstOccurrenceAt only when isRecurring is true. 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. Empty schedule (totalReturned=0) is 0 credits. Pass limit (default 50, max 100).

Docs: https://captapi.com/apis/twitch-user-schedule

## Query parameters

- `url` string, required
- `limit` integer
- `cache` boolean

## Response `200`

Success. The data object for this endpoint.

- object
  - `success` unknown, required
  - `data` object, required
    - `platform` string: Platform identifier for this response (matches the endpoint's platform).
    - `handle` string: Channel login this schedule belongs to.
    - `totalReturned` integer: Number of items returned in this response.
    - `schedule` object[]
      - `id` string: Id of this schedule item.
      - `startAt` string: Segment start (ISO-8601 UTC). Future-events tense — this endpoint lists upcoming slots, not a stream that already started.
      - `endAt` string: Segment end (ISO-8601 UTC).
      - `isRecurring` boolean: Whether the segment is a recurring series. false on one-offs — never null.
      - `isCancelled` boolean: Whether this occurrence is cancelled.
      - `firstOccurrenceAt` string

## Other responses

- `400`: Bad request: wrong platform URL, unknown endpoint, or an invalid parameter value. Not billed.
- `401`: Missing, invalid or revoked API key. Not billed.
- `402`: Not enough credits for this request. Not billed.
- `404`: The resource does not exist or is not public. Not billed.
- `422`: A required parameter is missing or has the wrong type. Not billed.
- `429`: Rate limit reached. Wait for Retry-After seconds. Not billed.
- `502`: The platform could not be reached or returned nothing usable. Retryable, not billed. 503 and 504 use the same envelope.

---

[API](https://skmtc.dev/captapi/apis/captapi-api.md) · [All operations](https://skmtc.dev/captapi/apis/captapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/captapi/apis/captapi-api/revisions/c9b9ac5ff1bd?raw)