# Douyin live room API

> A Douyin live room right now, by its room number or live.douyin.com link: whether it is live, title, host, start time, people in the room now, people who have come in since it started, likes, how many products are in its shopping bag, and the cover. A room that is not live answers with status offline.

Canonical page: https://okdata.online/apis/douyin/live/rooms/get/

- **Endpoint**: `GET /v1/douyin/live/rooms/get`
- **ID**: `douyin.live.rooms.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 |
|---|---|---|---|---|
| `id` | string | no |  | The room number: the digits in a live.douyin.com/… link. It stays the same from one session to the next. Give id or url. (e.g. `80017709309`) |
| `url` | string | no |  | A live.douyin.com link to the room, as copied. (e.g. `https://live.douyin.com/80017709309`) |
| `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. |

Give id or url; one of the two is enough. 
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/douyin/live/rooms/get" \
  -H "Authorization: Bearer $OKDATA_API_KEY" \
  --data-urlencode 'id=80017709309'
```

### Python

```python
import os
import requests

resp = requests.get(
    "https://api.okdata.online/v1/douyin/live/rooms/get",
    headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
    params={"id": "80017709309"},
    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/douyin/live/rooms/get');
url.searchParams.set('id', "80017709309");

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": "douyin.live.rooms.get",
    "id": "80017709309"
  }
}
```

Or ask an agent that has the MCP server connected:

