# TikTok account LIVE status API

> Whether a TikTok account is LIVE right now, by handle: the room ID, title, start time, people in the room now and people who have come in since it started, the cover and the host with followers. An account that is not live answers with status offline and its last room, where TikTok still shows it.

Canonical page: https://okdata.online/apis/tiktok/live/users/get/

- **Endpoint**: `GET /v1/tiktok/live/users/get`
- **ID**: `tiktok.live.users.get`
- **Price**: $0.002 per call
- **Returns**: one LiveRoom object (`data.item`)
- **Status**: preview
- **Good for**: Competitor monitoring

## Price

One call costs $0.002 and returns one live_room. 1,000 lookups cost $2.00. A lookup that reached the data source is charged even when it is not found or the source fails; calls stopped before reaching a source are free.

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `username` | string | yes |  | The handle, with or without @. (e.g. `maryruthorganics`) |
| `view` | string: brief / compact / standard / full | no | `standard` | How much of each object comes back. brief: IDs, title, the first 100 characters of the text, link, time and the main counts, for scanning a list (then get what you need by ID). compact leaves out empty fields and cuts long text at 500 characters. full adds platform-specific fields under ext. |
| `fields` | string[] | no |  | Fields to keep, by path (author.name), to save tokens. In a query string: comma-separated. |

