TikTok LIVE Search
Structured TikTok data: send keywords. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “Overview”Call GET /api/v2/tiktok-live-search/ with keywords. The results are in data.live_streams; send data.next_cursor back as cursor to get the next page. 1 optional parameter refines the call (see Parameters).
Request
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/tiktok-live-search/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "keywords=gaming" \ --max-time 210const params = new URLSearchParams({ keywords: "gaming" });
const res = await fetch(`https://api.scrapier.io/api/v2/tiktok-live-search/?${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.live_streams);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/tiktok-live-search/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"keywords": "gaming"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["live_streams"])curl -X POST "https://api.scrapier.io/api/v2/tiktok-live-search/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"keywords":"gaming"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
keywords | string | yes | e.g. gaming | Live-stream search keyword. Required first call; ignored when cursor is supplied. |
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. |
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": { "keyword": "gaming", "page": 1, "page_size": 20, "live_streams": [ { "id_str": "7654887162021710622", "title": "Fort UNC!!!", "user_count": 1583, "owner": { "nickname": "GVOMir", "id": "6841234567890123456" }, "stats": { "total_user": 45210, "like_count": 12300 }, "hashtag": { "title": "fortnite" }, "keyword": "gaming", "scraped_at": "2026-06-24T12:00:00.000Z" } ], "next_cursor": "eyJrIjoiZ2FtaW5nIiwicyI6WyI3NjU0ODg3MTYyMDIxNzEwNjIyIl0sInAiOjJ9" }}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.live_streams.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
keyword | string | gaming | — |
page | integer | 1 | — |
page_size | integer | 20 | — |
live_streams | array | [1 item] | The results. |
next_cursor | string | eyJrIjoiZ2FtaW5nIiwicyI6WyI3NjU0ODg3MTYyMDIxN… | Pass back as cursor for the next page. null on the last page. |
live_streams[].id_str | string | 7654887162021710622 | — |
live_streams[].title | string | Fort UNC!!! | — |
live_streams[].user_count | integer | 1583 | — |
live_streams[].owner | object | {…} | — |
live_streams[].stats | object | {…} | — |
live_streams[].hashtag | object | {…} | — |
live_streams[].keyword | string | gaming | — |
live_streams[].scraped_at | string | 2026-06-24T12:00:00.000Z | — |
Pagination
Section titled “Pagination”Pass data.next_cursor back as cursor until it is null. Required inputs are ignored once a cursor is sent. Each page is one billed call. More in Pagination.
const url = "https://api.scrapier.io/api/v2/tiktok-live-search/";let params = { keywords: "gaming" };const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call const res = await fetch(`${url}?${new URLSearchParams(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}`); const data = body.data; items.push(...(data.live_streams ?? [])); if (!data.next_cursor) break; // null = last page params = { cursor: data.next_cursor };}import requests
URL = "https://api.scrapier.io/api/v2/tiktok-live-search/"HEADERS = {"X-API-Key": "YOUR_API_KEY"}params = {"keywords": "gaming"}items = []
for _ in range(10): # each page is one billed call resp = requests.get(URL, headers=HEADERS, params=params, timeout=210) resp.raise_for_status() data = resp.json()["data"] items.extend(data.get("live_streams") or []) if not data.get("next_cursor"): # None = last page break params = {"cursor": data["next_cursor"]}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 |
- Nothing special: send the inputs, read the result.
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.