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

# Get user schedule

`GET /v1/twitch/user/schedule`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/twitch/user/schedule`
- Auth: API key in header `x-api-key`

Retrieve the current calendar week, Monday 00:00 UTC through the next Monday. Includes schedule segments, cancellation metadata, interruption, next segment, current stream and this week’s recent broadcasts. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `handle` string, required

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `id` string, required
    - `primaryColorHex` string, nullable, required
    - `lastBroadcast` object, nullable, required
      - `id` string, required
      - `startedAt` string, required
      - `__typename` string, required
    - `broadcastSettings` object, required
      - `id` string, required
      - `title` string, required
      - `__typename` string, required
    - `stream` unknown, required
    - `videos` object, required
      - `edges` object[], required
        - `node` object, required
          - `id` string, required
          - `title` string, required
          - `createdAt` string, required
          - `lengthSeconds` integer, required
          - `viewCount` integer, required
          - `previewThumbnailURL` string, required
          - `game` object, nullable, required
            - `id` string, required
            - `slug` string, required
            - `name` string, required
            - `__typename` string, required
          - `__typename` string, required
    - `channel` object, required
      - `id` string, required
      - `schedule` object, nullable, required
        - `id` string, required
        - `nextSegment` object, nullable, required
          - `id` string, required
          - `startAt` string, required
          - `__typename` string, required
        - `interruption` unknown, required
        - `segments` object[], required
          - `id` string, required
          - `baseSegmentID` string, required
          - `title` string, required
          - `startAt` string, required
          - `endAt` string, required
          - `isCancelled` boolean, required
          - `cancelledUntil` string, nullable, required
          - `hasReminder` boolean, required
          - `repeatEndsAfterCount` integer, nullable, required
          - `categories` object[], required
            - `id` string, required
            - `slug` string, required
            - `name` string, required
            - `__typename` string, required
          - `__typename` string, required
        - `__typename` string, required
      - `__typename` string, required
    - `__typename` string, required
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_graphql', required
      - `complete` boolean, required
      - `warnings` string[], required
      - `order` 'newest_first' | 'oldest_first' | 'ranked' | 'relevance' | 'source_order'
      - `window` object
        - `since` string, date-time
        - `until` string, date-time
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `failure` object, required
      - `code` 'invalid_request' | 'unauthorized' | 'not_found' | 'upstream_challenged' | 'upstream_rate_limited' | 'upstream_error' | 'upstream_graphql_error' | 'unsupported_page' | 'restricted_page' | 'response_too_large' | 'unsafe_redirect' | 'request_limit' | 'timeout' | 'busy' | 'payload_too_complex' | 'public_client_unavailable', required
      - `message` string, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

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