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

Try it

Example

cURL
curl 'https://socialtap.dev/v1/twitch/videos?handle=ninja' \
  -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.videos.list({ handle: "ninja" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
Node.js (fetch)
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)
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)
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"])
}
PHP
<?php

$query = http_build_query([
    'handle' => 'ninja',
]);
$ch = curl_init('https://socialtap.dev/v1/twitch/videos?' . $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/videos")
uri.query = URI.encode_www_form('handle' => 'ninja')
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("ninja");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/twitch/videos?" + 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("ninja"));
var res = await http.GetAsync("https://socialtap.dev/v1/twitch/videos?" + 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/videos")
        .query(&[("handle", "ninja")])
        .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": [],
      "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.

x-api-keystringheaderrequired

Your API key. Authentication

handlestringrequiredmax 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).

Exampleninja

typestring

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.

One ofallarchivehighlightupload

Examplehighlight

sortstring

Order of the results. newest (default): the latest video first. popular: the most viewed first, of all time.

One ofnewestpopular

sincestringdate-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.

Example2026-10-01

untilstringdate-time

Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). Only videos published before this time. It filters the page.

Example2026-10-08

limitintegermin 1max 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.

Example100

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 100 post objects, newest first; 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 post ID (string; Instagram shortcode, Reddit with its t3_ prefix).

urlstring uri

Canonical post URL.

typestring

Normalized content shape. New values may be added; treat unknown values as other.

One ofvideoimagecarouseltextlinkaudio

platform_typestringnullable

The platform's own product label, lowercase (reel, short, story, live, tweet, …).

titlestringnullable

Headline (YouTube title, Reddit title); null on caption-only platforms.

textstringnullable

Caption, description or body as plain text.

languagestringnullable

BCP-47 language of text, when the platform states it.

published_atstring date-timenullable

When the post went public, RFC 3339 UTC.

authorobject

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.

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.

coauthorsobject[]

Other accounts credited as co-authors of the post (Instagram and Facebook collabs, YouTube collaborations), in the platform's order, author excluded; [] if none.

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.

duration_msintegernullable

Length of the primary video or audio in milliseconds; null for other posts.

thumbnail_urlstring urinullable

Cover or poster image URL.

mediaobject[]

Attachments in display order (carousel items); [] for text posts.

ShowHide 8 child fields
typestring

Kind of file. New values may be added; treat unknown values as other.

One ofimagevideoaudiogif

urlstring urinullable

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.

expires_atstring date-timenullable

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

thumbnail_urlstring urinullable

Poster or preview image URL.

widthintegernullable

Width in pixels.

heightintegernullable

Height in pixels.

duration_msintegernullable

Duration in milliseconds (video and audio only).

alt_textstringnullable

Accessibility text provided by the author or platform.

hashtagsstring[]

Hashtags without #, case kept; [] if none.

mentionsstring[]

Mentioned or tagged usernames without @; [] if none.

is_pinnedbooleannullable

Pinned to the author's profile.

is_sponsoredbooleannullable

Labeled as a paid partnership or branded content.

is_nsfwbooleannullable

Marked adult or sensitive by the platform.

metricsobject

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

ShowHide 7 child fields
view_countintegernullable

Views or plays.

like_countintegernullable

Likes, hearts, total reactions or upvotes; never negative. Null when hidden by the owner.

comment_countintegernullable

Comments and replies.

share_countintegernullable

Shares or sends (not reposts).

repost_countintegernullable

Reposts, retweets or reshares.

quote_countintegernullable

Quote posts.

save_countintegernullable

Saves, bookmarks or favorites.

platform_specificobject

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

ShowHide 1 child field
twitchobjectnullable

A Twitch video's or clip's own fields.

ShowHide 17 child fields
broadcast_typestringnullable

What Twitch calls this kind of video: archive (a past broadcast), highlight, upload, premiere_upload, past_premiere or clip.

categoryobjectnullable

What it is filed under; null when nothing was set.

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.

is_recordingbooleannullable

True for a past broadcast that is still being recorded because the stream is on air; null on a clip.

is_restrictedbooleannullable

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).

content_labelsstring[]

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.

deletes_atstring date-timenullable

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.

animated_preview_urlstring urinullable

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.

chaptersobject[]

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.

ShowHide 4 child fields
titlestringnullable

What Twitch shows for it: the category's name.

position_msintegernullable

Where in the video it starts, in milliseconds.

duration_msintegernullable

How long it lasts, in milliseconds; null on the last part of a broadcast still on air.

categoryobjectnullable

The category; null when Twitch doesn't say.

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.

clip_idstringnullable

Twitch's number for a clip. Its links take the slug, which is id; null on a video.

embed_urlstring urinullable

The clip's embeddable player; null on a video.

is_featuredbooleannullable

True when the channel features the clip; null on a video.

clipped_byobjectnullable

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.

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.

broadcast_idstringnullable

Twitch's ID of the broadcast the clip was cut from; null on a video.

source_videoobjectnullable

The past broadcast the clip was cut from; null on a video, and when Twitch no longer keeps it.

ShowHide 4 child fields
idstringnullable

The video's number.

urlstring urinullable

The video's page.

titlestringnullable

The video's title.

offset_msintegernullable

Where in the video the clip starts, in milliseconds; null when Twitch doesn't say.

author_follower_countintegernullable

The channel's followers at fetch time, when the answer has them.

renditionsobject[]

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.

ShowHide 4 child fields
qualitystringnullable

Twitch's name for the quality: the height in pixels (1080).

frame_ratenumbernullable

Frames per second, when Twitch states it.

urlstring uri

The MP4 file, signed and expiring: see expires_at.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from Twitch's signed token; null when unknown.

vertical_renditionsobject[]

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.

ShowHide 4 child fields
qualitystringnullable

Twitch's name for the quality: the height in pixels (1080).

frame_ratenumbernullable

Frames per second, when Twitch states it.

urlstring uri

The MP4 file, signed and expiring: see expires_at.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from Twitch's signed token; null when unknown.

approximate_fieldsstring[]

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.

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 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.

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.

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.

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.

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.

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.

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.

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

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/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 (HTTP 400): Repeat the original request without cursor to start the list again.

Pagination guide

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.

SourcePrice per successful pagePer 1,000 pages
Any source1 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.
pagePublic pageData embedded in the platform's public web page.

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

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

Last updated