api.socialscrape.dev.Before you start
- An API key, sent in the
x-api-keyheader. Keep it on your server. - For this endpoint you send
handle. The Twitch user videos page lists every parameter.
Step 1: Send the request
GET /v1/twitch/user/videos. Pick your language; each one reads the key from SOCIALSCRAPE_API_KEY.
1curl -G "https://api.socialscrape.dev/v1/twitch/user/videos" \2 -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3 --data-urlencode 'handle=shroud' \4 --data-urlencode 'type=highlight' \5 --data-urlencode 'sort=views' \6 --data-urlencode 'limit=10'1import os2import requests34params = {5 "handle": "shroud",6 "type": "highlight",7 "sort": "views",8 "limit": 10,9}10res = requests.get(11 "https://api.socialscrape.dev/v1/twitch/user/videos",12 headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},13 params=params,14 timeout=60,15)16body = res.json()1718if body["ok"]:19 print(body["data"])20else:21 print(body["error"]["code"], body["error"]["message"])1const url = new URL("https://api.socialscrape.dev/v1/twitch/user/videos");2url.search = new URLSearchParams({3 handle: "shroud",4 type: "highlight",5 sort: "views",6 limit: "10",7}).toString();8const res = await fetch(url, {9 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY },10});11const body = await res.json();1213if (body.ok) {14 console.log(body.data);15} else {16 console.error(body.error.code, body.error.message);17}1const url = new URL("https://api.socialscrape.dev/v1/twitch/user/videos");2url.search = new URLSearchParams({3 handle: "shroud",4 type: "highlight",5 sort: "views",6 limit: "10",7}).toString();8const res = await fetch(url, {9 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },10});11const body = await res.json();1213if (body.ok) {14 console.log(body.data);15} else {16 console.error(body.error.code, body.error.message);17}1package main23import (4 "fmt"5 "io"6 "net/http"7 "net/url"8 "os"9)1011func main() {12 q := url.Values{}13 q.Set("handle", "shroud")14 q.Set("type", "highlight")15 q.Set("sort", "views")16 q.Set("limit", "10")17 req, _ := http.NewRequest("GET", "https://api.socialscrape.dev/v1/twitch/user/videos" + "?" + q.Encode(), nil)18 req.Header.Set("x-api-key", os.Getenv("SOCIALSCRAPE_API_KEY"))19 res, err := http.DefaultClient.Do(req)20 if err != nil {21 panic(err)22 }23 defer res.Body.Close()24 body, _ := io.ReadAll(res.Body)25 fmt.Println(res.StatusCode, string(body))26}1<?php2$query = http_build_query([3 'handle' => 'shroud',4 'type' => 'highlight',5 'sort' => 'views',6 'limit' => '10',7]);8$ch = curl_init('https://api.socialscrape.dev/v1/twitch/user/videos' . "?" . $query);9curl_setopt_array($ch, [10 CURLOPT_RETURNTRANSFER => true,11 CURLOPT_HTTPHEADER => ["x-api-key: " . getenv("SOCIALSCRAPE_API_KEY")],12]);13$body = json_decode(curl_exec($ch), true);14curl_close($ch);1516if ($body["ok"]) {17 print_r($body["data"]);18} else {19 echo $body["error"]["code"], " ", $body["error"]["message"], "\n";20}1require "net/http"2require "json"34uri = URI('https://api.socialscrape.dev/v1/twitch/user/videos')5uri.query = URI.encode_www_form('handle' => 'shroud', 'type' => 'highlight', 'sort' => 'views', 'limit' => '10')6req = Net::HTTP::Get.new(uri)7req["x-api-key"] = ENV.fetch("SOCIALSCRAPE_API_KEY")8res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }9body = JSON.parse(res.body)1011if body["ok"]12 puts body["data"]13else14 puts body["error"]["code"], body["error"]["message"]15end1import java.net.URI;2import java.net.URLEncoder;3import java.net.http.HttpClient;4import java.net.http.HttpRequest;5import java.net.http.HttpResponse;6import java.nio.charset.StandardCharsets;78public class Main {9 public static void main(String[] args) throws Exception {10 String query = "handle=" + URLEncoder.encode("shroud", StandardCharsets.UTF_8) + "&type=" + URLEncoder.encode("highlight", StandardCharsets.UTF_8) + "&sort=" + URLEncoder.encode("views", StandardCharsets.UTF_8) + "&limit=" + URLEncoder.encode("10", StandardCharsets.UTF_8);11 HttpRequest req = HttpRequest.newBuilder()12 .uri(URI.create("https://api.socialscrape.dev/v1/twitch/user/videos" + "?" + query))13 .header("x-api-key", System.getenv("SOCIALSCRAPE_API_KEY"))14 .GET()15 .build();16 HttpResponse<String> res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());17 System.out.println(res.statusCode() + " " + res.body());18 }19}1using System;2using System.Net.Http;34var client = new HttpClient();5client.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALSCRAPE_API_KEY"));6var query = string.Join("&", new[] {7 "handle=" + Uri.EscapeDataString("shroud"),8 "type=" + Uri.EscapeDataString("highlight"),9 "sort=" + Uri.EscapeDataString("views"),10 "limit=" + Uri.EscapeDataString("10"),11});12var res = await client.GetAsync("https://api.socialscrape.dev/v1/twitch/user/videos" + "?" + query);13Console.WriteLine((int)res.StatusCode);14Console.WriteLine(await res.Content.ReadAsStringAsync());Step 2: Read the response
Results are in data.items. Here is what one item gives you, from a recorded sample.
1for item in body["data"]["items"]:2 print(item["title"])3 print(item["id"])4 print(item["stats"]["views"])1for (const item of body.data.items) {2 console.log(item.title);3 console.log(item.id);4 console.log(item.stats.views);5}1{2 "title": "Highlight: the grind continues......?",3 "id": "1526143078",4 "stats": {5 "views": 377256 }7}A field the platform does not give comes back as null. The full field list is on the endpoint page.
Step 3: Get the next page
Send the same request with the cursor you got back, until has_more is false. Each page costs its own price.
1import os2import requests34url = "https://api.socialscrape.dev/v1/twitch/user/videos"5headers = {"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]}6params = {"handle": "shroud", "type": "highlight", "sort": "views", "limit": 10}78items = []9while len(items) < 100:10 body = requests.get(url, headers=headers, params=params, timeout=60).json()11 if not body["ok"]:12 raise RuntimeError(body["error"]["code"])13 items += body["data"]["items"]14 if not body["has_more"]:15 break16 params["cursor"] = body["cursor"]1718print(len(items), "items")1const url = new URL("https://api.socialscrape.dev/v1/twitch/user/videos");2url.searchParams.set("handle", "shroud");3url.searchParams.set("type", "highlight");4url.searchParams.set("sort", "views");5url.searchParams.set("limit", "10");6const headers = { "x-api-key": process.env.SOCIALSCRAPE_API_KEY };78const items = [];9while (items.length < 100) {10 const body = await (await fetch(url, { headers })).json();11 if (!body.ok) throw new Error(body.error.code);12 items.push(...body.data.items);13 if (!body.has_more) break;14 url.searchParams.set("cursor", body.cursor);15}1617console.log(items.length, "items");Step 4: Handle errors
Check ok, then branch on error.code and error.retryable, never on the message.
1body = res.json()2if not body["ok"]:3 err = body["error"]4 if err["retryable"]:5 ... # wait a moment and send the same request again6 else:7 raise RuntimeError(f'{err["code"]}: {err["message"]}')1const body = await res.json();2if (!body.ok) {3 const { code, message, retryable } = body.error;4 if (retryable) {5 // wait a moment and send the same request again6 } else {7 throw new Error(`${code}: ${message}`);8 }9}| Code | HTTP | Retry | Meaning |
|---|---|---|---|
invalid_params | 400 | no | A parameter is missing, unknown or has the wrong type. |
not_found | 404 | no | The platform says this profile, post or item does not exist. |
Other errors, such as unauthorized or rate_limited, are on the errors page.
With the SDK
The Python and TypeScript clients wrap all of this: typed errors, retries, and cursor paging. Install them with pip install socialscrape-sdk or npm install socialscrape.
1from socialscrape import SocialScrape23client = SocialScrape() # reads SOCIALSCRAPE_API_KEY45for item in client.paginate(client.twitch.user_videos, handle="shroud", type="highlight", sort="views", limit=10, max_items=100):6 print(item["title"])1import { SocialScrape } from "socialscrape";23const client = new SocialScrape(); // reads SOCIALSCRAPE_API_KEY45for await (const item of client.paginate(client.twitch.userVideos, { handle: "shroud", type: "highlight", sort: "views", limit: 10 }, { maxItems: 100 })) {6 console.log(item.title);7}What it costs
1 credit. A failed request costs nothing. Add max_age_days to reuse a cached result for 0 credits. Results are kept 30 days.
Next
- Twitch user videos API: sample response and every parameter.
- All Twitch endpoints.