Twitch Profile API · SocialTap

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

Read the API reference

1 credit per request, $0.75–$1.97 per 1,000 requests
19 typed fields null when unknown
handle is all it needs, e.g. ninja
100 credits free when you sign up, no card, so you can build before you spend

Send one request. Get 19 fields back.

Copy the request in your language, or hand it to your agent. Sign up for an API key and your first 100 credits are free.

$ npm install socialtap

handle = ninja

Open in playground

GET /v1/twitch/profileTry in

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);

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"])

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"]

<?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;

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"])
}

curl 'https://socialtap.dev/v1/twitch/profile?handle=ninja' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

{
  "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": []
  }
}

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);

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);
    }
}

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"));

// 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 · GET https://socialtap.dev/v1/twitch/profileLong arrays and strings are shortened here. Real responses are complete.Docs

One schema on 27 platforms.

The response reference lists every field, its type and when it is null. See the full schema.

Null means unknown
A field Twitch doesn't show is null, never zero or an empty string, so a real zero always means zero.
What it accepts
The Twitch channel: its login with or without the @ (ninja), a channel link (twitch.tv/ninja), or its numeric ID (19571641).
Write one parser
Twitch, TikTok, Instagram and 24 more platforms answer in these fields, so the code that reads one reads them all.

platformstring: Platform ID (tiktok, youtube, …).
idstring: Platform-native account ID (string; YouTube UC…, Reddit t2_…).
usernamestring: Handle without the @; null when the account has none.
display_namestring: Display name, channel title or page name; null when empty or not exposed.
urlstring: 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.
biostring: Profile bio, channel description or page about text; null when empty or not exposed.
avatar_urlstring: Profile picture URL (largest available). Platform CDN URLs can expire within hours.

What teams build with the Twitch Profile API.

Vet a streamer's audience before a sponsorship
Check whether a channel is live right now
Track a channel's follower growth
Resolve a login to its stable numeric ID
Find a streamer's links to other platforms

Good to know before you build.

is_verified is Twitch's Partner badge, the one badge it draws on a channel. platform_specific.twitch.is_affiliate is the program below it.
metrics.following_count, metrics.total_like_count and metrics.total_view_count are null because Twitch doesn't show them to a logged-out visitor.
A channel Twitch has suspended or taken down for copyright returns private_or_unavailable, since Twitch shows none of its fields to anyone. A name nobody holds, or a channel its owner closed, returns not_found.
A bare number is read as an account's ID. A login can also be all digits: write it with its @ (@12345) or send its link.

1 credit per request. Failed requests are free.

Buy credits once and spend them on any endpoint, on any platform.

Plans and packs How this endpoint is priced How credits work

Source	Price per successful request	Per 1,000 requests
Platform API `api`	1 credit	$0.75–$1.97

Cache hits are free.
Credits from packs and top-ups never expire.
A monthly plan's credits are spent first, and what is left of them ends at each renewal.
Prices exclude tax: sales tax is added at checkout where it applies.
Outside the US, plans and packs are sold to businesses: checkout asks for your VAT, GST or other business tax ID.

Questions about the Twitch Profile API.

Try it on an account you know.

Paste its handle or link in the playground, or copy the request into your code.

free credits

No credit card
Failed requests are free
Works on all 218 endpoints

Start for free Read the docs

Twitch Profile API. Send a handle or profile link.

Twitch Profile API at a glance

Send one request. Get 19 fields back.

One schema on 27 platforms.

Null means unknown

What it accepts

Write one parser

What teams build with the Twitch Profile API.

Vet a streamer's audience before a sponsorship

Check whether a channel is live right now

Track a channel's follower growth

Resolve a login to its stable numeric ID

Find a streamer's links to other platforms

Good to know before you build.

1 credit per request. Failed requests are free.

Questions about the Twitch Profile API.

Profiles on 26 more platforms.

Twitch API. 5 endpoints, one key.

Try it on an account you know.