Get basic profile and live status

Try in Playground

Retrieve channel identity, biography, avatar, followers, partner status and the current live stream in a compact profile response.

GET/v1/twitch/profile/basicx-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

handlestringrequiredquery

Required Twitch login, 1–25 letters, digits or underscores. Normalized to lowercase.

Exampleexample

Response fields

idstring

Source channel ID.

min 1 chars

handlestring

Required Twitch login, 1–25 letters, digits or underscores. Normalized to lowercase.

displayNamestring

Channel display name.

descriptionstringnullable

Published biography, or null.

profileImageURLstringnullable

Profile avatar URL, or null.

followersinteger

Source follower count.

≥ 0

isPartnerboolean

Published partner flag.

isLiveboolean

Whether a current stream is present.

currentViewersCountintegernullable

Source viewer count, or null when offline.

Current stream ID, creation time, viewer count and nullable game identity; null when offline.

stream.idstring

Always included.

min 1 chars

stream.viewersCountinteger

Always included.

≥ 0

stream.createdAtstring

Always included.

stream.game.idstring

Always included.

min 1 chars

stream.game.namestring

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/profile/basic?handle=example" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/twitch/profile/basic?handle=example",
  {
    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/profile/basic?handle=example",
  {
    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/profile/basic",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "handle": "example"
    },
    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/profile/basic?handle=example", 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/profile/basic?handle=example"))
            .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.

{
  "id": "1",
  "handle": "example",
  "displayName": "Example",
  "description": null,
  "profileImageURL": "https://example.test/avatar",
  "followers": 0,
  "isPartner": false,
  "isLive": false,
  "currentViewersCount": null,
  "stream": null,
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000099",
  "sourceUrl": "https://www.twitch.tv/example",
  "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."
  }
}