Get a TikTok user's live room

Try in Playground

Read a user's live page state: whether the account is live now, the streamer's user record with counters, and the room (title, cover, start time, status, viewer stats, stream and HEVC stream data with FLV, HLS and CMAF URLs per quality).

GET/v1/tiktok/user/livex-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

TikTok username.

max 25 chars

Exampleexample

Response fields

requestIdstring

Request correlation UUID.

Upstream calls made (the document, redirect hops, feed calls, the caption file, and every retried session), decoded bytes delivered to the parser and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable data is returned; inspect status and coverage for omissions.

statusenum

success, partial, failed, or challenged. HTTP 200 can be partial.

one of: success, partial

sourceUrlstring

The www.tiktok.com document the operation was issued from (profile, video, live, search, tag, music or explore page), after accepted redirects.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

source is document (server-rendered state) or public_api (a feed call); complete means nothing was capped; warnings name each cap or fallback.

coverage.sourceenum

Always included.

one of: document, public_api

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

is_liveboolean

True when the room status is 2 (live now).

{user, stats}: the streamer's web user record (id, uniqueId, nickname, secUid, verified, signature, avatars, roomId, status) and followerCount/followingCount.

Always included.

liveRoomUserInfo.user.idstring

Always included.

liveRoomUserInfo.user.uniqueIdstring

Always included.

liveRoomUserInfo.user.nicknamestring

Always included.

liveRoomUserInfo.user.secUidstring

Always included.

liveRoomUserInfo.user.verifiedboolean

Always included.

liveRoomUserInfo.statsobject

Always included.

liveRoomobjectnullable

TikTok's room record: coverUrl, title, startTime, status (2 live, 4 ended), paidEvent, liveSubOnly, liveRoomMode, hashTagId, gameTagId, liveRoomStats, streamData and hevcStreamData (pull_data with options and the stream_data JSON), streamId and multi-stream fields; null when the account has no room.

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
400	`invalid_request`	Missing, duplicate, ambiguous or unsupported parameters, unsupported URL forms, handles, cursors, regions, sorts or languages.
401	`unauthorized`	Invalid API key.
403	`restricted_page`	TikTok restricts the account or post (private video, private account, region block, or a redirect to its login page).
404	`not_found`	Unknown or removed account, post, hashtag or sound, a post without captions, or a TikTok status code naming a missing resource.
429	`upstream_rate_limited`	TikTok rate limited the request.
502	`upstream_challenged`	TikTok answered its verification page, an HTTP 401/403, a document without the app state, or refused a feed call with an empty body (status challenged).
502	`unsafe_redirect`	TikTok redirected outside the requested resource.
502	`unsupported_page`	Layout, identity or feed-envelope checks failed, or a non-JSON feed answer was served.
502	`response_too_large`	The upstream response exceeded 4 MiB (512 KiB for caption files).
502	`payload_too_complex`	The embedded JSON exceeded parsing limits.
502	`request_limit`	The upstream call budget was exhausted.
502	`upstream_error`	Network failure, a stalled exit, an unexpected upstream status after one retry, or an unexpected TikTok status code.
503	`busy`	All retrieval slots are occupied.
504	`timeout`	The 90-second deadline elapsed.

Code example

curl "https://api.scrapeatlas.com/v1/tiktok/user/live?handle=example" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/tiktok/user/live?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/tiktok/user/live?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(`TikTok request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/tiktok/user/live",
    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/tiktok/user/live?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/tiktok/user/live?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.

{
  "success": true,
  "is_live": true,
  "liveRoomUserInfo": {
    "user": {
      "avatarLarger": "https://media.example.test/9a51f64117.jpeg",
      "avatarMedium": "https://media.example.test/46f9435b80.jpeg",
      "avatarThumb": "https://media.example.test/3b718c3725.jpeg",
      "id": "7000000000000000003",
      "nickname": "Example Streamer",
      "secUid": "MS4wLjABAAAAexamplestreamer",
      "secret": false,
      "uniqueId": "examplestreamer",
      "verified": false,
      "roomId": "7100000000000000005",
      "signature": "Example signature 25",
      "status": 4,
      "followStatus": 0
    },
    "stats": {
      "followingCount": 2453,
      "followerCount": 2197
    }
  },
  "liveRoom": {
    "coverUrl": "https://media.example.test/46f9435b80.jpeg",
    "squareCoverImg": "",
    "title": "Example live title",
    "startTime": 1700034523,
    "status": 2,
    "paidEvent": {
      "event_id": 0,
      "paid_type": 0
    },
    "liveSubOnly": 0,
    "liveRoomMode": 6,
    "hashTagId": 5,
    "gameTagId": 110,
    "liveRoomStats": {
      "enterCount": 1,
      "userCount": 1
    },
    "streamData": {
      "pull_data": {
        "options": {
          "default_preview_quality": {
            "icon_type": 0,
            "level": 0,
            "name": "",
            "resolution": "",
            "sdk_key": "",
            "v_codec": ""
          },
          "default_quality": {
            "icon_type": 0,
            "level": 0,
            "name": "720p",
            "resolution": "",
            "sdk_key": "hd",
            "v_codec": ""
          },
          "forced_low_latency": false,
          "max_drm_lenient_size": "",
          "max_drm_lenient_size_backup": "",
          "qualities": [
            {
              "icon_type": 3,
              "level": 3,
              "name": "720p",
              "resolution": "",
              "sdk_key": "hd",
              "v_codec": ""
            }
          ],
          "show_quality_button": false,
          "support_low_latency": false
        },
        "stream_data": "example-stream-data-27"
      },
      "push_data": {
        "push_stream_level": 0,
        "resolution_params": {},
        "stream_data": ""
      }
    },
    "streamId": "7100000000000000006",
    "multiStreamScene": 0,
    "multiStreamSource": 0,
    "hevcStreamData": {
      "pull_data": {
        "options": {
          "default_preview_quality": {
            "icon_type": 0,
            "level": 0,
            "name": "",
            "resolution": "",
            "sdk_key": "",
            "v_codec": ""
          },
          "default_quality": {
            "icon_type": 0,
            "level": 0,
            "name": "540p",
            "resolution": "",
            "sdk_key": "sd",
            "v_codec": ""
          },
          "forced_low_latency": false,
          "max_drm_lenient_size": "",
          "max_drm_lenient_size_backup": "",
          "qualities": [
            {
              "icon_type": 6,
              "level": 10,
              "name": "Original",
              "resolution": "",
              "sdk_key": "origin",
              "v_codec": ""
            }
          ],
          "show_quality_button": false,
          "support_low_latency": false
        },
        "stream_data": "example-stream-data-28"
      },
      "push_data": {
        "push_stream_level": 0,
        "resolution_params": {},
        "stream_data": ""
      }
    }
  },
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000000",
  "sourceUrl": "https://www.tiktok.com/@examplestreamer/live",
  "fetchedAt": "2026-09-12T12:00:00.000Z",
  "coverage": {
    "source": "document",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 262144,
    "durationMs": 4200
  }
}

Missing, duplicate, ambiguous or unsupported parameters, unsupported URL forms, handles, cursors, regions, sorts or languages.

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