> Use Douyin live room 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": "80017709309",
      "url": "https://live.douyin.com/80017709309",
      "status": "live",
      "title": "冬季露营装备专场",
      "category": null,
      "cover_url": "https://cdn.example.com/live/cover.jpg",
      "host": {
        "id": "MS4wLjABAAAAq8Xw2mKpT0",
        "username": "qingzhuang_tubu",
        "name": "轻装徒步",
        "avatar_url": "https://cdn.example.com/avatar/trailkit.jpg",
        "followers": 182300,
        "verified": true
      },
      "started_at": "2026-11-19T01:12:00Z",
      "rank": null,
      "metrics": {
        "viewers": 5133,
        "total_viewers": 100000,
        "likes": 274097,
        "heat": null,
        "products": 349
      }
    }
  },
  "warnings": [],
  "meta": {
    "capability": "douyin.live.rooms.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 Douyin live room 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.

### Can I pass a share link instead of an ID?

Yes. Put the link in url and okdata reads the ID from it. Short share links work too.

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

No. You send only your okdata API key. The data is public data from Douyin; nothing is fetched with your own Douyin 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 Douyin 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 Douyin endpoints

- [Douyin video search](https://okdata.online/apis/douyin/videos/search/): $0.02 per call · about 20 videos per page
- [Douyin video detail](https://okdata.online/apis/douyin/videos/get/): $0.002 per call
- [Douyin video comments](https://okdata.online/apis/douyin/videos/comments/list/): $0.002 per call · about 20 comments per page
- [Douyin account profile](https://okdata.online/apis/douyin/users/get/): $0.002 per call
- [Douyin account videos](https://okdata.online/apis/douyin/users/videos/list/): $0.002 per call · about 20 videos per page
- [Douyin hot search board](https://okdata.online/apis/douyin/trends/list/): $0.002 per call · about 50 board entries per page
- [Douyin Xingtu creator search](https://okdata.online/apis/douyin/xingtu/creators/search/): $0.004 per call · about 20 creators per page
- [Douyin Xingtu creator rate card](https://okdata.online/apis/douyin/xingtu/creators/rates/get/): $0.04 per call
- [Douyin comment replies](https://okdata.online/apis/douyin/comments/replies/list/): $0.002 per call · about 20 comments per page
- [Douyin hashtag videos](https://okdata.online/apis/douyin/hashtags/videos/list/): $0.002 per call · about 10 videos per page
- [Douyin account search](https://okdata.online/apis/douyin/users/search/): $0.002 per call · about 30 accounts per page
- [Douyin video play count](https://okdata.online/apis/douyin/videos/metrics/): $0.002 per call
- [Douyin related videos](https://okdata.online/apis/douyin/videos/related/): $0.002 per call · about 10 videos per page
- [Douyin video boards](https://okdata.online/apis/douyin/videos/trending/): $0.002 per call · about 9 videos per page
- [Douyin search suggestions](https://okdata.online/apis/douyin/keywords/related/): $0.02 per call · about 10 results per page
- [Douyin index: brand trends](https://okdata.online/apis/douyin/index/brands/history/): $0.002 per call
- [Douyin index: brand vs industry](https://okdata.online/apis/douyin/index/brands/metrics/): $0.002 per call
- [Douyin index: account top videos](https://okdata.online/apis/douyin/index/creators/videos/list/): $0.002 per call · about 20 videos per page
- [Douyin index: account followers](https://okdata.online/apis/douyin/index/creators/audience/get/): $0.002 per call
- [Douyin index: account daily averages](https://okdata.online/apis/douyin/index/creators/metrics/): $0.002 per call
- [Douyin index: keyword audience](https://okdata.online/apis/douyin/index/keywords/audience/get/): $0.002 per call
- [Douyin index: keyword trends](https://okdata.online/apis/douyin/index/keywords/history/): $0.006 per call · about 1 results per page
- [Douyin index: related keywords](https://okdata.online/apis/douyin/index/keywords/related/): $0.002 per call · about 170 results per page
- [Douyin index: live hot topics](https://okdata.online/apis/douyin/index/trends/list/): $0.002 per call · about 30 board entries per page
- [Douyin index: top videos for a keyword](https://okdata.online/apis/douyin/index/videos/search/): $0.002 per call · about 20 videos per page
- [Douyin account growth](https://okdata.online/apis/douyin/users/history/): $0.002 per call
- [Douyin Xingtu creator profile](https://okdata.online/apis/douyin/xingtu/creators/get/): $0.004 per call
- [Douyin Xingtu creator audience](https://okdata.online/apis/douyin/xingtu/creators/audience/get/): $0.004 per call
- [Douyin Xingtu creator reach](https://okdata.online/apis/douyin/xingtu/creators/metrics/): $0.004 per call
- [Douyin Xingtu creator videos](https://okdata.online/apis/douyin/xingtu/creators/videos/list/): $0.004 per call · about 20 videos per page
- [Douyin Xingtu creator keywords](https://okdata.online/apis/douyin/xingtu/creators/keywords/get/): $0.002 per call
- [Douyin Xingtu creator scores](https://okdata.online/apis/douyin/xingtu/creators/scores/get/): $0.008 per call
- [Douyin Xingtu creator content mix](https://okdata.online/apis/douyin/xingtu/creators/content_mix/get/): $0.004 per call
- [Douyin Xingtu creator conversion](https://okdata.online/apis/douyin/xingtu/creators/conversion/get/): $0.004 per call
- [Douyin Xingtu marketing calendar](https://okdata.online/apis/douyin/xingtu/campaigns/list/): $0.004 per call · about 40 results per page
- [Douyin Xingtu video report](https://okdata.online/apis/douyin/xingtu/videos/get/): $0.004 per call
- [Douyin account videos (backup)](https://okdata.online/apis/douyin/backup/users/videos/list/): $0.0025 per call · about 20 videos per page
- [Douyin video search (backup)](https://okdata.online/apis/douyin/backup/videos/search/): $0.03 per call · about 8 videos per page
- [Douyin account live status](https://okdata.online/apis/douyin/live/users/get/): $0.004 per call
- [Douyin live streamer boards](https://okdata.online/apis/douyin/live/streamers/trending/): $0.006 per call · about 100 results per page
- [Douyin streamer live figures](https://okdata.online/apis/douyin/live/streamers/metrics/): $0.04 per call

## At a glance

- **Short name**: Douyin live room
- **Also called**: douyin live stream data, douyin live viewers, douyin 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/douyin/)

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

## Known limits

- Give exactly one of `id`, `url`.

## 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/douyin/live/rooms/get.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use Douyin live room and tell me whether it is live now, how many people are watching and since when.

## Douyin endpoints by group

- [Douyin Xingtu API](https://okdata.online/apis/douyin/xingtu/): Douyin Xingtu creator search $0.004, Douyin Xingtu creator rate card $0.04, Douyin Xingtu creator profile $0.004, Douyin Xingtu creator audience $0.004, Douyin Xingtu creator reach $0.004, Douyin Xingtu creator videos $0.004, Douyin Xingtu creator keywords $0.002, Douyin Xingtu creator scores $0.008, Douyin Xingtu creator content mix $0.004, Douyin Xingtu creator conversion $0.004, Douyin Xingtu marketing calendar $0.004, Douyin Xingtu video report $0.004
- [Douyin Ocean Engine index API](https://okdata.online/apis/douyin/index/): Douyin index: brand trends $0.002, Douyin index: brand vs industry $0.002, Douyin index: account top videos $0.002, Douyin index: account followers $0.002, Douyin index: account daily averages $0.002, Douyin index: keyword audience $0.002, Douyin index: keyword trends $0.006, Douyin index: related keywords $0.002, Douyin index: live hot topics $0.002, Douyin index: top videos for a keyword $0.002
