Twitch

Returns a public Twitch channel from its login, link or numeric ID, with its bio, exact followers and whether it is live now. A live channel adds its stream title, category, tags and viewer count. You also get its display name, avatar, banner and offline image, the links it lists, its Partner or Affiliate status, creation date, video count, latest broadcast, and the title, category and language it has set.

GET /v1/twitch/profile

Try it

Example

cURL
curl 'https://socialtap.dev/v1/twitch/profile?handle=ninja' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
TypeScript SDK
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.twitch.profile.get({ handle: "ninja" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
Node.js (fetch)
const params = new URLSearchParams({
  handle: "ninja",
});
const res = await fetch(`https://socialtap.dev/v1/twitch/profile?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, meta } = body;
console.log(data, meta.credits_charged);
Python (requests)
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/twitch/profile",
    params={"handle": "ninja"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])
Go (net/http)
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("handle", "ninja")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/twitch/profile?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
PHP
<?php

$query = http_build_query([
    'handle' => 'ninja',
]);
$ch = curl_init('https://socialtap.dev/v1/twitch/profile?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;
Ruby
require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/twitch/profile")
uri.query = URI.encode_www_form('handle' => 'ninja')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]
Java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "handle=" + encode("ninja");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/twitch/profile?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}
.NET
using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",
    "handle=" + Uri.EscapeDataString("ninja"));
var res = await http.GetAsync("https://socialtap.dev/v1/twitch/profile?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));
Rust
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/twitch/profile")
        .query(&[("handle", "ninja")])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}
200 OK
{
  "data": {
    "approximate_fields": [],
    "avatar_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/90d40495-f467-4911-9035-72d8d10a49c5-profile_image-600x600.png",
    "banner_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/36b341d1-0ee2-4cb2-ae00-361740b0051d-profile_banner-480.png",
    "bio": "Just want to make people happy. Co-Founder @DrinkNutcase.",
    "category": "Just Chatting",
    "country_code": null,
    "created_at": "2011-01-16T04:31:20Z",
    "display_name": "Ninja",
    "external_links": [
      {
        "title": "Instagram",
        "url": "https://www.instagram.com/ninja"
      },
      {
        "title": "X",
        "url": "https://x.com/ninja"
      },
      {
        "title": "TikTok",
        "url": "https://www.tiktok.com/@ninja"
      }
    ],
    "id": "19571641",
    "is_private": false,
    "is_verified": true,
    "location": null,
    "metrics": {
      "follower_count": 19227283,
      "following_count": null,
      "post_count": 1396,
      "total_like_count": null,
      "total_view_count": null
    },
    "platform": "twitch",
    "platform_specific": {
      "twitch": {
        "category": {
          "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/509658-285x380.jpg",
          "id": "509658",
          "name": "Just Chatting",
          "slug": "just-chatting"
        },
        "channel_title": "BLEV BROS SPORTS SHOW WEEK 8 RECAP | GO LIONS | PRAYERS FOR JACK CAMPBELL",
        "concurrent_viewer_count": null,
        "is_affiliate": false,
        "is_live": false,
        "is_mature": false,
        "language": "en",
        "last_broadcast": {
          "category": {
            "box_art_url": "https://static-cdn.jtvnw.net/ttv-boxart/509658-285x380.jpg",
            "id": "509658",
            "name": "Just Chatting",
            "slug": "just-chatting"
          },
          "id": "322129789658",
          "started_at": "2026-11-04T03:43:53Z",
          "title": "BLEV BROS SPORTS SHOW WEEK 8 RECAP | GO LIONS | PRAYERS FOR JACK CAMPBELL"
        },
        "offline_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/6d03c501-0b93-4c15-b11e-880a2e1db4d1-channel_offline_image-1920x1080.png",
        "primary_color_hex": "1F69FF",
        "stream": null,
        "team": null
      }
    },
    "type": "unknown",
    "unknown_fields": [],
    "url": "https://www.twitch.tv/ninja",
    "username": "ninja"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "twitch",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 308,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "profile",
      "id": "19571641",
      "url": "https://www.twitch.tv/ninja"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}

Long arrays and strings are shortened for display; real responses are complete.

x-api-keystringheaderrequired

Your API key. Authentication

handlestringrequiredmax 2,048 chars

The Twitch channel: its login with or without the @ (ninja), a channel link (twitch.tv/ninja), or its numeric ID (19571641). A bare number is read as the ID: a login of digits only is written with its @ (@12345).

Exampleninja

handle takes Twitch profile links; another kind of link, or another platform's, fails free with invalid_input. Unknown parameters are rejected with a suggestion, never ignored (Requests).

Parameters every endpoint accepts
max_ageintegermin 0

Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent.

fieldsstring

Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole.

Response

application/json

200

{data, meta}. data is a profile object; meta describes the request (meta). Fields only Twitch has are under platform_specific.twitch.

platformstring

Platform ID (tiktok, youtube, …).

idstring

Platform-native account ID (string; YouTube UC…, Reddit t2_…).

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name, channel title or page name; null when empty or not exposed.

urlstring uri

Canonical profile URL.

typestring

Coarse account kind, as the platform labels it; unknown when it does not (TikTok labels organizations only). New values may be added; treat unknown values as unknown.

One ofpersonorganizationcommunityunknown

biostringnullable

Profile bio, channel description or page about text; null when empty or not exposed.

avatar_urlstring urinullable

Profile picture URL (largest available). Platform CDN URLs can expire within hours.

banner_urlstring urinullable

Header or cover image URL.

is_verifiedbooleannullableTwitch: Partner badge

Platform verification badge; null where the platform has no badge.

is_privatebooleannullable

True when the account's posts are not public.

categorystringnullable

Platform category label (e.g. Musician, Media & Entertainment), as shown; not normalized. Often set only for business or creator accounts.

external_linksobject[]

Links in the bio or channel links; [] if none or not exposed.

ShowHide 2 child fields
urlstring uri

Link target, absolute (https:// is added where the platform stores the link without a scheme).

titlestringnullable

Link label shown by the platform.

locationstringnullable

Self-declared location text.

country_codestringnullable

ISO 3166-1 alpha-2 country the platform states for the account.

created_atstring date-timenullable

Account creation or join date, RFC 3339 UTC (some platforms give only the day: see approximate_fields).

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 5 child fields
follower_countintegernullable

Followers or subscribers.

following_countintegernullable

Accounts this profile follows.

post_countintegernullableTwitch: videos

Posts or videos as the platform counts them on the profile (for a private account, posts the caller cannot see).

total_like_countintegernullable

Likes received across all of the profile's posts (not likes given).

total_view_countintegernullable

Lifetime views across all of the profile's posts.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 1 child field
twitchobjectnullable

A Twitch channel's own fields.

ShowHide 12 child fields
is_livebooleannullable

True while the channel is on air, false when it is not.

concurrent_viewer_countintegernullable

People watching now; null when off air.

is_affiliatebooleannullable

True for a Twitch Affiliate, the program below Partner. Partners are is_verified: the badge Twitch draws is theirs.

streamobjectnullable

The broadcast on air now; null when off air.

ShowHide 7 child fields
idstringnullable

Twitch's ID of the broadcast, which last_broadcast.id and a clip's broadcast_id also write.

titlestringnullable

The broadcast's title.

typestringnullable

Twitch's word for what is on air (live).

started_atstring date-timenullable

When it went on air, RFC 3339 UTC.

tagsstring[]

The tags the channel set, as shown; [] when none.

categoryobjectnullable

The category it is filed under.

ShowHide 4 child fields
idstringnullable

Twitch's ID of the category.

namestringnullable

Its name (Just Chatting).

slugstringnullable

Its name in links (twitch.tv/directory/category/just-chatting).

box_art_urlstring urinullable

The category's cover image.

thumbnail_urlstring urinullable

A preview frame of the broadcast, renewed while it airs.

last_broadcastobjectnullable

The channel's latest broadcast, on air or over; null when it has never streamed.

ShowHide 4 child fields
idstringnullable

Twitch's ID of the broadcast.

titlestringnullable

The title it aired under.

started_atstring date-timenullable

When it went on air, RFC 3339 UTC.

categoryobjectnullable

The category it was last filed under.

ShowHide 4 child fields
idstringnullable

Twitch's ID of the category.

namestringnullable

Its name (Just Chatting).

slugstringnullable

Its name in links (twitch.tv/directory/category/just-chatting).

box_art_urlstring urinullable

The category's cover image.

channel_titlestringnullable

The title the channel has set for its stream, which stays while it is off air.

categoryobjectnullable

The category the channel has set, whose name is category.

ShowHide 4 child fields
idstringnullable

Twitch's ID of the category.

namestringnullable

Its name (Just Chatting).

slugstringnullable

Its name in links (twitch.tv/directory/category/just-chatting).

box_art_urlstring urinullable

The category's cover image.

languagestringnullable

The broadcast language the channel has set, lowercase (en).

is_maturebooleannullable

True when the channel marks itself as for mature audiences.

primary_color_hexstringnullable

The channel's accent color as hex digits without the #.

offline_image_urlstring urinullable

The image the player shows while the channel is off air.

teamobjectnullable

The Twitch team the channel lists first; null when it lists none.

ShowHide 3 child fields
idstringnullable

Twitch's ID of the team.

namestringnullable

Its name in links.

display_namestringnullable

Its name as shown.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text (e.g. metrics.follower_count). A list path (external_links) means the list may be incomplete. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

400

400 Bad Request: 1 error code. Free: errors cost nothing.

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

401

401 Unauthorized: 1 error code. Free: errors cost nothing.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

402

402 Payment Required: 2 error codes. Free: errors cost nothing.

The account does not have enough credits for this request.

Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.

The API key reached its spend limit for this period. The account may still have credits.

Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically.

403

403 Forbidden: 2 error codes. Free: errors cost nothing.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.

Only public items can be fetched. Do not retry.

404

404 Not Found: 1 error code. Free: errors cost nothing.

not_foundNo retry

The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).

Check the link or ID. Do not retry.

429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

500

500 Internal Error: 1 error code. Free: errors cost nothing.

internalYes, later

An unexpected error on SocialTap's side.

Retry with backoff. If it keeps happening, contact support with the request_id.

502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

upstream_errorYes, later

The platform failed, or answered with something we could not read.

Retry with backoff. Failed requests are free.

503

503 Unavailable: 2 error codes. Free: errors cost nothing.

The platform refused every attempt, our own retries included.

Retry later with backoff. Failed requests are free.

overloadedYes, later

SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.

Retry after the seconds in the retry-after header. Failed requests are free.

From 1 credit per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as meta.source.

SourcePrice per successful requestPer 1,000 requests
Platform API api1 credit$0.75–$1.97
Balance, sources and what you were charged

Your balance must be at least 1 credit to start a request; with less, it is refused with insufficient_credits (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

meta.sourceSourceWhat it means
apiPlatform APIThe platform's public, logged-out API.

meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs

Endpoint ID twitch.profile · operationId twitch.profile.get · Product overview

Last updated