Get video metadata

Try in Playground

Retrieve one Twitch video by numeric ID or public video URL. Supply exactly one of id or url.

GET/v1/twitch/videox-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

idstringquery

Numeric Twitch video ID. Supply id or url, exactly one.

Example3

urlstringquery

HTTPS twitch.tv/videos/{id} URL. Supply url or id, exactly one. Query parameters and fragments are removed from the canonical source URL.

max 2048 chars

Response fields

Video ID, title, creation/publication timestamps, duration, views, owner identity, nullable game and preview thumbnail.

video.idstring

Always included.

min 1 chars

video.titlestring

Always included.

video.createdAtstring

Always included.

video.publishedAtstring

Always included.

video.lengthSecondsinteger

Always included.

≥ 0

video.viewCountinteger

Always included.

≥ 0

Always included.

video.owner.idstring

Always included.

min 1 chars

video.owner.loginstring

Always included.

video.game.idstring

Always included.

min 1 chars

video.game.namestring

Always included.

video.previewThumbnailURLstring

Always included.

requestIdstring

Operation identifier for correlation.

HTTP attempts initiated by this operation, decoded response bytes and elapsed milliseconds. A shared client bootstrap is counted by its initiating operation.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when the primary requested data is usable.

statusenum

success, partial, failed or challenged. Inspect coverage on HTTP 200.

one of: success, partial

sourceUrlstring

Canonical public Twitch page URL.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Coverage of the requested public metadata selection.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

up to 2 items

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
200	`partial`	Primary clip data is usable but a related-clips or viewer GraphQL query returned source errors.
400	`invalid_request`	Missing or unsafe input, unknown parameters, invalid filter/sort, or duplicate parameters.
401	`unauthorized`	Missing or invalid dedicated worker API key.
403	`restricted_page`	Unpublished clip, denied or expired playback token, or unexpected authenticated viewer.
404	`not_found`	The requested channel, video or clip is missing, or the route is unknown.
429	`upstream_rate_limited`	Twitch rate limited retrieval.
502	`upstream_challenged` `public_client_unavailable`	Twitch challenged the request or its public client identifier could not be determined.
502	`upstream_graphql_error` `unsupported_page`	Primary query failure or incomplete, unexpected or mismatched data.
502	`response_too_large` `payload_too_complex`	Byte, depth or JSON node limit exceeded.
502	`unsafe_redirect` `request_limit` `upstream_error`	Bounded transport could not complete.
503	`busy`	All worker admission slots are occupied.
504	`timeout`	The total request deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/twitch/video?id=3" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/twitch/video?id=3",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/twitch/video?id=3",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Twitch request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/twitch/video",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "id": "3"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/twitch/video?id=3", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/twitch/video?id=3"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "video": {
    "id": "3",
    "title": "Synthetic video",
    "createdAt": "2026-09-18T00:00:00Z",
    "publishedAt": "2026-09-18T00:00:00Z",
    "lengthSeconds": 12,
    "viewCount": 0,
    "owner": {
      "id": "1",
      "login": "example"
    },
    "game": null,
    "previewThumbnailURL": "https://example.test/thumb"
  },
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000099",
  "sourceUrl": "https://www.twitch.tv/videos/3",
  "fetchedAt": "2026-09-10T00:00:00.000Z",
  "coverage": {
    "source": "public_graphql",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 2,
    "responseBytes": 1200,
    "durationMs": 300
  }
}

Missing or unsafe input, unknown parameters, invalid filter/sort, or duplicate parameters.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}