Example
curl -G 'https://socialtap.dev/v1/twitch/video' \
--data-urlencode 'url=https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD' \
-H "x-api-key: $SOCIALTAP_API_KEY"import { SocialTap } from "socialtap";
const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY
const res = await client.twitch.video.get({ url: "https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
url: "https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD",
});
const res = await fetch(`https://socialtap.dev/v1/twitch/video?${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, meta } = body;
console.log(data, meta.credits_charged);import os
import requests
res = requests.get(
"https://socialtap.dev/v1/twitch/video",
params={"url": "https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD"},
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, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"net/url"
"os"
)
func main() {
q := url.Values{}
q.Set("url", "https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/twitch/video?"+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"`
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
$query = http_build_query([
'url' => 'https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD',
]);
$ch = curl_init('https://socialtap.dev/v1/twitch/video?' . $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;require "json"
require "net/http"
uri = URI("https://socialtap.dev/v1/twitch/video")
uri.query = URI.encode_www_form('url' => 'https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD')
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"]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 = "url=" + encode("https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/twitch/video?" + 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);
}
}using System.Text.Json;
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));
var query = string.Join("&",
"url=" + Uri.EscapeDataString("https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD"));
var res = await http.GetAsync("https://socialtap.dev/v1/twitch/video?" + 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"));// 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/video")
.query(&[("url", "https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD")])
.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(())
}{
"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": 25000,
"hashtags": [],
"id": "IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD",
"is_nsfw": false,
"is_pinned": null,
"is_sponsored": null,
"language": "en",
"media": [
{
"alt_text": null,
"duration_ms": 25000,
"expires_at": "2026-11-06T01:53:39Z",
"height": 1080,
"thumbnail_url": "https://static-cdn.jtvnw.net/twitch-video-assets/twitch-vap-video-assets-prod-us-west-2/63bd5360-8aea-4234-bce7-00a6426d621a/landscape/thumb/thumb-0000000000-1920x1080.jpg",
"type": "video",
"url": "https://d1ndex63qxojbr.cloudfront.net/nauth/63bd5360-8aea-4234-bce7-00a6426d621a/landscape/avc/1080/index.mp4?sig=SCRUBBED&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnaut…",
"width": 1920
}
],
"mentions": [],
"metrics": {
"comment_count": null,
"like_count": null,
"quote_count": null,
"repost_count": null,
"save_count": null,
"share_count": null,
"view_count": 314763
},
"platform": "twitch",
"platform_specific": {
"twitch": {
"animated_preview_url": null,
"author_follower_count": 19227257,
"broadcast_id": "41505484557",
"broadcast_type": "clip",
"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": "1887094151",
"clipped_by": {
"avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/6b44b8a3-587a-4ca2-b527-d8b07baae7ef-profile_image-300x300.png",
"display_name": "sSaintPablo",
"id": "206880681",
"is_verified": false,
"url": "https://www.twitch.tv/ssaintpablo",
"username": "ssaintpablo"
},
"content_labels": [],
"deletes_at": null,
"embed_url": "https://clips.twitch.tv/embed?clip=IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD",
"is_featured": false,
"is_recording": null,
"is_restricted": null,
"renditions": [
{
"expires_at": "2026-11-06T01:53:39Z",
"frame_rate": null,
"quality": "1080",
"url": "https://d1ndex63qxojbr.cloudfront.net/nauth/63bd5360-8aea-4234-bce7-00a6426d621a/landscape/avc/1080/index.mp4?sig=SCRUBBED&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnaut…"
},
{
"expires_at": "2026-11-06T01:53:39Z",
"frame_rate": null,
"quality": "720",
"url": "https://d1ndex63qxojbr.cloudfront.net/nauth/63bd5360-8aea-4234-bce7-00a6426d621a/landscape/avc/720/index.mp4?sig=SCRUBBED&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth…"
},
{
"expires_at": "2026-11-06T01:53:39Z",
"frame_rate": null,
"quality": "480",
"url": "https://d1ndex63qxojbr.cloudfront.net/nauth/63bd5360-8aea-4234-bce7-00a6426d621a/landscape/avc/480/index.mp4?sig=SCRUBBED&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth…"
}
],
"source_video": {
"id": "994448370",
"offset_ms": 5206000,
"title": "Ninja's April \"Inside Ninja's head\" on Twitch! !ask",
"url": "https://www.twitch.tv/videos/994448370"
},
"vertical_renditions": []
}
},
"platform_type": "clip",
"published_at": "2021-04-20T18:22:14Z",
"text": null,
"thumbnail_url": "https://static-cdn.jtvnw.net/twitch-video-assets/twitch-vap-video-assets-prod-us-west-2/63bd5360-8aea-4234-bce7-00a6426d621a/landscape/thumb/thumb-0000000000-1920x1080.jpg",
"title": "Ninja Reenacting Chalk Board Egirls",
"type": "video",
"unknown_fields": [],
"url": "https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD"
},
"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": "clip",
"id": "IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD",
"url": "https://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD"
},
"credits_remaining": 9999,
"client_request_id": null,
"warnings": []
}
}Long arrays and strings are shortened for display; real responses are complete.
The video or clip: its link (twitch.tv/videos/2918964242, twitch.tv/ninja/clip/<slug>, clips.twitch.tv/<slug>, a player or embed link, on any of Twitch's hosts), a video's number (2918964242) or a clip's slug.
Examplehttps://www.twitch.tv/ninja/clip/IcyBreakableDelicataTooSpicy-RnrKLybQI3W9K_AD
url takes Twitch video and clip links; another kind of link, or another platform's, fails free with invalid_input. Unknown parameters are rejected with a suggestion, never ignored (Requests).
Parameters every endpoint accepts
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.
fieldsstringReturn 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, meta}. data is a post object; meta describes the request (meta). Fields only Twitch has are under platform_specific.twitch.
platformstringPlatform ID (tiktok, youtube, …).
idstringPlatform-native post ID (string; Instagram shortcode, Reddit with its t3_ prefix).
urlstring uriCanonical post URL.
typestringNormalized content shape. New values may be added; treat unknown values as other.
One ofvideoimagecarouseltextlinkaudio
platform_typestringnullableThe platform's own product label, lowercase (reel, short, story, live, tweet, …).
titlestringnullableHeadline (YouTube title, Reddit title); null on caption-only platforms.
textstringnullableCaption, description or body as plain text.
languagestringnullableBCP-47 language of text, when the platform states it.
published_atstring date-timenullableWhen the post went public, RFC 3339 UTC.
authorobjectThe 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
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform 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
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
duration_msintegernullableLength of the primary video or audio in milliseconds; null for other posts.
thumbnail_urlstring urinullableCover or poster image URL.
mediaobject[]Attachments in display order (carousel items); [] for text posts.
ShowHide 8 child fields
typestringKind of file. New values may be added; treat unknown values as other.
One ofimagevideoaudiogif
urlstring urinullableDirect 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-timenullableWhen url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.
thumbnail_urlstring urinullablePoster or preview image URL.
widthintegernullableWidth in pixels.
heightintegernullableHeight in pixels.
duration_msintegernullableDuration in milliseconds (video and audio only).
alt_textstringnullableAccessibility text provided by the author or platform.
hashtagsstring[]Hashtags without #, case kept; [] if none.
mentionsstring[]Mentioned or tagged usernames without @; [] if none.
is_pinnedbooleannullablePinned to the author's profile.
is_sponsoredbooleannullableLabeled as a paid partnership or branded content.
is_nsfwbooleannullableMarked adult or sensitive by the platform.
metricsobjectCounts at fetch time; null = hidden or not exposed, 0 = zero.
ShowHide 7 child fields
view_countintegernullableViews or plays.
like_countintegernullableLikes, hearts, total reactions or upvotes; never negative. Null when hidden by the owner.
comment_countintegernullableComments and replies.
share_countintegernullableShares or sends (not reposts).
repost_countintegernullableReposts, retweets or reshares.
quote_countintegernullableQuote posts.
save_countintegernullableSaves, bookmarks or favorites.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 1 child field
twitchobjectnullableA Twitch video's or clip's own fields.
ShowHide 17 child fields
broadcast_typestringnullableWhat Twitch calls this kind of video: archive (a past broadcast), highlight, upload, premiere_upload, past_premiere or clip.
categoryobjectnullableWhat it is filed under; null when nothing was set.
ShowHide 4 child fields
idstringnullableTwitch's ID of the category.
namestringnullableIts name (Just Chatting).
slugstringnullableIts name in links (twitch.tv/directory/category/just-chatting).
box_art_urlstring urinullableThe category's cover image.
is_recordingbooleannullableTrue for a past broadcast that is still being recorded because the stream is on air; null on a clip.
is_restrictedbooleannullableTrue 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-timenullableWhen 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 urinullableAn 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
titlestringnullableWhat Twitch shows for it: the category's name.
position_msintegernullableWhere in the video it starts, in milliseconds.
duration_msintegernullableHow long it lasts, in milliseconds; null on the last part of a broadcast still on air.
categoryobjectnullableThe category; null when Twitch doesn't say.
ShowHide 4 child fields
idstringnullableTwitch's ID of the category.
namestringnullableIts name (Just Chatting).
slugstringnullableIts name in links (twitch.tv/directory/category/just-chatting).
box_art_urlstring urinullableThe category's cover image.
clip_idstringnullableTwitch's number for a clip. Its links take the slug, which is id; null on a video.
embed_urlstring urinullableThe clip's embeddable player; null on a video.
is_featuredbooleannullableTrue when the channel features the clip; null on a video.
clipped_byobjectnullableThe 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
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
broadcast_idstringnullableTwitch's ID of the broadcast the clip was cut from; null on a video.
source_videoobjectnullableThe past broadcast the clip was cut from; null on a video, and when Twitch no longer keeps it.
ShowHide 4 child fields
idstringnullableThe video's number.
urlstring urinullableThe video's page.
titlestringnullableThe video's title.
offset_msintegernullableWhere in the video the clip starts, in milliseconds; null when Twitch doesn't say.
author_follower_countintegernullableThe 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
qualitystringnullableTwitch's name for the quality: the height in pixels (1080).
frame_ratenumbernullableFrames per second, when Twitch states it.
urlstring uriThe MP4 file, signed and expiring: see expires_at.
expires_atstring date-timenullableWhen 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
qualitystringnullableTwitch's name for the quality: the height in pixels (1080).
frame_ratenumbernullableFrames per second, when Twitch states it.
urlstring uriThe MP4 file, signed and expiring: see expires_at.
expires_atstring date-timenullableWhen 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: 1 error code. Free: errors cost nothing.
invalid_inputNo retryA 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.
401
401 Unauthorized: 1 error code. Free: errors cost nothing.
unauthorizedNo retryThe 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 retryThe 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 retryThe 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 retryThe 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.
404
404 Not Found: 1 error code. Free: errors cost nothing.
not_foundNo retryThe 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, laterThe 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, laterAn 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, laterThe 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, laterThe platform refused every attempt, our own retries included.
Retry later with backoff. Failed requests are free.
overloadedYes, laterSocialTap 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.
From 1 credit per request. Charged only for successful requests. 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 request | Per 1,000 requests |
|---|---|---|
| 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 (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 · Packs
Endpoint ID twitch.video · operationId twitch.video.get · Product overview