TikTok

Returns whether a TikTok account is LIVE now, with its viewer count, title and stream links, from a username, profile or LIVE link, or user ID. A room on air has its current viewers, total entries, title, cover and start time, and HLS, DASH and HTTP-FLV links for every quality TikTok serves, with when each expires. Otherwise you get the latest room, ended. The host comes with its ID, secUid, display name, verified badge and follower count.

GET /v1/tiktok/live

Try it

Example

cURL
curl 'https://socialtap.dev/v1/tiktok/live?handle=aljazeeraenglish' \
  -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.tiktok.live.get({ handle: "aljazeeraenglish" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
Node.js (fetch)
const params = new URLSearchParams({
  handle: "aljazeeraenglish",
});
const res = await fetch(`https://socialtap.dev/v1/tiktok/live?${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/tiktok/live",
    params={"handle": "aljazeeraenglish"},
    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", "aljazeeraenglish")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/tiktok/live?"+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' => 'aljazeeraenglish',
]);
$ch = curl_init('https://socialtap.dev/v1/tiktok/live?' . $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/tiktok/live")
uri.query = URI.encode_www_form('handle' => 'aljazeeraenglish')
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("aljazeeraenglish");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/tiktok/live?" + 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("aljazeeraenglish"));
var res = await http.GetAsync("https://socialtap.dev/v1/tiktok/live?" + 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/tiktok/live")
        .query(&[("handle", "aljazeeraenglish")])
        .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": [],
    "category": null,
    "ended_at": null,
    "host": {
      "avatar_url": "https://p16-common-sign.tiktokcdn-us.com/tos-useast8-avt-0068-tx2/f569c9cd13cf1ccee624a4ae1b0b4c4e~tplv-tiktokx-cropcenter:1080:1080.webp?dr=9640&refresh_token=b70569e5&x-expires=4070908800&x-signature=SCRUBBED&t=4d5b0474&ps=13740610&shp=a5d48078&shcp=fdd36af4&idc=useast5",
      "display_name": "Al Jazeera English",
      "id": "7074562477175424046",
      "is_verified": true,
      "url": "https://www.tiktok.com/@aljazeeraenglish",
      "username": "aljazeeraenglish"
    },
    "id": "7703236637299444493",
    "metrics": {
      "concurrent_viewer_count": 4935,
      "like_count": null,
      "view_count": 926646
    },
    "platform": "tiktok",
    "platform_specific": {
      "tiktok": {
        "host_follower_count": 16752217,
        "host_sec_uid": "MS4wLjABAAAAtS2tPZtfESngqzjzrwwUu0M1LUlx1MjODxCDecgBvwBcyquIg56vBb_2I0BaW574",
        "is_age_restricted": null,
        "is_subscriber_only": false,
        "stream_id": "3579127593564111804"
      }
    },
    "post_id": null,
    "scheduled_start_at": null,
    "started_at": "2026-11-01T16:14:18Z",
    "status": "live",
    "streams": [
      {
        "bitrate_kbps": 10671,
        "expires_at": "2026-10-25T18:00:00Z",
        "format": "hls",
        "height": 1080,
        "is_audio_only": false,
        "quality": "Original",
        "url": "https://pull-hls-f16-tt01.tiktokcdn-us.com/game/stream-3579127593564111804/index.m3u8?expire=4070908800&sign=SCRUBBED",
        "video_codec": "h264",
        "width": 1920
      },
      {
        "bitrate_kbps": 10671,
        "expires_at": "2026-10-25T18:00:00Z",
        "format": "dash",
        "height": 1080,
        "is_audio_only": false,
        "quality": "Original",
        "url": "https://pull-f5-tt01.tiktokcdn-us.com/game/stream-3579127593564111804/index.mpd?auth_mode=2&expire=4070908800&sign=SCRUBBED",
        "video_codec": "h264",
        "width": 1920
      },
      {
        "bitrate_kbps": 10671,
        "expires_at": "2026-10-25T18:00:00Z",
        "format": "flv",
        "height": 1080,
        "is_audio_only": false,
        "quality": "Original",
        "url": "https://pull-f5-tt01.tiktokcdn-us.com/game/stream-3579127593564111804.flv?expire=4070908800&sign=SCRUBBED",
        "video_codec": "h264",
        "width": 1920
      }
    ],
    "text": null,
    "thumbnail_url": "https://p16-webcast.tiktokcdn-us.com/webcast-oci-tx/7628418490097126158~tplv-obj.image",
    "title": "Al Jazeera English TikTok LIVE",
    "unknown_fields": [],
    "url": "https://www.tiktok.com/@aljazeeraenglish/live"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "tiktok",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 476,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "profile",
      "id": "7703236637299444493",
      "url": "https://www.tiktok.com/@aljazeeraenglish/live"
    },
    "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

TikTok username with or without the @ (aljazeeraenglish, @aljazeeraenglish), a profile or LIVE page URL (tiktok.com/@aljazeeraenglish, tiktok.com/@aljazeeraenglish/live), or a numeric user ID (tiktok.com/share/user/<id> or the bare ID). Usernames are case-insensitive.

Examplealjazeeraenglish

handle takes TikTok 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 live object; meta describes the request (meta). Fields only TikTok has are under platform_specific.tiktok.

platformstring

Platform ID (tiktok, youtube, …).

idstring

Platform-native ID of the broadcast (string; TikTok room ID, YouTube video ID).

urlstring uri

Public page of the broadcast (TikTok: the host's LIVE page, tiktok.com/@<username>/live).

statusstring

live: on air now; scheduled: announced, not started; ended: over. New values may be added; treat an unknown value as not live.

One oflivescheduledended

titlestringnullable

The broadcast's title as the host set it.

textstringnullable

Description as plain text; null where the platform has none.

categorystringnullable

The topic or game the broadcast is filed under, as the platform names it.

hostobject

The broadcasting account.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

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

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

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

started_atstring date-timenullable

When the broadcast went on air, RFC 3339 UTC; null while scheduled or when not shown.

ended_atstring date-timenullable

When it went off air, RFC 3339 UTC; null while live or scheduled, and when the platform does not say.

scheduled_start_atstring date-timenullable

When a scheduled broadcast is due to start, RFC 3339 UTC; null when none was announced.

thumbnail_urlstring urinullable

Cover or preview image URL. Platform CDN URLs can expire within hours.

post_idstringnullable

ID of the post the platform keeps the broadcast as (equals post.id: a YouTube or Rumble video); null when it keeps none (TikTok LIVE) or none yet.

streamsobject[]

Playback links of the broadcast while live, one per rendition and format, best first; [] when not live or when the platform's links only work from SocialTap's network (YouTube).

ShowHide 9 child fields
qualitystringnullable

The platform's label for the rendition (Original, 1080p60, 720p, …).

formatstring

Delivery format of url: hls (an .m3u8 playlist), dash (an .mpd manifest, TikTok's CMAF) or flv (HTTP-FLV). New values may be added; treat unknown values as other.

One ofhlsdashflv

urlstring uri

Playback URL, signed and expiring: see expires_at.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown.

widthintegernullable

Width in pixels; null for audio-only or when not stated.

heightintegernullable

Height in pixels; null for audio-only or when not stated.

video_codecstringnullable

Video codec, lowercase (h264, h265); null for audio-only or when not stated.

bitrate_kbpsintegernullable

Target bitrate in kbit/s, when the platform states it.

is_audio_onlybooleannullable

The rendition carries sound only.

metricsobject

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

ShowHide 3 child fields
concurrent_viewer_countintegernullable

People watching now; null when not live or not shown.

view_countintegernullable

Cumulative views since the broadcast began (TikTok counts entries into the room).

like_countintegernullable

Likes or hearts; null when hidden or not exposed.

platform_specificobject

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

ShowHide 1 child field
tiktokobjectnullable

A TikTok LIVE room's own fields.

ShowHide 5 child fields
host_sec_uidstringnullable

The host's secUid, TikTok's account key that survives a rename.

host_follower_countintegernullable

The host's follower count at fetch time; null when hidden.

stream_idstringnullable

TikTok's ID of the room's current stream (in its playback links).

is_subscriber_onlybooleannullable

Only the host's paying subscribers can watch.

is_age_restrictedbooleannullable

Viewers must be of age to watch the room; null when the source does not show it.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text. A list path 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, private_or_unavailable and no_live 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: 2 error codes. 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.

no_liveNo retry

The account exists but has no live broadcast to show: nothing on air or scheduled, and no past broadcast the platform still shows.

Do not retry now. Ask again later, when the account may be live.

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; sources are tried cheapest first: Platform API → Public page.

SourcePrice per successful requestPer 1,000 requests
Any source1 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.
pagePublic pageData embedded in the platform's public web page.

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

Endpoint ID tiktok.live · operationId tiktok.live.get · Product overview

Last updated