Get a Twitch profile

Try in Playground

Retrieve profile identity, biography, social links, followers, partner status, current stream, videos, home-page video shelves and similar streamers. Social names become lowercase top-level keys.

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

139

idstring

Always included.

min 1 chars

isLiveboolean

Always included.

currentViewersCountintegernullable

Current stream viewers; null when offline.

streamobject

Current live stream object, or {} when offline.

handlestring

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

displayNamestring

Always included.

profileImageURLstringnullable

Profile image at 150 pixels.

bannerImageURLstringnullable

Source banner URL, or null.

descriptionstringnullable

Always included.

followersinteger

Current follower count; it can change between requests.

≥ 0

isPartnerboolean

Published Twitch partner flag.

Up to 12 latest videos, with full owner/game, restrictions, tags and logged-out self metadata.

up to 12 items

allVideos.idstring

Always included.

min 1 chars

allVideos.animatedPreviewURLstringnullable

Always included.

allVideos.lengthSecondsinteger

Always included.

≥ 0

Always included.

allVideos.game.idstring

Always included.

min 1 chars

allVideos.game.slugstring

Always included.

allVideos.game.namestring

Always included.

allVideos.game.__typenamestring

Always included.

allVideos.game.displayNamestring

Always included.

allVideos.game.boxArtURLstring

Always included.

allVideos.owner.idstring

Always included.

min 1 chars

allVideos.owner.loginstring

Always included.

allVideos.owner.displayNamestring

Always included.

allVideos.owner.__typenamestring

Always included.

allVideos.owner.profileImageURLstringnullable

Always included.

allVideos.owner.primaryColorHexstringnullable

Always included.

allVideos.owner.roles.isPartnerboolean

Always included.

allVideos.owner.roles.__typenamestring

Always included.

allVideos.previewThumbnailURLstring

Always included.

allVideos.publishedAtstring

Always included.

allVideos.titlestring

Always included.

allVideos.viewCountinteger

Always included.

≥ 0

Always included.

up to 100 items

allVideos.contentTags.idstring

Always included.

min 1 chars

allVideos.contentTags.isLanguageTagboolean

Always included.

allVideos.contentTags.tagNamestring

Always included.

allVideos.contentTags.localizedNamestring

Always included.

allVideos.contentTags.__typenamestring

Always included.

allVideos.resourceRestrictionJSON

Always included.

allVideos.self.isRestrictedboolean

Always included.

allVideos.self.viewingHistoryJSON

Always included.

allVideos.self.__typenamestring

Always included.

allVideos.__typenamestring

Always included.

Present when Twitch supplies a nonempty latest-broadcasts shelf. Preserves its source records.

up to 100 items

recentBroadcasts.idstring

Always included.

min 1 chars

recentBroadcasts.animatedPreviewURLstringnullable

Always included.

recentBroadcasts.lengthSecondsinteger

Always included.

≥ 0

Always included.

recentBroadcasts.game.idstring

Always included.

min 1 chars

recentBroadcasts.game.slugstring

Always included.

recentBroadcasts.game.namestring

Always included.

recentBroadcasts.game.__typenamestring

Always included.

recentBroadcasts.game.displayNamestring

Always included.

recentBroadcasts.game.boxArtURLstring

Always included.

recentBroadcasts.owner.idstring

Always included.

min 1 chars

recentBroadcasts.owner.loginstring

Always included.

recentBroadcasts.owner.displayNamestring

Always included.

recentBroadcasts.owner.__typenamestring

Always included.

recentBroadcasts.owner.profileImageURLstringnullable

Always included.

recentBroadcasts.owner.primaryColorHexstringnullable

Always included.

recentBroadcasts.previewThumbnailURLstring

Always included.

recentBroadcasts.publishedAtstring

Always included.

recentBroadcasts.titlestring

Always included.

recentBroadcasts.viewCountinteger

Always included.

≥ 0

Always included.

up to 100 items

recentBroadcasts.contentTags.idstring

Always included.

min 1 chars

recentBroadcasts.contentTags.isLanguageTagboolean

Always included.

recentBroadcasts.contentTags.tagNamestring

Always included.

recentBroadcasts.contentTags.localizedNamestring

Always included.

recentBroadcasts.contentTags.__typenamestring

Always included.

recentBroadcasts.resourceRestrictionJSON

Always included.

recentBroadcasts.self.isRestrictedboolean

Always included.

recentBroadcasts.self.viewingHistoryJSON

Always included.

recentBroadcasts.self.__typenamestring

Always included.

recentBroadcasts.__typenamestring

Always included.

Public top-clips shelf, including isFeatured on each item, creator, broadcaster, game and guest participants. Omitted when no populated shelf is supplied.

up to 100 items

featuredClips.idstring

Always included.

min 1 chars

featuredClips.slugstring

Always included.

featuredClips.clipTitlestring

Always included.

featuredClips.clipViewCountinteger

Always included.

≥ 0

Always included.

featuredClips.curator.idstring

Always included.

min 1 chars

featuredClips.curator.loginstring

Always included.

featuredClips.curator.displayNamestring

Always included.

featuredClips.curator.__typenamestring

Always included.

featuredClips.clipGame.idstring

Always included.

min 1 chars

featuredClips.clipGame.slugstring

Always included.

featuredClips.clipGame.namestring

Always included.

featuredClips.clipGame.__typenamestring

Always included.

