TikTok Live Info
Structured TikTok data: send room_ids. Single lookup, 1 credit per successful call.
GET · POST1 credit / successful callSingle lookup
Overview
Section titled “Overview”Call GET /api/v2/tiktok-live-info/ with room_ids. The results are in data.room. 2 optional parameters refine the call (see Parameters).
Request
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/tiktok-live-info/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "room_ids=7523685855395842871" \ --max-time 210const params = new URLSearchParams({ room_ids: "7523685855395842871" });
const res = await fetch(`https://api.scrapier.io/api/v2/tiktok-live-info/?${params}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000),});const body = await res.json();if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
console.log(body.data.room);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/tiktok-live-info/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"room_ids": "7523685855395842871"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["room"])curl -X POST "https://api.scrapier.io/api/v2/tiktok-live-info/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"room_ids":"7523685855395842871"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
room_ids | string | yes | e.g. 7523685855395842871 | TikTok LIVE room_id. Lookup endpoint -- next_cursor null. |
cursor | string | no | — | Pagination cursor returned in the previous response's next_cursor. Pass it back unchanged to fetch the next page. When next_cursor is null, you have reached the last page. |
user_id | string | no | — | Owner cross-check. locked in cursor |
Advanced
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | false | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes. |
Response
Section titled “Response”{ "success": true, "data": { "room_ids": "7523685855395842871", "room": { "input_room_id": "7523685855395842871", "success": true, "error": null, "room_id": "7523685855395842871", "owner_id_mismatch": false, "is_live": false, "status": "ended", "title": "6'13 Grateful Streamer", "like_count": 0, "viewer_count": 0, "owner": { "id": "6742945285876515845", "username": "thejustalex", "display_name": "JustAlex", "follower_count": 720188, "verified": false }, "scraped_at": "2026-09-26T11:15:33.062Z" }, "next_cursor": null }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.room.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
room_ids | string | 7523685855395842871 | — |
room | object | {…} | The results. |
next_cursor | null | null | Pass back as cursor for the next page. null on the last page. |
room.input_room_id | string | 7523685855395842871 | — |
room.success | boolean | true | — |
room.error | null | null | — |
room.room_id | string | 7523685855395842871 | — |
room.owner_id_mismatch | boolean | false | — |
room.is_live | boolean | false | — |
room.status | string | ended | — |
room.title | string | 6'13 Grateful Streamer | — |
room.like_count | integer | 0 | — |
room.viewer_count | integer | 0 | — |
room.owner | object | {…} | — |
room.scraped_at | string | 2026-09-26T11:15:33.062Z | — |
Pagination
Section titled “Pagination”Returns everything in one call; next_cursor is always null.
Errors
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- The response data carries its own
successfield from the scraper. The outersuccessis what counts: an HTTP 200 with outersuccess: trueis billed, even if the inner field says otherwise.
Related
Section titled “Related”- TikTok Ad Library Leads — Structured TikTok data: every input is optional. Single lookup, 3 credits per successful call.
- TikTok Ad Library — Structured TikTok data: send
urls. Cursor-paginated, 1 credit per successful call. - TikTok Ads Top — Structured TikTok data: every input is optional. Cursor-paginated, 1 credit per successful call.
- TikTok Collection Videos — Structured TikTok data: send
urls. Cursor-paginated, 1 credit per successful call.