SocialScrape
Get early access
Docs menu

Get started

Guides

API reference

Resources

Twitch stream schedule

Beta GET /v1/twitch/user/schedule

GET /v1/twitch/user/schedule

A channel's scheduled streams: start and end time, title, categories and whether a stream is cancelled.

  • Cost: 1 credit
  • Status: Beta. Built and tested against recorded responses; the shape may still gain fields.
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
handlestringyesUsername, with or without the leading @. Also accepted as username.

Every request also accepts:

  • cursor: the cursor from the previous page (Pagination).
  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

curl
curl -G "https://api.socialscrape.io/v1/twitch/user/schedule" \
  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \
  --data-urlencode "handle=emongg"
Python
import os
import requests

params = {
    "handle": "emongg",
}
res = requests.get(
    "https://api.socialscrape.io/v1/twitch/user/schedule",
    headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},
    params=params,
)
body = res.json()

if body["ok"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
TypeScript
const url = new URL("https://api.socialscrape.io/v1/twitch/user/schedule");
url.search = new URLSearchParams({
  "handle": "emongg"
}).toString();
const res = await fetch(url, {
  headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },
});
const body = await res.json();

if (body.ok) {
  console.log(body.data);
} else {
  console.error(body.error.code, body.error.message);
}
n8n
{
  "nodes": [
    {
      "name": "SocialScrape Twitch stream schedule",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        0,
        0
      ],
      "parameters": {
        "method": "GET",
        "url": "https://api.socialscrape.io/v1/twitch/user/schedule",
        "sendQuery": true,
        "queryParameters": {
          "parameters": [
            {
              "name": "handle",
              "value": "emongg"
            }
          ]
        },
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "x-api-key",
              "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"
            }
          ]
        }
      }
    }
  ],
  "connections": {}
}

Example response#

This is a sample from a recorded response, lists and long text are shortened. Status 200.

{
  "ok": true,
  "credits_charged": 1,
  "credits_remaining": 4999,
  "cached": false,
  "cached_at": null,
  "request_id": "req_8ce64d88b98dd33d843403c3",
  "data": {
    "object": "list",
    "items": [
      {
        "object": "event",
        "platform": "twitch",
        "id": "eyJzZWdtZW50SUQiOiI4ZThhMTczMS1hYjU0LTQxZDMtOTEzMy02N2JjZTM0NTRiMzUiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjo0M30=",
        "url": "https://www.twitch.tv/emongg/schedule",
        "title": null,
        "description": null,
        "starts_at": "2026-10-25T11:00:00Z",
        "ends_at": "2026-10-25T21:00:00Z",
        "place": {
          "name": "Twitch",
          "address": null,
          "city": null,
          "region": null,
          "country": null,
          "latitude": null,
          "longitude": null
        },
        "is_online": true,
        "host": {
          "id": "23220337",
          "handle": "emongg",
          "name": "Emongg",
          "url": "https://www.twitch.tv/emongg",
          "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/76e05185-d15d-4818-9267-1806b05fa2d1-profile_image-300x300.png",
          "verified": null
        },
        "going_count": null,
        "interested_count": null,
        "cover_url": null,
        "extra": {
          "is_cancelled": false
        }
      },
      {
        "object": "event",
        "platform": "twitch",
        "id": "eyJzZWdtZW50SUQiOiI5NjU1NWMwMC03OGZkLTQ4NTQtYTIyZS1kYWNjOGU3ZWZlYzkiLCJpc29ZZWFyIjoyMDI2LCJpc29XZWVrIjo0NH0=",
        "url": "https://www.twitch.tv/emongg/schedule",
        "title": null,
        "description": null,
        "starts_at": "2026-10-26T11:00:00Z",
        "ends_at": "2026-10-26T21:00:00Z",
        "place": {
          "name": "Twitch",
          "address": null,
          "city": null,
          "region": null,
          "country": null,
          "latitude": null,
          "longitude": null
        },
        "is_online": true,
        "host": {
          "id": "23220337",
          "handle": "emongg",
          "name": "Emongg",
          "url": "https://www.twitch.tv/emongg",
          "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/76e05185-d15d-4818-9267-1806b05fa2d1-profile_image-300x300.png",
          "verified": null
        },
        "going_count": null,
        "interested_count": null,
        "cover_url": null,
        "extra": {
          "is_cancelled": false
        }
      }
    ],
    "cursor": null,
    "has_more": false,
    "parent": {
      "object": "profile",
      "platform": "twitch",
      "id": "23220337",
      "handle": "emongg",
      "name": "Emongg",
      "headline": null,
      "url": "https://www.twitch.tv/emongg",
      "kind": "channel",
      "bio": null,
      "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/76e05185-d15d-4818-9267-1806b05fa2d1-profile_image-300x300.png",
      "banner_url": null,
      "verified": null,
      "is_private": null,
      "external_url": null,
      "links": null,
      "location": null,
      "category": null,
      "created_at": null,
      "stats": {
        "followers": null,
        "following": null,
        "posts": null,
        "likes": null,
        "views": null
      },
      "extra": null
    }
  },
  "cursor": null,
  "has_more": false
}

Response#

A list of Event objects in data.items, with data.cursor and data.has_more.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.