# Twitch Videos API

Twitch

Returns a public Twitch channel's past broadcasts, highlights and uploads, newest or most viewed first, from its login, link or numeric ID. Each video has its link, signed playlist, title, description, publish time, length, exact views, language, thumbnail and storyboard, its category, whether it is still recording or kept from logged-out viewers, Twitch's content labels, and the channel that made it.

GET `/v1/twitch/videos`

## Example

cURL:

```shell
curl 'https://socialtap.dev/v1/twitch/videos?handle=ninja' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

TypeScript SDK:

```typescript
import { SocialTap } from "socialtap";

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

const res = await client.twitch.videos.list({ handle: "ninja" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
const params = new URLSearchParams({
  handle: "ninja",
});
const res = await fetch(`https://socialtap.dev/v1/twitch/videos?${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):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/twitch/videos",
    params={"handle": "ninja"},
    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):

```go
package main

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

func main() {
	q := url.Values{}
	q.Set("handle", "ninja")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/twitch/videos?"+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"])
}
```

200 OK:

```json
{
  "data": [
    {
      "approximate_fields": [],
      "author": {
        "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/90d40495-f467-4911-9035-72d8d10a49c5-profile_image-300x300.png",
        "display_name": "Ninja",
        "id": "19571641",
        "is_verified": true,
        "url": "https://www.twitch.tv/ninja",
        "username": "ninja"
      },
      "coauthors": [],
      "duration_ms": 7726000,
      "hashtags": [],
      "id": "2918964242",
      "is_nsfw": false,
      "is_pinned": null,
      "is_sponsored": null,
      "language": "en",
      "media": [
        {
          "alt_text": null,
          "duration_ms": 7726000,
          "expires_at": "2026-11-06T01:53:41Z",
          "height": null,
          "thumbnail_url": "https://static-cdn.jtvnw.net/cf_vods/d1m7jfoe9zdc1j/3a618d76bb26843ecc3f_ninja_322129789658_1793756098//thumb/thumb0-1280x720.jpg",
          "type": "video",
          "url": "https://usher.ttvnw.net/vod/2918964242.m3u8?allow_audio_only=true&allow_source=true&player=twitchweb&playlist_include_framerate=true&sig=SCRUBBED&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22chansub%22%3A%7B%22restricted_bitrates%22%3A…",
          "width": null
        }
      ],
      "mentions": [],
      "metrics": {
        "comment_count": null,
        "like_count": null,
        "quote_count": null,
        "repost_count": null,
        "save_count": null,
        "share_count": null,
        "view_count": 34782
      },
      "platform": "twitch",
      "platform_specific": {
        "twitch": {
          "animated_preview_url": "https://d1m7jfoe9zdc1j.cloudfront.net/3a618d76bb26843ecc3f_ninja_322129789658_1793756098/storyboards/2918964242-strip-0.jpg",
          "author_follower_count": null,
          "broadcast_id": null,
          "broadcast_type": "archive",
          "category": {
            "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/509658-285x380.jpg",
            "id": "509658",
            "name": "Just Chatting",
            "slug": "just-chatting"
          },
          "chapters": [],
          "clip_id": null,
          "clipped_by": null,
          "content_labels": [],
          "deletes_at": null,
          "embed_url": null,
          "is_featured": null,
          "is_recording": false,
          "is_restricted": false,
          "renditions": [],
          "source_video": null,
          "vertical_renditions": []
        }
      },
      "platform_type": "live",
      "published_at": "2026-11-04T01:35:03Z",
      "text": null,
      "thumbnail_url": "https://static-cdn.jtvnw.net/cf_vods/d1m7jfoe9zdc1j/3a618d76bb26843ecc3f_ninja_322129789658_1793756098//thumb/thumb0-1280x720.jpg",
      "title": "BLEV BROS SPORTS SHOW WEEK 8 RECAP | GO LIONS | PRAYERS FOR JACK CAMPBELL",
      "type": "video",
      "unknown_fields": [
        "platform_specific.twitch.chapters"
      ],
      "url": "https://www.twitch.tv/videos/2918964242"
    },
    {
      "approximate_fields": [],
      "author": {
        "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/90d40495-f467-4911-9035-72d8d10a49c5-profile_image-300x300.png",
        "display_name": "Ninja",
        "id": "19571641",
        "is_verified": true,
        "url": "https://www.twitch.tv/ninja",
        "username": "ninja"
      },
      "coauthors": [],
      "duration_ms": 7641000,
      "hashtags": [],
      "id": "2912661812",
      "is_nsfw": false,
      "is_pinned": null,
      "is_sponsored": null,
      "language": "en",
      "media": [
        {
          "alt_text": null,
          "duration_ms": 7641000,
          "expires_at": "2026-11-06T01:53:41Z",
          "height": null,
          "thumbnail_url": "https://static-cdn.jtvnw.net/cf_vods/d1m7jfoe9zdc1j/a4420620c79ca00ab677_ninja_321991442137_1793147635//thumb/thumb0-1280x720.jpg",
          "type": "video",
          "url": "https://usher.ttvnw.net/vod/2912661812.m3u8?allow_audio_only=true&allow_source=true&player=twitchweb&playlist_include_framerate=true&sig=SCRUBBED&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22chansub%22%3A%7B%22restricted_bitrates%22%3A…",
          "width": null
        }
      ],
      "mentions": [],
      "metrics": {
        "comment_count": null,
        "like_count": null,
        "quote_count": null,
        "repost_count": null,
        "save_count": null,
        "share_count": null,
        "view_count": 53518
      },
      "platform": "twitch",
      "platform_specific": {
        "twitch": {
          "animated_preview_url": "https://d1m7jfoe9zdc1j.cloudfront.net/a4420620c79ca00ab677_ninja_321991442137_1793147635/storyboards/2912661812-strip-0.jpg",
          "author_follower_count": null,
          "broadcast_id": null,
          "broadcast_type": "archive",
          "category": {
            "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/509658-285x380.jpg",
            "id": "509658",
            "name": "Just Chatting",
            "slug": "just-chatting"
          },
          "chapters": [],
          "clip_id": null,
          "clipped_by": null,
          "content_labels": [],
          "deletes_at": null,
          "embed_url": null,
          "is_featured": null,
          "is_recording": false,
          "is_restricted": false,
          "renditions": [],
          "source_video": null,
          "vertical_renditions": []
        }
      },
      "platform_type": "live",
      "published_at": "2026-10-28T00:34:00Z",
      "text": null,
      "thumbnail_url": "https://static-cdn.jtvnw.net/cf_vods/d1m7jfoe9zdc1j/a4420620c79ca00ab677_ninja_321991442137_1793147635//thumb/thumb0-1280x720.jpg",
      "title": "BLEV BROS SPORTS SHOW WEEK 7 RECAP",
      "type": "video",
      "unknown_fields": [
        "platform_specific.twitch.chapters"
      ],
      "url": "https://www.twitch.tv/videos/2912661812"
    },
    {
      "approximate_fields": [],
      "author": {
        "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/90d40495-f467-4911-9035-72d8d10a49c5-profile_image-300x300.png",
        "display_name": "Ninja",
        "id": "19571641",
        "is_verified": true,
        "url": "https://www.twitch.tv/ninja",
        "username": "ninja"
      },
      "coauthors": [],
      "duration_ms": 998000,
      "hashtags": [],
      "id": "2909042011",
      "is_nsfw": false,
      "is_pinned": null,
      "is_sponsored": null,
      "language": "en",
      "media": [
        {
          "alt_text": null,
          "duration_ms": 998000,
          "expires_at": "2026-11-06T01:53:41Z",
          "height": null,
          "thumbnail_url": "https://static-cdn.jtvnw.net/cf_vods/d1m7jfoe9zdc1j/65503c51b8da69e7b122_ninja_321934738265_1792803422//thumb/thumb0-1280x720.jpg",
          "type": "video",
          "url": "https://usher.ttvnw.net/vod/2909042011.m3u8?allow_audio_only=true&allow_source=true&player=twitchweb&playlist_include_framerate=true&sig=SCRUBBED&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22chansub%22%3A%7B%22restricted_bitrates%22%3A…",
          "width": null
        }
      ],
      "mentions": [],
      "metrics": {
        "comment_count": null,
        "like_count": null,
        "quote_count": null,
        "repost_count": null,
        "save_count": null,
        "share_count": null,
        "view_count": 14940
      },
      "platform": "twitch",
      "platform_specific": {
        "twitch": {
          "animated_preview_url": "https://d1m7jfoe9zdc1j.cloudfront.net/65503c51b8da69e7b122_ninja_321934738265_1792803422/storyboards/2909042011-strip-0.jpg",
          "author_follower_count": null,
          "broadcast_id": null,
          "broadcast_type": "archive",
          "category": {
            "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/1264310518_IGDB-285x380.jpg",
            "id": "1264310518",
            "name": "Marvel Rivals",
            "slug": "marvel-rivals"
          },
          "chapters": [],
          "clip_id": null,
          "clipped_by": null,
          "content_labels": [],
          "deletes_at": null,
          "embed_url": null,
          "is_featured": null,
          "is_recording": false,
          "is_restricted": false,
          "renditions": [],
          "source_video": null,
          "vertical_renditions": []
        }
      },
      "platform_type": "live",
      "published_at": "2026-10-24T00:57:07Z",
      "text": null,
      "thumbnail_url": "https://static-cdn.jtvnw.net/cf_vods/d1m7jfoe9zdc1j/65503c51b8da69e7b122_ninja_321934738265_1792803422//thumb/thumb0-1280x720.jpg",
      "title": "CHECKING OUT THE BRAND NEW MARVEL RIVALS UPDATE WITH TIMMY TONKA TENDERS",
      "type": "video",
      "unknown_fields": [
        "platform_specific.twitch.chapters"
      ],
      "url": "https://www.twitch.tv/videos/2909042011"
    }
  ],
  "page": {
    "has_more": false,
    "next_cursor": null,
    "next_cursor_expires_at": null,
    "end_reason": "platform_limit"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "twitch",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 407,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "profile",
      "id": "19571641",
      "url": "https://www.twitch.tv/ninja"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

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

> [!NOTE]
>
> **Good to know**
>
> - Each list stops at its first 100 videos (all or one type, newest or most viewed), because Twitch refuses anonymous requests past them with an integrity check. A list that goes on ends there with page.end_reason platform_limit. To read more of a channel, ask for each type and both sorts.
> - Newest orders by when Twitch made each video, and published_at can be later on a highlight or an upload, so only type=archive is strictly by published_at. There, since ends the walk. On the other types, since and until filter the page.
> - text is the video's description, which most past broadcasts don't have, and is null then.
> - is_nsfw is true when Twitch marks the video with any content classification label but politics and sensitive social issues, such as a mature-rated game, gambling, drugs, violence or sexual themes. platform_specific.twitch.content_labels lists them all in Twitch's own words.
> - media\[0\].url is the video's playlist (HLS, every quality Twitch gives a logged-out viewer and audio only), signed, and works from any network until expires_at, which is less than a day away, so fetch a fresh one rather than store it. A cached answer keeps the links it was fetched with, so a max_age longer than that can return expired links.
> - A video Twitch keeps from logged-out viewers, usually for the channel's subscribers, returns every other field, with platform_specific.twitch.is_restricted true and media\[0\].url null.
> - A channel with no videos returns an empty page, one Twitch has taken down returns private_or_unavailable, and a name nobody holds, or a channel its owner closed, returns not_found.
> - If Twitch's API is down, the channel's Videos page can answer type=all, newest, by login: its latest few videos, with no type, category, labels, playlist or is_restricted, and views as of when Twitch last drew the page (metrics.view_count in approximate_fields).

## Authorizations

`x-api-key`stringheaderrequired

Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `handle` required | `string`<br>max 2,048 chars | The Twitch channel: its login with or without the @ (ninja), a channel link with any tab after it (twitch.tv/ninja/videos), or its numeric ID (19571641). A bare number is read as the ID: a login of digits only is written with its @ (@12345). | `ninja` |
| `type` optional | `string` | Which videos: all (default), archive (past broadcasts), highlight (cut from a broadcast by the channel) or upload. Twitch keeps past broadcasts for a limited time, so a channel can have none.<br>One of `all`, `archive`, `highlight`, `upload` | `highlight` |
| `sort` optional | `string` | Order of the results. newest (default): the latest video first. popular: the most viewed first, of all time.<br>One of `newest`, `popular` | — |
| `since` optional | `string`<br>date-time | Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged. Only videos published at or after this time. On past broadcasts (type=archive), newest first, the walk ends when it is reached; on anything else it filters the page. | `2026-10-01` |
| `until` optional | `string`<br>date-time | Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). Only videos published before this time. It filters the page. | `2026-10-08` |
| `limit` optional | `integer`<br>min 1<br>max 100 | 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. | `100` |
| `cursor` optional | `string` | 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`](https://socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)). `limit` and `cursor` page through the list: see Pagination.

**Parameters every endpoint accepts**

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>min 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. | — |
| `fields` optional | `string` | 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

### 200

`{data, page, meta}`. `data` is an array of up to 100 [post](https://socialtap.dev/resources/post/index.md) objects, newest first; `page` says how to get the next page; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only Twitch has are under `platform_specific.twitch`.

| Field | Type | Description |
| --- | --- | --- |
| `data[].platform` | `string` | Platform ID (tiktok, youtube, …). |
| `data[].id` | `string` | Platform-native post ID (string; Instagram shortcode, Reddit with its t3_ prefix). |
| `data[].url` | `string` (uri) | Canonical post URL. |
| `data[].type` | `string` | Normalized content shape. New values may be added; treat unknown values as other.<br>One of `video`, `image`, `carousel`, `text`, `link`, `audio` |
| `data[].platform_type` | `string` or `null` | The platform's own product label, lowercase (reel, short, story, live, tweet, …). |
| `data[].title` | `string` or `null` | Headline (YouTube title, Reddit title); null on caption-only platforms. |
| `data[].text` | `string` or `null` | Caption, description or body as plain text. |
| `data[].language` | `string` or `null` | BCP-47 language of text, when the platform states it. |
| `data[].published_at` | `string` (date-time) or `null` | When the post went public, RFC 3339 UTC. |
| `data[].author` | `object` | The posting account. An account the platform no longer names (a deleted account) has a null id and username and the platform's label as display_name (Reddit: \[deleted\]). A post credited to what is no account of the platform's (an Apple Music radio episode's show) has a null id and username, and every other field null too when the platform doesn't name it. |
| `data[].author.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data[].author.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data[].author.display_name` | `string` or `null` | Display name shown on the profile. |
| `data[].author.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data[].author.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data[].author.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data[].coauthors` | `object[]` | Other accounts credited as co-authors of the post (Instagram and Facebook collabs, YouTube collaborations), in the platform's order, author excluded; \[\] if none. |
| `data[].coauthors[].id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data[].coauthors[].username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data[].coauthors[].display_name` | `string` or `null` | Display name shown on the profile. |
| `data[].coauthors[].url` | `string` (uri) or `null` | Canonical profile URL. |
| `data[].coauthors[].avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data[].coauthors[].is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data[].duration_ms` | `integer` or `null` | Length of the primary video or audio in milliseconds; null for other posts. |
| `data[].thumbnail_url` | `string` (uri) or `null` | Cover or poster image URL. |
| `data[].media` | `object[]` | Attachments in display order (carousel items); \[\] for text posts. |
| `data[].media[].type` | `string` | Kind of file. New values may be added; treat unknown values as other.<br>One of `image`, `video`, `audio`, `gif` |
| `data[].media[].url` | `string` (uri) or `null` | Direct file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at. |
| `data[].media[].expires_at` | `string` (date-time) or `null` | When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire. |
| `data[].media[].thumbnail_url` | `string` (uri) or `null` | Poster or preview image URL. |
| `data[].media[].width` | `integer` or `null` | Width in pixels. |
| `data[].media[].height` | `integer` or `null` | Height in pixels. |
| `data[].media[].duration_ms` | `integer` or `null` | Duration in milliseconds (video and audio only). |
| `data[].media[].alt_text` | `string` or `null` | Accessibility text provided by the author or platform. |
| `data[].hashtags` | `string[]` | Hashtags without #, case kept; \[\] if none. |
| `data[].mentions` | `string[]` | Mentioned or tagged usernames without @; \[\] if none. |
| `data[].is_pinned` | `boolean` or `null` | Pinned to the author's profile. |
| `data[].is_sponsored` | `boolean` or `null` | Labeled as a paid partnership or branded content. |
| `data[].is_nsfw` | `boolean` or `null` | Marked adult or sensitive by the platform. |
| `data[].metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
| `data[].metrics.view_count` | `integer` or `null` | Views or plays. |
| `data[].metrics.like_count` | `integer` or `null` | Likes, hearts, total reactions or upvotes; never negative. Null when hidden by the owner. |
| `data[].metrics.comment_count` | `integer` or `null` | Comments and replies. |
| `data[].metrics.share_count` | `integer` or `null` | Shares or sends (not reposts). |
| `data[].metrics.repost_count` | `integer` or `null` | Reposts, retweets or reshares. |
| `data[].metrics.quote_count` | `integer` or `null` | Quote posts. |
| `data[].metrics.save_count` | `integer` or `null` | Saves, bookmarks or favorites. |
| `data[].platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |
| `data[].platform_specific.twitch` | `object` or `null` | A Twitch video's or clip's own fields. |
| `data[].platform_specific.twitch.broadcast_type` | `string` or `null` | What Twitch calls this kind of video: archive (a past broadcast), highlight, upload, premiere_upload, past_premiere or clip. |
| `data[].platform_specific.twitch.category` | `object` or `null` | What it is filed under; null when nothing was set. |
| `data[].platform_specific.twitch.category.id` | `string` or `null` | Twitch's ID of the category. |
| `data[].platform_specific.twitch.category.name` | `string` or `null` | Its name (Just Chatting). |
| `data[].platform_specific.twitch.category.slug` | `string` or `null` | Its name in links (twitch.tv/directory/category/just-chatting). |
| `data[].platform_specific.twitch.category.box_art_url` | `string` (uri) or `null` | The category's cover image. |
| `data[].platform_specific.twitch.is_recording` | `boolean` or `null` | True for a past broadcast that is still being recorded because the stream is on air; null on a clip. |
| `data[].platform_specific.twitch.is_restricted` | `boolean` or `null` | True when Twitch keeps the video from logged-out viewers, usually for the channel's subscribers: its fields are still answered and media\[\].url is null. Null on a clip, and where the answer doesn't carry what says so (the video's page, when Twitch's API is down). |
| `data[].platform_specific.twitch.content_labels` | `string[]` | Twitch's content classification labels, its own IDs in its order (MatureGame, Gambling, DebatedSocialIssuesAndPolitics): is_nsfw is true on any of them but politics. \[\] when it has none, and listed in unknown_fields where the answer doesn't have them. |
| `data[].platform_specific.twitch.deletes_at` | `string` (date-time) or `null` | When Twitch will delete the video: past broadcasts expire, RFC 3339 UTC. Null when none is set (highlights and uploads stay) and on a clip. |
| `data[].platform_specific.twitch.animated_preview_url` | `string` (uri) or `null` | An image holding frames of the video one above the other, which Twitch's site animates as its preview; null on a clip and while the video is still recording. On an old video the file itself can be gone. |
| `data[].platform_specific.twitch.chapters` | `object[]` | The parts of a video by category, in order, as Twitch marks them; \[\] when it marks none and on a clip, and listed in unknown_fields where the answer doesn't have them. |
| `data[].platform_specific.twitch.chapters[].title` | `string` or `null` | What Twitch shows for it: the category's name. |
| `data[].platform_specific.twitch.chapters[].position_ms` | `integer` or `null` | Where in the video it starts, in milliseconds. |
| `data[].platform_specific.twitch.chapters[].duration_ms` | `integer` or `null` | How long it lasts, in milliseconds; null on the last part of a broadcast still on air. |
| `data[].platform_specific.twitch.chapters[].category` | `object` or `null` | The category; null when Twitch doesn't say. |
| `data[].platform_specific.twitch.chapters[].category.id` | `string` or `null` | Twitch's ID of the category. |
| `data[].platform_specific.twitch.chapters[].category.name` | `string` or `null` | Its name (Just Chatting). |
| `data[].platform_specific.twitch.chapters[].category.slug` | `string` or `null` | Its name in links (twitch.tv/directory/category/just-chatting). |
| `data[].platform_specific.twitch.chapters[].category.box_art_url` | `string` (uri) or `null` | The category's cover image. |
| `data[].platform_specific.twitch.clip_id` | `string` or `null` | Twitch's number for a clip. Its links take the slug, which is id; null on a video. |
| `data[].platform_specific.twitch.embed_url` | `string` (uri) or `null` | The clip's embeddable player; null on a video. |
| `data[].platform_specific.twitch.is_featured` | `boolean` or `null` | True when the channel features the clip; null on a video. |
| `data[].platform_specific.twitch.clipped_by` | `object` or `null` | The account that made the clip; author is the channel it was clipped from. Null on a video, and when Twitch no longer names the account. |
| `data[].platform_specific.twitch.clipped_by.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data[].platform_specific.twitch.clipped_by.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data[].platform_specific.twitch.clipped_by.display_name` | `string` or `null` | Display name shown on the profile. |
| `data[].platform_specific.twitch.clipped_by.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data[].platform_specific.twitch.clipped_by.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data[].platform_specific.twitch.clipped_by.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data[].platform_specific.twitch.broadcast_id` | `string` or `null` | Twitch's ID of the broadcast the clip was cut from; null on a video. |
| `data[].platform_specific.twitch.source_video` | `object` or `null` | The past broadcast the clip was cut from; null on a video, and when Twitch no longer keeps it. |
| `data[].platform_specific.twitch.source_video.id` | `string` or `null` | The video's number. |
| `data[].platform_specific.twitch.source_video.url` | `string` (uri) or `null` | The video's page. |
| `data[].platform_specific.twitch.source_video.title` | `string` or `null` | The video's title. |
| `data[].platform_specific.twitch.source_video.offset_ms` | `integer` or `null` | Where in the video the clip starts, in milliseconds; null when Twitch doesn't say. |
| `data[].platform_specific.twitch.author_follower_count` | `integer` or `null` | The channel's followers at fetch time, when the answer has them. |
| `data[].platform_specific.twitch.renditions` | `object[]` | The clip's files, one per quality, best first; media\[0\] is the first. \[\] on a video, and listed in unknown_fields where a source doesn't see them. |
| `data[].platform_specific.twitch.renditions[].quality` | `string` or `null` | Twitch's name for the quality: the height in pixels (1080). |
| `data[].platform_specific.twitch.renditions[].frame_rate` | `number` or `null` | Frames per second, when Twitch states it. |
| `data[].platform_specific.twitch.renditions[].url` | `string` (uri) | The MP4 file, signed and expiring: see expires_at. |
| `data[].platform_specific.twitch.renditions[].expires_at` | `string` (date-time) or `null` | When url stops working, RFC 3339 UTC, read from Twitch's signed token; null when unknown. |
| `data[].platform_specific.twitch.vertical_renditions` | `object[]` | The files of the clip's vertical version, where it has one, best first; \[\] when it has none and on a video, and listed in unknown_fields where a source doesn't see them. |
| `data[].platform_specific.twitch.vertical_renditions[].quality` | `string` or `null` | Twitch's name for the quality: the height in pixels (1080). |
| `data[].platform_specific.twitch.vertical_renditions[].frame_rate` | `number` or `null` | Frames per second, when Twitch states it. |
| `data[].platform_specific.twitch.vertical_renditions[].url` | `string` (uri) | The MP4 file, signed and expiring: see expires_at. |
| `data[].platform_specific.twitch.vertical_renditions[].expires_at` | `string` (date-time) or `null` | When url stops working, RFC 3339 UTC, read from Twitch's signed token; null when unknown. |
| `data[].approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text. A list path (external_links) means the list may be incomplete. \[\] when all exact. |
| `data[].unknown_fields` | `string[]` | 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 and private_or_unavailable are item-level: the request was fine, the item can't be returned.

### 400

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

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | 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_cursor` | 400 | No | 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | 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_reached` | 402 | No | 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | 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](mailto:support@socialtap.dev). 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_unavailable` | 403 | No | 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, 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](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

### 500

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

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. |

### 502

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

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_error` | 502 | Yes, 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. |
| `overloaded` | 503 | Yes, 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, **newest first**. 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**: `sort=newest` (the default): newest first; `sort=popular`: Twitch's most viewed first, of all time
- **Page size**: Up to 100 past broadcasts, highlights and uploads (the default; `limit` lowers it)
- **Cursor lifetime**: 1 hour; don't store cursors
- **Price**: Per page, 1 credit

### The `page` object

| Field | Type | Description |
| --- | --- | --- |
| `page.has_more` | `boolean` | True when another page exists; then next_cursor is set. An empty page with has_more true is not the end. |
| `page.next_cursor` | `string` or `null` | Pass as cursor, with the same other parameters, to get the next page; null at the end. |
| `page.next_cursor_expires_at` | `string` (date-time) or `null` | When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors. |
| `page.end_reason` | `string` or `null` | 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.<br>One of `end`, `platform_limit`, `max_pages` |

### Next page

cURL: next page:

```shell
curl 'https://socialtap.dev/v1/twitch/videos?handle=ninja&cursor=NEXT_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 100 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`](https://socialtap.dev/docs/errors/index.md#invalid_cursor) (HTTP 400): Repeat the original request without cursor to start the list again.

[Pagination guide](https://socialtap.dev/docs/pagination/index.md)

## 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`; sources are tried cheapest first: Platform API → Public page.

| Source | Price per successful page | Per 1,000 pages |
| --- | --- | --- |
| Any source | 1 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`](https://socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

| meta.source | Source | What it means |
| --- | --- | --- |
| `api` | Platform API | The platform's public, logged-out API. |
| `page` | Public page | Data embedded in the platform's public web page. |

`meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md)

Endpoint ID `twitch.videos` · operationId `twitch.videos.list` · [Product overview](https://socialtap.dev/apis/twitch/videos/index.md)

---

[HTML version](https://socialtap.dev/docs/reference/twitch/videos/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)