cursor, view and fields work as described in [Requests](https://okdata.online/docs/requests/).

## Returned fields

Each item is a [LiveRoom](https://okdata.online/docs/objects/live_room/).

| Field | Type | Description |
|---|---|---|
| `id` | string \| null | The room's ID; the endpoints that read a room take it. Null where the platform names no room: an account that is not live, or a board entry that links to the host only. |
| `url` | string \| null | The room's web page; null where the platform gives the room none. |
| `status` | string | live: streaming now. offline: not streaming (the other fields then describe the last session, where the platform still shows it). |
| `title` | string \| null | The room's title as the host set it. |
| `category` | string \| null | The room's category or game, in the platform's words (Twitch's game, Bilibili's area); null where the platform gives none. |
| `cover_url` | string \| null | Cover image. |
| `host` | AccountRef | The host's public account. |
| `started_at` | string \| null | When the current (or last) session started, ISO 8601 in UTC. |
| `rank` | integer \| null | Place on the board, from 1; null outside boards. |
| `metrics` | LiveMetrics | Room-level counts at fetch time; a count the platform does not show is null. |
| `ext` | object | Platform-specific extras. Only returned with view=full. |

## Request examples

### cURL

```bash
curl -G "https://api.okdata.online/v1/tiktok/live/users/get" \
  -H "Authorization: Bearer $OKDATA_API_KEY" \
  --data-urlencode 'username=maryruthorganics'
```

### Python

```python
import os
import requests

resp = requests.get(
    "https://api.okdata.online/v1/tiktok/live/users/get",
    headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
    params={"username": "maryruthorganics"},
    timeout=60,
)
body = resp.json()
if body["code"] != "ok":
    raise RuntimeError(f"{body['code']}: {body['message']} (charged: {body['charged']})")

row = body["data"]["item"]
print(row["status"], row["title"], row["metrics"]["viewers"])
print("cost: $" + body["meta"]["billing"]["amount"])
```

### TypeScript

```ts
const url = new URL('https://api.okdata.online/v1/tiktok/live/users/get');
url.searchParams.set('username', "maryruthorganics");

const res = await fetch(url, {
  headers: {
    Authorization: `Bearer ${process.env.OKDATA_API_KEY}`,
  },
});
const body = await res.json();
if (body.code !== 'ok') throw new Error(`${body.code}: ${body.message}`);

const row = body.data.item;
console.log(row.status, row.title, row.metrics.viewers);
console.log('cost: $' + body.meta.billing.amount);
```

### MCP

```json
{
  "name": "call",
  "arguments": {
    "capability": "tiktok.live.users.get",
    "username": "maryruthorganics"
  }
}
```

Or ask an agent that has the MCP server connected:

> Use TikTok account LIVE status and tell me whether it is live now, how many people are watching and since when.

## Response example

```json
{
  "code": "ok",
  "request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
  "data": {
    "item": {
      "id": "7709227937228163870",
      "url": "https://www.tiktok.com/@trailkit/live",
      "status": "live",
      "title": "Winter camping gear deals LIVE",
      "category": null,
      "cover_url": "https://cdn.example.com/live/cover.jpg",
      "host": {
        "id": "6812345678901234567",
        "username": "trailkit",
        "name": "Trail Kit",
        "avatar_url": "https://cdn.example.com/avatar/trailkit.jpg",
        "followers": 182300,
        "verified": true
      },
      "started_at": "2026-11-19T01:12:00Z",
      "rank": null,
      "metrics": {
        "viewers": 161,
        "total_viewers": 51891,
        "likes": null,
        "heat": null,
        "products": null
      }
    }
  },
  "warnings": [],
  "meta": {
    "capability": "tiktok.live.users.get",
    "billing": {
      "amount": "0.002",
      "currency": "USD",
      "balance_after": "9.998"
    },
    "unavailable": {},
    "cached": false,
    "replayed": false,
    "fetched_at": "2026-11-11T08:00:00Z"
  }
}
```

## Errors

Errors share one shape: code, request_id, message and message_zh (a fixed sentence per code), charged, retry, retry_after_seconds, param and docs_url, with the specifics in problems. An error from a call that reached the data source (not found, a failure or a timeout of the source) is charged once at this endpoint's price, with charged: true and amount; errors before that, such as bad parameters, are not charged. Only settlement_unknown is unknown until looked up. The full table: https://okdata.online/docs/errors/

## Questions

### How much does the TikTok account LIVE status API cost?

One call costs $0.002 and returns one live_room. 1,000 lookups cost $2.00. A lookup that reached the data source is charged even when it is not found or the source fails; calls stopped before reaching a source are free.

### Do I need a TikTok account, cookies or a QR login?

No. You send only your okdata API key. The data is public data from TikTok; nothing is fetched with your own TikTok account.

### Am I charged when a call fails?

Yes, once, when the call reached the data source: an empty answer, a not_found, a failure or a timeout of the source costs one call (one item for per-item endpoints), and the error says charged: true with amount. Calls refused before reaching a source, such as bad parameters or a low balance, cost nothing.

### What if TikTok does not show a field?

The field is null, and meta.unavailable names it with the reason: platform (the platform never shows it) or capability (we cannot fetch it yet).

## More TikTok endpoints

- [TikTok video search](https://okdata.online/apis/tiktok/videos/search/): $0.002 per call · about 30 videos per page
- [TikTok video detail](https://okdata.online/apis/tiktok/videos/get/): $0.002 per call
- [TikTok video comments](https://okdata.online/apis/tiktok/videos/comments/list/): $0.002 per call · about 50 comments per page
- [TikTok account profile](https://okdata.online/apis/tiktok/users/get/): $0.002 per call
- [TikTok Ads Library search](https://okdata.online/apis/tiktok/ads/search/): $0.004 per call · about 12 ads per page
- [TikTok Creative Center top ads](https://okdata.online/apis/tiktok/creative_center/ads/search/): $0.002 per call · about 20 ads per page
- [TikTok Shop product search](https://okdata.online/apis/tiktok/shop/products/search/): $0.004 per call · about 20 products per page
- [TikTok Shop product detail](https://okdata.online/apis/tiktok/shop/products/get/): $0.002 per call
- [TikTok Shop product reviews](https://okdata.online/apis/tiktok/shop/products/reviews/list/): $0.002 per call · about 20 reviews per page
- [TikTok video transcript](https://okdata.online/apis/tiktok/videos/transcript/get/): $0.002 per call
- [TikTok comment replies](https://okdata.online/apis/tiktok/comments/replies/list/): $0.002 per call · about 20 comments per page
- [TikTok account search](https://okdata.online/apis/tiktok/users/search/): $0.002 per call · about 30 accounts per page
- [TikTok account videos](https://okdata.online/apis/tiktok/users/videos/list/): $0.002 per call · about 10 videos per page
- [TikTok Creative Center top ad](https://okdata.online/apis/tiktok/creative_center/ads/get/): $0.002 per call
- [TikTok Shop seller products](https://okdata.online/apis/tiktok/shop/sellers/products/list/): $0.002 per call · about 20 products per page
- [TikTok account followers](https://okdata.online/apis/tiktok/users/followers/list/): $0.002 per call · about 20 accounts per page
- [TikTok hashtag videos](https://okdata.online/apis/tiktok/hashtags/videos/list/): $0.002 per call · about 20 videos per page
- [TikTok LIVE shopping bag](https://okdata.online/apis/tiktok/live/rooms/products/list/): $0.002 per call · about 15 products per page
- [TikTok LIVE shopping ranking](https://okdata.online/apis/tiktok/live/streamers/trending/): $0.002 per call · about 99 results per page

## At a glance

- **Short name**: TikTok account LIVE status
- **Also called**: is tiktok user live, tiktok live viewers, tiktok live room info
- **Category**: [Social media](https://okdata.online/categories/social/)
- **Status**: preview. It may still change; any change is announced beforehand.
- **Price**: $0.002 per call · bad parameters are free
- **Returns**: One LiveRoom, as data.item
- **If a call fails**: Charged once. When a data source fails, the next one is tried. A call that reached a source is charged once even if it fails; bad parameters are free.

## When it is charged

- Data comes back: $0.002 per call
- Bad parameters, too little balance, a paused endpoint: Free

| When | Charge |
|---|---|
| Most one call costs | $0.002 |
| An empty answer | $0.002 |
| Not found (the platform has no such item) | $0.002 |
| The data source fails or times out | $0.002 |
| Bad parameters, too little balance, a paused endpoint | Free |
| Resent with the same Idempotency-Key within 24 hours | Free when the kept result comes back |

A call that reached the data source costs $0.002 even when the answer is empty, not found or a failure of the source; a call stopped before that, such as for bad parameters, is free.

Prices from price book 53dd8ce13c359590. [Every price on this platform](https://okdata.online/pricing/tiktok/)

- New accounts get $0.10 of credit, no card needed: 50 calls to this endpoint.
- 1,000 lookups cost $2.00.

## Fields by view

The view column is the smallest `view` a field comes back in: `compact` returns only compact fields, `standard` adds the standard ones, `full` returns everything. The default is `standard`.

- `compact`: `id`, `url`, `status`, `title`, `category`, `host`, `started_at`, `rank`, `metrics`
- `standard`: `cover_url`
- `full`: `ext`

## Common errors on this endpoint

| HTTP | Code | Meaning | Charged | Retry |
|---|---|---|---|---|
| 400 | `invalid_params` | A parameter is missing, has the wrong type or value, or the method is wrong. problems lists each one; param names the first. | no | after a fix |
| 401 | `unauthorized` | The key is missing, malformed, revoked, disabled or expired (reason says which when known). | no | no |
| 402 | `insufficient_balance` | The balance (available) cannot cover the most this call could cost (required). | no | after a fix |
| 404 | `not_found` | The post, account or page does not exist or is not public. When the data source billed the lookup, or the endpoint's charge_when_not_found is above 0, this answer is charged: the body then says charged: true and amount. | once, if it reached a data source | no |
| 429 | `rate_limited` | The account sent too many requests this minute (reason: rate) or has too many calls running (reason: concurrency). | no | yes |
| 500 | `settlement_unknown` | The data came back, but the charge could not be confirmed. | unknown until looked up | with the same Idempotency-Key |
| 502 | `upstream_failed` | Every data source for this endpoint failed on this request. If a source billed the attempt, it is charged once at the endpoint's price (charged: true and amount); otherwise nothing is charged. | once, if it reached a data source | yes |
| 503 | `capability_paused` | This endpoint is paused right now; nothing ran. | no | yes |
| 504 | `timeout` | The data did not come back in time. If the request had reached a data source that bills it, it is charged once at the endpoint's price (charged: true and amount); otherwise the hold is released. | once, if it reached a data source | yes |

[All error codes](https://okdata.online/docs/errors/)

## Use it in your AI

> Read https://okdata.online/apis/tiktok/live/users/get.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use TikTok account LIVE status and tell me whether it is live now, how many people are watching and since when.

## TikTok endpoints by group

- [TikTok Creative Center API](https://okdata.online/apis/tiktok/creative_center/): TikTok Creative Center top ads $0.002, TikTok Creative Center top ad $0.002
- [TikTok Shop API](https://okdata.online/apis/tiktok/shop/): TikTok Shop product search $0.004, TikTok Shop product detail $0.002, TikTok Shop product reviews $0.002, TikTok Shop seller products $0.002
