Twitch API endpoint
Use Crawlora's Twitch schedule API to extract supported public Twitch data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/twitch/scheduleReturns a Twitch channel's upcoming broadcast schedule -- planned segments with title, start/end time, and game/category -- starting today. A channel with no schedule configured returns an empty segments list, not an error. Public data sourced from Twitch's own GraphQL API. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| channel | string | Yes | Twitch channel login (the lowercase URL slug) | ||
| weeks | integer | No | Number of weeks ahead to return, starting today (default 1, max 4) | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/twitch/schedule" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
- A channel with no schedule configured returns a `200` with an empty `segments` list, not an error. - `next_segment_id`/`next_segment_at` identify the next upcoming segment (which may be outside the requested `weeks` window if the window starts mid-gap). - Each segment's `categories` lists the game(s) planned for that broadcast; a segment can have zero categories if none was set. - An unknown channel login returns `404`. A missing `channel` returns `400` before any upstream request is made. Example response: ```json { "code": 200, "msg": "OK", "data": { "channel": "caedrel", "count": 5, "next_segment_id": "eyJzZWdtZW50SUQiOiJkYjgzMmNiYi1lMmUzLTQzODUtOTRiYS1iNTQ4MTk2M2E4ODkiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjozM30=", "next_segment_at": "2026-08-15T12:00:00Z", "segments": [ { "id": "eyJzZWdtZW50SUQiOiI3YmJmYzA3OC00Nzg3LTQzMWEtOWQ4Yy0xNDRjYmI3YWRkOWIiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjozM30=", "title": "LEC", "start_at": "2026-08-10T12:00:00Z", "end_at": "2026-08-10T19:00:00Z", "is_cancelled": false, "categories": [ { "id": "21779", "slug": "league-of-legends", "name": "League of Legends", "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/21779-144x192.jpg" } ] } ] } } ```
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"channel": "caedrel",
"count": 5,
"next_segment_id": "eyJzZWdtZW50SUQiOiJkYjgzMmNiYi1lMmUzLTQzODUtOTRiYS1iNTQ4MTk2M2E4ODkiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjozM30=",
"next_segment_at": "2026-08-15T12:00:00Z",
"segments": [
{
"id": "eyJzZWdtZW50SUQiOiI3YmJmYzA3OC00Nzg3LTQzMWEtOWQ4Yy0xNDRjYmI3YWRkOWIiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjozM30=",
"title": "LEC",
"start_at": "2026-08-10T12:00:00Z",
"end_at": "2026-08-10T19:00:00Z",
"is_cancelled": false,
"categories": [
{
"id": "21779",
"slug": "league-of-legends",
"name": "League of Legends",
"box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/21779-144x192.jpg"
}
]
}
]
}
}Request schema
No body schema
Response schema
#/definitions/twitch.scheduleResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | twitch.ScheduleResponse | No | ||||
| data.channel | string | No | ||||
| data.count | integer | No | 5 | |||
| data.next_segment_at | string | No | 2026-08-15T12:00:00Z | |||
| data.next_segment_id | string | No | ||||
| data.segments | array | No | ||||
| data.segments[].cancelled_until | string | No | ||||
| data.segments[].categories | array | No | ||||
| data.segments[].categories[].box_art_url | string | No | ||||
| data.segments[].categories[].id | string | No | ||||
| data.segments[].categories[].name | string | No | League of Legends | |||
| data.segments[].categories[].slug | string | No | league-of-legends | |||
| data.segments[].end_at | string | No | 2026-08-15T19:00:00Z | |||
| data.segments[].id | string | No | ||||
| data.segments[].is_cancelled | boolean | No | false | |||
| data.segments[].start_at | string | No | 2026-08-15T12:00:00Z | |||
| data.segments[].title | string | No | LEC | |||
| msg | string | No | OK |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/twitch/schedule" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms