For AI

DouyinSocial media

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.

GEThttps://api.okdata.online/v1/douyin/live/rooms/get

Also calleddouyin live stream datadouyin live viewersdouyin live room info

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.
Status
preview
It may still change; any change is announced beforehand.

Parameters

NameTypeDescription
idstringThe 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
urlstringA live.douyin.com link to the room, as copied. e.g. https://live.douyin.com/80017709309
viewstringbriefcompactstandardfullHow 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. default standard
fieldsstring[]Fields to keep, by path (author.name), to save tokens. In a query string: comma-separated.

Give exactly one of id, url. cursor, view and fields work the same on every endpoint: how requests work.

Request

cURL

curl -G "https://api.okdata.online/v1/douyin/live/rooms/get" \
  -H "Authorization: Bearer $OKDATA_API_KEY" \
  --data-urlencode 'id=80017709309'

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

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);

MCPtools/call

{
  "name": "call",
  "arguments": {
    "capability": "douyin.live.rooms.get",
    "id": "80017709309"
  }
}

Response

200 · application/jsonmeta.billing.amount = 0.002
{
  "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"
  }
}

Try it

This sends a real call to https://api.okdata.online and is billed as usual: at most $0.002, also when the data source comes back empty, not found or failed. Bad parameters are never charged. Your key goes only to that address and is never stored on this site.

Known limits

  • Give exactly one of id, url.

Returned fields

data.item is one LiveRoom.

FieldTypeViewDescription
idstring | nullcompactThe 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.
urlstring | nullcompactThe room's web page; null where the platform gives the room none.
statusstringcompactlive: streaming now. offline: not streaming (the other fields then describe the last session, where the platform still shows it).
titlestring | nullcompactThe room's title as the host set it.
categorystring | nullcompactThe room's category or game, in the platform's words (Twitch's game, Bilibili's area); null where the platform gives none.
cover_urlstring | nullstandardCover image.
Show all 11 fieldsHide the other 5
FieldTypeViewDescription
hostAccountRefcompactThe host's public account.
started_atstring | nullcompactWhen the current (or last) session started, ISO 8601 in UTC.
rankinteger | nullcompactPlace on the board, from 1; null outside boards.
metricsLiveMetricscompactRoom-level counts at fetch time; a count the platform does not show is null.
extobjectfullPlatform-specific extras. Only returned with view=full.

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.

When it is charged

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.

Data comes back$0.002 per call

Bad parameters, too little balance, a paused endpointFree

WhenCharge
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 endpointFree
Resent with the same Idempotency-Key within 24 hoursFree 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 →

Common errors

Every error has the same shape and says whether it was charged. The ones this endpoint can return:

HTTPCodeMeaningCharged
400invalid_paramsA parameter is missing, has the wrong type or value, or the method is wrong. problems lists each one; param names the first.Retry: after a fixno
401unauthorizedThe key is missing, malformed, revoked, disabled or expired (reason says which when known).Retry: nono
402insufficient_balanceThe balance (available) cannot cover the most this call could cost (required).Retry: after a fixno
404not_foundThe 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.Retry: noonce, if it reached a data source
429rate_limitedThe account sent too many requests this minute (reason: rate) or has too many calls running (reason: concurrency).Retry: yesno
500settlement_unknownThe data came back, but the charge could not be confirmed.Retry: with the same Idempotency-Keyunknown until looked up
502upstream_failedEvery 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.Retry: yesonce, if it reached a data source
503capability_pausedThis endpoint is paused right now; nothing ran.Retry: yesno
504timeoutThe 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.Retry: yesonce, if it reached a data source

All error codes →

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).

Use it in your AI

Paste this into Claude, ChatGPT, Cursor or any agent that can open a web page. It reads this endpoint’s page and calls it with your key.

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.

With the MCP server connected, just ask: Use Douyin live room and tell me whether it is live now, how many people are watching and since when.

All 42 Douyin endpoints

Douyin API overview →Douyin API pricing →

Names and ID

Name
Douyin live room API
Short name
Douyin live room
ID
douyin.live.rooms.get
Endpoint
GET /v1/douyin/live/rooms/get
Category
Social media
Also called
douyin live stream data, douyin live viewers, douyin live room info
Returns
LiveRoom: 11 fields

Connect once, then just ask.

Every new key comes with $0.10 to try it. One sentence connects your agent.

Start free
Connect your AI

Paste this into your agent

Read https://okdata.online/agents.md and set up okdata for me; my key is in the OKDATA_API_KEY environment variable.

Claude Code, Cursor, Codex and other agents that can open a link set themselves up from it.

MCP serverhttps://api.okdata.online/mcp