SocialScrape
Get early access
Docs menu

Get started

Guides

API reference

Resources

Twitch channel

Beta GET /v1/twitch/profile

GET /v1/twitch/profile

Twitch channel.

  • Cost: 1 credit
  • Status: Beta. Built and tested against recorded responses; the shape may still gain fields.
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
handlestringyesUsername, with or without the leading @. Also accepted as username.

Every request also accepts:

  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

curl
curl -G "https://api.socialscrape.io/v1/twitch/profile" \
  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \
  --data-urlencode "handle=shroud"
Python
import os
import requests

params = {
    "handle": "shroud",
}
res = requests.get(
    "https://api.socialscrape.io/v1/twitch/profile",
    headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},
    params=params,
)
body = res.json()

if body["ok"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
TypeScript
const url = new URL("https://api.socialscrape.io/v1/twitch/profile");
url.search = new URLSearchParams({
  "handle": "shroud"
}).toString();
const res = await fetch(url, {
  headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },
});
const body = await res.json();

if (body.ok) {
  console.log(body.data);
} else {
  console.error(body.error.code, body.error.message);
}
n8n
{
  "nodes": [
    {
      "name": "SocialScrape Twitch channel",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        0,
        0
      ],
      "parameters": {
        "method": "GET",
        "url": "https://api.socialscrape.io/v1/twitch/profile",
        "sendQuery": true,
        "queryParameters": {
          "parameters": [
            {
              "name": "handle",
              "value": "shroud"
            }
          ]
        },
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "x-api-key",
              "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"
            }
          ]
        }
      }
    }
  ],
  "connections": {}
}

Example response#

This is a sample from a recorded response, lists and long text are shortened. Status 200.

{
  "ok": true,
  "credits_charged": 1,
  "credits_remaining": 4999,
  "cached": false,
  "cached_at": null,
  "request_id": "req_438f610ae5bae10246b9c2db",
  "data": {
    "object": "profile",
    "platform": "twitch",
    "id": "37402112",
    "handle": "shroud",
    "name": "shroud",
    "headline": null,
    "url": "https://www.twitch.tv/shroud",
    "kind": "channel",
    "bio": "I'm back baby",
    "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/c754eebf-745b-4e0a-814a-10bcaecaabbc-profile_image-300x300.png",
    "banner_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/dbee25e8-55b7-4565-87f0-e9d4661dcc66-profile_banner-480.jpeg",
    "verified": true,
    "is_private": null,
    "external_url": null,
    "links": [
      {
        "title": "Discord",
        "url": "https://discord.gg/shroud"
      },
      {
        "title": "Twitter",
        "url": "https://twitter.com/shroud"
      },
      {
        "title": "YouTube",
        "url": "https://youtube.com/shroud"
      }
    ],
    "location": null,
    "category": null,
    "created_at": "2012-11-03T15:50:32.878470Z",
    "stats": {
      "followers": 11292368,
      "following": null,
      "posts": null,
      "likes": null,
      "views": null
    },
    "extra": {
      "broadcast_game": "Crimson Desert",
      "broadcast_language": "EN",
      "broadcast_title": "New Crimson Desert DLC ⛵",
      "current_viewers": 5461,
      "is_affiliate": false,
      "is_live": true,
      "is_partner": true,
      "last_broadcast": {
        "id": "320871868510",
        "started_at": "2026-10-29T16:41:33.43186Z",
        "title": "New Crimson Desert DLC ⛵"
      },
      "primary_color_hex": "00ADFF",
      "stream": {
        "game": "Crimson Desert",
        "game_id": "515186",
        "id": "320871868510",
        "started_at": "2026-10-29T16:41:28Z",
        "thumbnail_url": "https://static-cdn.jtvnw.net/previews-ttv/live_user_shroud-320x180.jpg",
        "title": "New Crimson Desert DLC ⛵",
        "type": "live"
      },
      "updated_at": "2026-10-29T16:41:21.297803Z"
    }
  },
  "cursor": null,
  "has_more": null
}

Response#

A Profile object in data.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.

Example error:

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "The platform says this profile, post or item does not exist.",
    "retryable": false
  },
  "credits_charged": 0,
  "request_id": "req_125da6a5e4428523a617ab11"
}