> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# TikTok Live Info

Structured TikTok data: send `room_ids`. Single lookup, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/tiktok-live-info/` · 1 credit per successful call · Single lookup

## 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

```bash
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 210
```

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

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `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. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `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

HTTP 200. Results are in `data.room`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "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
  }
}
```

## 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

Single lookup: everything comes back in one call and `next_cursor` is always `null`.

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- The response data carries its own `success` field from the scraper. The outer `success` is what counts: an HTTP 200 with outer `success: true` is billed, even if the inner field says otherwise.

## Related

- [TikTok Ad Library Leads](https://docs.scrapier.io/api-reference/tiktok/tiktok-ad-library-leads.md): Structured TikTok data: every input is optional. Single lookup, 3 credits per successful call.
- [TikTok Ad Library](https://docs.scrapier.io/api-reference/tiktok/tiktok-ads.md): Structured TikTok data: send `urls`. Cursor-paginated, 1 credit per successful call.
- [TikTok Ads Top](https://docs.scrapier.io/api-reference/tiktok/tiktok-ads-top.md): Structured TikTok data: every input is optional. Cursor-paginated, 1 credit per successful call.
- [TikTok Collection Videos](https://docs.scrapier.io/api-reference/tiktok/tiktok-collection-videos.md): Structured TikTok data: send `urls`. Cursor-paginated, 1 credit per successful call.