featuredClips.clipGame.displayNamestring

Always included.

featuredClips.clipGame.boxArtURLstring

Always included.

featuredClips.broadcaster.idstring

Always included.

min 1 chars

featuredClips.broadcaster.loginstring

Always included.

featuredClips.broadcaster.displayNamestring

Always included.

featuredClips.broadcaster.__typenamestring

Always included.

featuredClips.broadcaster.profileImageURLstringnullable

Always included.

featuredClips.broadcaster.primaryColorHexstringnullable

Always included.

featuredClips.broadcaster.roles.isPartnerboolean

Always included.

featuredClips.broadcaster.roles.__typenamestring

Always included.

featuredClips.thumbnailURLstring

Always included.

featuredClips.createdAtstring

Always included.

featuredClips.durationSecondsnumber

Always included.

≥ 0

featuredClips.isFeaturedboolean

Always included.

featuredClips.guestStarParticipantsJSON

Always included.

featuredClips.__typenamestring

Always included.

Up to 15 public recommendations; an empty source shelf yields an empty array.

up to 15 items

similarStreamers.idstring

Always included.

min 1 chars

similarStreamers.loginstring

Always included.

similarStreamers.displayNamestring

Always included.

similarStreamers.__typenamestring

Always included.

similarStreamers.profileImageURLstringnullable

Always included.

similarStreamers.primaryColorHexstringnullable

Always included.

similarStreamers.stream.idstring

Always included.

min 1 chars

similarStreamers.stream.viewersCountinteger

Always included.

≥ 0

similarStreamers.stream.__typenamestring

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.

Public GraphQL coverage. Clip auxiliary query errors produce partial with auxiliary_graphql_error; missing required primary fields fail.

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

const response = await fetch(
  "https://api.scrapeatlas.com/v1/twitch/profile?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?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",
    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?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?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",
  "isLive": false,
  "currentViewersCount": null,
  "stream": {},
  "handle": "example",
  "displayName": "Example",
  "profileImageURL": "https://example.test/avatar",
  "bannerImageURL": null,
  "description": "Synthetic profile",
  "followers": 0,
  "isPartner": false,
  "allVideos": [
    {
      "id": "3",
      "animatedPreviewURL": null,
      "lengthSeconds": 12,
      "game": {
        "id": "2",
        "slug": "example",
        "name": "Example",
        "displayName": "Example",
        "boxArtURL": "https://example.test/game",
        "__typename": "Game"
      },
      "owner": {
        "id": "1",
        "login": "example",
        "displayName": "Example",
        "profileImageURL": "https://example.test/avatar",
        "primaryColorHex": null,
        "roles": {
          "isPartner": false,
          "__typename": "UserRoles"
        },
        "__typename": "User"
      },
      "previewThumbnailURL": "https://example.test/thumb",
      "publishedAt": "2026-09-10T00:00:00Z",
      "title": "Synthetic video",
      "viewCount": 0,
      "contentTags": [],
      "resourceRestriction": null,
      "self": {
        "isRestricted": false,
        "viewingHistory": null,
        "__typename": "VideoSelfEdge"
      },
      "__typename": "Video"
    }
  ],
  "recentBroadcasts": [
    {
      "id": "3",
      "animatedPreviewURL": null,
      "lengthSeconds": 12,
      "game": {
        "id": "2",
        "slug": "example",
        "name": "Example",
        "displayName": "Example",
        "boxArtURL": "https://example.test/game",
        "__typename": "Game"
      },
      "owner": {
        "id": "1",
        "login": "example",
        "displayName": "Example",
        "profileImageURL": "https://example.test/avatar",
        "primaryColorHex": null,
        "roles": {
          "isPartner": false,
          "__typename": "UserRoles"
        },
        "__typename": "User"
      },
      "previewThumbnailURL": "https://example.test/thumb",
      "publishedAt": "2026-09-10T00:00:00Z",
      "title": "Synthetic video",
      "viewCount": 0,
      "contentTags": [],
      "resourceRestriction": null,
      "self": {
        "isRestricted": false,
        "viewingHistory": null,
        "__typename": "VideoSelfEdge"
      },
      "__typename": "Video"
    }
  ],
  "featuredClips": [
    {
      "id": "4",
      "slug": "SyntheticClip",
      "clipTitle": "Synthetic clip",
      "clipViewCount": 0,
      "curator": {
        "id": "5",
        "login": "creator",
        "displayName": "Creator",
        "__typename": "User"
      },
      "clipGame": {
        "id": "2",
        "slug": "example",
        "name": "Example",
        "displayName": "Example",
        "boxArtURL": "https://example.test/game",
        "__typename": "Game"
      },
      "broadcaster": {
        "id": "1",
        "login": "example",
        "displayName": "Example",
        "profileImageURL": "https://example.test/avatar",
        "primaryColorHex": null,
        "roles": {
          "isPartner": false,
          "__typename": "UserRoles"
        },
        "__typename": "User"
      },
      "thumbnailURL": "https://example.test/thumb",
      "createdAt": "2026-09-10T00:00:00Z",
      "durationSeconds": 12,
      "isFeatured": true,
      "guestStarParticipants": null,
      "__typename": "Clip"
    }
  ],
  "similarStreamers": [],
  "youtube": "https://youtube.com/example",
  "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": 3,
    "responseBytes": 4000,
    "durationMs": 500
  }
}

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