StatusSupportGet API keyDashboard
TwitchSchedule

Twitch

Twitch Schedule API

Use with AI

Returns the streams a public Twitch channel has scheduled and not yet started, soonest first, from its login, link or numeric ID. Each slot has its title, category, start and end time, whether it was cancelled and how often it repeats, with the channel's numeric ID, login, name and Partner badge. Each page covers a week.

GET /v1/twitch/schedule

Try it

Example

cURL
curl 'https://socialtap.dev/v1/twitch/schedule?handle=riotgames' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
TypeScript SDK
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.twitch.schedule.list({ handle: "riotgames" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
Node.js (fetch)
const params = new URLSearchParams({
  handle: "riotgames",
});
const res = await fetch(`https://socialtap.dev/v1/twitch/schedule?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);
Python (requests)
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/twitch/schedule",
    params={"handle": "riotgames"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])
Go (net/http)
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("handle", "riotgames")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/twitch/schedule?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Page  json.RawMessage `json:"page"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
PHP
<?php

$query = http_build_query([
    'handle' => 'riotgames',
]);
$ch = curl_init('https://socialtap.dev/v1/twitch/schedule?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;
Ruby
require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/twitch/schedule")
uri.query = URI.encode_www_form('handle' => 'riotgames')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]
Java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "handle=" + encode("riotgames");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/twitch/schedule?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}
.NET
using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",
    "handle=" + Uri.EscapeDataString("riotgames"));
var res = await http.GetAsync("https://socialtap.dev/v1/twitch/schedule?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));
Rust
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/twitch/schedule")
        .query(&[("handle", "riotgames")])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}
200 OK
{
  "data": [
    {
      "approximate_fields": [],
      "category": "League of Legends",
      "ended_at": null,
      "host": {
        "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/35b02a12-d516-499e-90f8-7899f136fa18-profile_image-300x300.png",
        "display_name": "Riot Games",
        "id": "36029255",
        "is_verified": true,
        "url": "https://www.twitch.tv/riotgames",
        "username": "riotgames"
      },
      "id": "eyJzZWdtZW50SUQiOiJiYmQ2OGYxOC03MTYwLTRjYjgtODdmOC1mY2Y1NDZiN2FmMjYiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjo0NX0=",
      "metrics": {
        "concurrent_viewer_count": null,
        "like_count": null,
        "view_count": null
      },
      "platform": "twitch",
      "platform_specific": {
        "twitch": {
          "base_segment_id": "bbd68f18-7160-4cb8-87f8-fcf546b7af26",
          "cancellation_ends_at": null,
          "categories": [
            {
              "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/21779-285x380.jpg",
              "id": "21779",
              "name": "League of Legends",
              "slug": "league-of-legends"
            }
          ],
          "is_cancelled": false,
          "repeat_ends_after_count": 1,
          "scheduled_end_at": "2026-11-06T06:30:00Z",
          "vacation": null
        }
      },
      "post_id": null,
      "scheduled_start_at": "2026-11-05T20:30:00Z",
      "started_at": null,
      "status": "scheduled",
      "streams": [],
      "text": null,
      "thumbnail_url": null,
      "title": "Worlds 2026 | Knockout Stage Day 3",
      "unknown_fields": [],
      "url": "https://www.twitch.tv/riotgames/schedule"
    },
    {
      "approximate_fields": [],
      "category": "League of Legends",
      "ended_at": null,
      "host": {
        "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/35b02a12-d516-499e-90f8-7899f136fa18-profile_image-300x300.png",
        "display_name": "Riot Games",
        "id": "36029255",
        "is_verified": true,
        "url": "https://www.twitch.tv/riotgames",
        "username": "riotgames"
      },
      "id": "eyJzZWdtZW50SUQiOiI0NDExNTQwOC1iZDYyLTRkZjktOTVmYy1iYTRiNzFjM2NhMDYiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjo0NX0=",
      "metrics": {
        "concurrent_viewer_count": null,
        "like_count": null,
        "view_count": null
      },
      "platform": "twitch",
      "platform_specific": {
        "twitch": {
          "base_segment_id": "44115408-bd62-4df9-95fc-ba4b71c3ca06",
          "cancellation_ends_at": null,
          "categories": [
            {
              "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/21779-285x380.jpg",
              "id": "21779",
              "name": "League of Legends",
              "slug": "league-of-legends"
            }
          ],
          "is_cancelled": false,
          "repeat_ends_after_count": 1,
          "scheduled_end_at": "2026-11-07T06:30:00Z",
          "vacation": null
        }
      },
      "post_id": null,
      "scheduled_start_at": "2026-11-06T20:30:00Z",
      "started_at": null,
      "status": "scheduled",
      "streams": [],
      "text": null,
      "thumbnail_url": null,
      "title": "Worlds 2026 | Knockout Stage Day 4",
      "unknown_fields": [],
      "url": "https://www.twitch.tv/riotgames/schedule"
    },
    {
      "approximate_fields": [],
      "category": "League of Legends",
      "ended_at": null,
      "host": {
        "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/35b02a12-d516-499e-90f8-7899f136fa18-profile_image-300x300.png",
        "display_name": "Riot Games",
        "id": "36029255",
        "is_verified": true,
        "url": "https://www.twitch.tv/riotgames",
        "username": "riotgames"
      },
      "id": "eyJzZWdtZW50SUQiOiI4MDAzOGYzMC04Y2QzLTQ5ZGYtODhjYi1kMmJkZmViYWQ0MGUiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjo0NX0=",
      "metrics": {
        "concurrent_viewer_count": null,
        "like_count": null,
        "view_count": null
      },
      "platform": "twitch",
      "platform_specific": {
        "twitch": {
          "base_segment_id": "80038f30-8cd3-49df-88cb-d2bdfebad40e",
          "cancellation_ends_at": null,
          "categories": [
            {
              "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/21779-285x380.jpg",
              "id": "21779",
              "name": "League of Legends",
              "slug": "league-of-legends"
            }
          ],
          "is_cancelled": false,
          "repeat_ends_after_count": 1,
          "scheduled_end_at": "2026-11-08T06:30:00Z",
          "vacation": null
        }
      },
      "post_id": null,
      "scheduled_start_at": "2026-11-07T20:30:00Z",
      "started_at": null,
      "status": "scheduled",
      "streams": [],
      "text": null,
      "thumbnail_url": null,
      "title": "Worlds 2026 | Knockout Stage Day 5",
      "unknown_fields": [],
      "url": "https://www.twitch.tv/riotgames/schedule"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "c1.EXAMPLE_CURSOR",
    "next_cursor_expires_at": "2026-10-26T12:00:00Z",
    "end_reason": null
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "twitch",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 287,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "profile",
      "id": "36029255",
      "url": "https://www.twitch.tv/riotgames"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}

Long arrays and strings are shortened for display; real responses are complete.

Authorizations

x-api-keystringheaderrequired

Your API key. Authentication

Query parameters

handlestringrequiredmax 2,048 chars

The Twitch channel: its login with or without the @ (riotgames), a channel link (twitch.tv/riotgames/schedule), or its numeric ID (36029255). A bare number is read as the ID: a login of digits only is written with its @ (@12345).

Exampleriotgames

limitintegermin 1max 50

Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.

Example50

cursorstring

page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.

handle takes Twitch profile links; another kind of link, or another platform's, fails free with invalid_input. Unknown parameters are rejected with a suggestion, never ignored (Requests). limit and cursor page through the list: see Pagination.

Parameters every endpoint accepts
max_ageintegermin 0

Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent.

fieldsstring

Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole.

Response

application/json

200

{data, page, meta}. data is an array of up to 50 live objects, Soonest first, a week per page; page says how to get the next page; meta describes the request (meta). Fields only Twitch has are under platform_specific.twitch.

platformstring

Platform ID (tiktok, youtube, …).

idstring

Platform-native ID of the broadcast (string; TikTok room ID, YouTube video ID).

urlstring uri

Public page of the broadcast (TikTok: the host's LIVE page, tiktok.com/@<username>/live).

statusstring

live: on air now; scheduled: announced, not started; ended: over. New values may be added; treat an unknown value as not live.

One oflivescheduledended

titlestringnullable

The broadcast's title as the host set it.

textstringnullable

Description as plain text; null where the platform has none.

categorystringnullable

The topic or game the broadcast is filed under, as the platform names it.

hostobject

The broadcasting account.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

started_atstring date-timenullable

When the broadcast went on air, RFC 3339 UTC; null while scheduled or when not shown.

ended_atstring date-timenullable

When it went off air, RFC 3339 UTC; null while live or scheduled, and when the platform does not say.

scheduled_start_atstring date-timenullable

When a scheduled broadcast is due to start, RFC 3339 UTC; null when none was announced.

thumbnail_urlstring urinullable

Cover or preview image URL. Platform CDN URLs can expire within hours.

post_idstringnullable

ID of the post the platform keeps the broadcast as (equals post.id: a YouTube or Rumble video); null when it keeps none (TikTok LIVE) or none yet.

streamsobject[]

Playback links of the broadcast while live, one per rendition and format, best first; [] when not live or when the platform's links only work from SocialTap's network (YouTube).

ShowHide 9 child fields
qualitystringnullable

The platform's label for the rendition (Original, 1080p60, 720p, …).

formatstring

Delivery format of url: hls (an .m3u8 playlist), dash (an .mpd manifest, TikTok's CMAF) or flv (HTTP-FLV). New values may be added; treat unknown values as other.

One ofhlsdashflv

urlstring uri

Playback URL, signed and expiring: see expires_at.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown.

widthintegernullable

Width in pixels; null for audio-only or when not stated.

heightintegernullable

Height in pixels; null for audio-only or when not stated.

video_codecstringnullable

Video codec, lowercase (h264, h265); null for audio-only or when not stated.

bitrate_kbpsintegernullable

Target bitrate in kbit/s, when the platform states it.

is_audio_onlybooleannullable

The rendition carries sound only.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 3 child fields
concurrent_viewer_countintegernullable

People watching now; null when not live or not shown.

view_countintegernullable

Cumulative views since the broadcast began (TikTok counts entries into the room).

like_countintegernullable

Likes or hearts; null when hidden or not exposed.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 1 child field
twitchobjectnullable

A Twitch broadcast's own fields.

ShowHide 7 child fields
scheduled_end_atstring date-timenullable

When the scheduled broadcast is due to end, RFC 3339 UTC; null when the channel set no end.

is_cancelledbooleannullable

True when the channel cancelled this slot. Twitch still lists it, and its status stays scheduled.

cancellation_ends_atstring date-timenullable

When the cancellation of this slot lapses, RFC 3339 UTC; null when it is not cancelled.

base_segment_idstringnullable

Twitch's ID of the recurring slot, the same every week; id names this week's occurrence.

categoriesobject[]

What the slot is filed under, whose first name is category; [] when the channel set none.

ShowHide 4 child fields
idstringnullable

Twitch's ID of the category.

namestringnullable

Its name (Just Chatting).

slugstringnullable

Its name in links (twitch.tv/directory/category/just-chatting).

box_art_urlstring urinullable

The category's cover image.

repeat_ends_after_countintegernullable

How many times the slot airs before it stops repeating: 1 is a one-off. 0 or null: the channel set no end, and it repeats every week.

vacationobjectnullable

The channel's latest break from its schedule, as Twitch keeps it: it can be long over. Null when it has none.

ShowHide 3 child fields
start_atstring date-timenullable

When the break starts, RFC 3339 UTC.

end_atstring date-timenullable

When the break ends, RFC 3339 UTC.

reasonstringnullable

Twitch's word for the break, lowercase (vacation).

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text. A list path means the list may be incomplete. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.

not_found, private_or_unavailable and no_live are item-level: the request was fine, the item can't be returned.

400

400 Bad Request: 2 error codes. Free: errors cost nothing.

invalid_inputNo retry

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

invalid_cursorNo retry

The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized: 1 error code. Free: errors cost nothing.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

402

402 Payment Required: 2 error codes. Free: errors cost nothing.

insufficient_creditsNo retry

The account does not have enough credits for this request.

Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.

spend_limit_reachedNo retry

The API key reached its spend limit for this period. The account may still have credits.

Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically.

403

403 Forbidden: 2 error codes. Free: errors cost nothing.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

private_or_unavailableNo retry

The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.

Only public items can be fetched. Do not retry.

404

404 Not Found: 1 error code. Free: errors cost nothing.

not_foundNo retry

The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).

Check the link or ID. Do not retry.

429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

500

500 Internal Error: 1 error code. Free: errors cost nothing.

internalYes, later

An unexpected error on SocialTap's side.

Retry with backoff. If it keeps happening, contact support with the request_id.

502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

upstream_errorYes, later

The platform failed, or answered with something we could not read.

Retry with backoff. Failed requests are free.

503

503 Unavailable: 2 error codes. Free: errors cost nothing.

upstream_blockedYes, later

The platform refused every attempt, our own retries included.

Retry later with backoff. Failed requests are free.

overloadedYes, later

SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.

Retry after the seconds in the retry-after header. Failed requests are free.

Pagination

Items come in pages, soonest first, a week per page. To get the next page, send the same request plus cursor set to page.next_cursor from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When page.has_more is false the walk is over, and page.end_reason says why: only end means you have every item (the others say the platform or a page cap stopped the walk early).

Order
Soonest first, a week per page
Page size
Up to 50 upcoming streams (the default; limit lowers it)
Cursor lifetime
24 hours; don't store cursors
Price
Per page, 1 credit

The page object

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

Next page

cURL: next page
curl 'https://socialtap.dev/v1/twitch/schedule?handle=riotgames&cursor=c1.EXAMPLE_CURSOR' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
  • The price is per page: each successful page costs the same, whatever limit is and however many items it has. Empty pages are charged too (an empty page with has_more: true is not the end).
  • A limit below 50 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omitting limit is the cheapest way to walk the list.
  • Errors are free, including a rejected cursor.
  • Pages served from the cache are free.
  • An expired or altered cursor, or one sent with different parameters, fails with invalid_cursor (HTTP 400): Repeat the original request without cursor to start the list again.

Pagination guide

Pricing

From 1 credit per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as meta.source.

SourcePrice per successful pagePer 1,000 pages
Platform API api1 credit$0.75–$1.97
Balance, sources and what you were charged

Your balance must be at least 1 credit to start a request; with less, it is refused with insufficient_credits (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

meta.sourceSourceWhat it means
apiPlatform APIThe platform's public, logged-out API.

meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs

Endpoint ID twitch.schedule · operationId twitch.schedule.list · Product overview

Last updated