# Douyin live streamer boards API

> Douyin's live streamer boards as Xingtu publishes them, the latest daily, weekly or monthly one, 100 streamers each: the live-selling board by product category (sales and GPM bands, products sold), the top entertainment and gaming streamers (sessions, average views, engagement) and the fastest-growing ones (followers gained). Each with rank, name, avatar, followers and the Xingtu creator ID that douyin.live.streamers.metrics takes.

Canonical page: https://okdata.online/apis/douyin/live/streamers/trending/

- **Endpoint**: `GET /v1/douyin/live/streamers/trending`
- **ID**: `douyin.live.streamers.trending`
- **Price**: $0.006 per call · about 100 results per page
- **Returns**: a page of about 100 results (`data.items`, LiveStreamer objects)
- **Status**: preview
- **Good for**: Creator discovery, Trend research

## Price

One call costs $0.006 and returns one page of about 100 results. Collecting 1,000 results takes about 10 calls, $0.06 in total. Each page is a separate call. A call that reached the data source is charged even when it comes back empty, not found or failed; calls stopped before reaching a source are free.

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `board` | string: sales / top_entertainment / top_gaming / rising_entertainment / rising_gaming | no | `sales` | Which board: live selling by sales in a product category (the default), top entertainment or gaming streamers by followers and views, or the entertainment or gaming streamers who gained the most followers live. |
| `period` | string: day / week / month | no | `day` | The latest daily, weekly or monthly board (the default is the day before). |
| `category` | string: apparel / shoes / bags / beauty / personal_care / home / appliances / electronics / snacks / alcohol | no | `apparel` | For board=sales: the product category (apparel, shoes, bags, beauty and fragrance, personal care, home and daily goods, appliances, phones and electronics, snacks, alcohol). Ignored by the other boards. |
| `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 [LiveStreamer](https://okdata.online/docs/objects/live_streamer/).

| Field | Type | Description |
|---|---|---|
| `id` | string | The streamer's ID on the board's source: the Xingtu creator ID on Douyin (what douyin.live.streamers.metrics takes), the user ID on TikTok. |
| `url` | string \| null | The streamer's page, where there is one. |
| `username` | string \| null | Handle, where the board gives one. |
| `name` | string \| null | Display name; null where the source gives none (douyin.live.streamers.metrics). |
| `avatar_url` | string \| null | Avatar image URL. |
| `followers` | integer \| null | Followers. |
| `rank` | integer \| null | Place on the board, from 1; null outside boards. |
| `score` | number \| null | The board's score: TikTok's points, or Xingtu's score from 0 to 1. |
| `category` | string \| null | Content or product category, in the platform's words. |
| `room_id` | string \| null | The room the streamer is live in now, where the board gives it. |
| `days` | integer \| null | Days the figures cover; null when the board does not say. |
| `sessions` | integer \| null | Live sessions in the period. |
| `avg_views` | integer \| null | Average views a session. |
| `avg_unique_viewers` | integer \| null | Average people who watched a session. |
| `avg_viewers` | integer \| null | Average people watching at once. |
| `peak_viewers` | integer \| null | Most people watching at once. |
| `avg_watch_seconds` | integer \| null | Average seconds a viewer stayed. |
| `new_followers` | integer \| null | Followers gained live in the period. |
| `engagement_rate` | Band \| null | Engagement rate as the platform works it out, 0 to 1, as a band. |
| `gmv` | Band \| null | Sales over the period, in yuan, as a band. |
| `avg_gmv` | Band \| null | Average sales a session, in yuan, as a band. |
| `gpm` | Band \| null | Sales per thousand views (GPM), in yuan, as a band. |
| `avg_price` | Band \| null | Average price of the products sold, in yuan, as a band. |
| `products` | integer \| null | Products sold live in the period. |
| `ext` | object | Platform-specific extras. Only returned with view=full. |

## Request examples

### cURL

```bash
curl "https://api.okdata.online/v1/douyin/live/streamers/trending" \
  -H "Authorization: Bearer $OKDATA_API_KEY"
```

### Python

```python
import os
import requests

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

for row in body["data"]["items"]:
    print(row["rank"], row["name"], row["followers"])
print("cost: $" + body["meta"]["billing"]["amount"])
```

### TypeScript

```ts
const url = new URL('https://api.okdata.online/v1/douyin/live/streamers/trending');

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

for (const row of body.data.items) {
  console.log(row.rank, row.name, row.followers);
}
console.log('cost: $' + body.meta.billing.amount);
```

### MCP

```json
{
  "name": "call",
  "arguments": {
    "capability": "douyin.live.streamers.trending"
  }
}
```

Or ask an agent that has the MCP server connected:

> Use Douyin live streamer boards and list the top ten streamers with their followers and figures.

## Response example

```json
{
  "code": "ok",
  "request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
  "data": {
    "items": [
      {
        "id": "6835457055260672014",
        "url": "https://www.xingtu.cn/ad/creator/author-homepage/douyin-video/6835457055260672014",
        "username": null,
        "name": "轻装露营",
        "avatar_url": "https://cdn.example.com/avatar/1.jpg",
        "followers": 2457141,
        "rank": 1,
        "score": 0.95,
        "category": "服装",
        "room_id": null,
        "days": 1,
        "sessions": null,
        "avg_views": null,
        "avg_unique_viewers": null,
        "avg_viewers": null,
        "peak_viewers": null,
        "avg_watch_seconds": null,
        "new_followers": null,
        "engagement_rate": null,
        "gmv": {
          "min": 8000000,
          "max": 10000000
        },
        "avg_gmv": null,
        "gpm": {
          "min": 10000,
          "max": 100000
        },
        "avg_price": null,
        "products": 46
      }
    ]
  },
  "page": {
    "next_cursor": "eyJvIjoyMH0",
    "has_more": true
  },
  "warnings": [],
  "meta": {
    "capability": "douyin.live.streamers.trending",
    "billing": {
      "amount": "0.006",
      "currency": "USD",
      "balance_after": "9.994"
    },
    "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 streamer boards API cost?

One call costs $0.006 and returns one page of about 100 results. Collecting 1,000 results takes about 10 calls, $0.06 in total. Each page is a separate call. A call that reached the data source is charged even when it comes back empty, not found or failed; calls stopped before reaching a source are free.

### How do I get the next page?

Pass page.next_cursor from the response back as the cursor parameter. When page.has_more is false there is nothing left. Every page is its own call at $0.006.

### 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 live room](https://okdata.online/apis/douyin/live/rooms/get/): $0.002 per call
- [Douyin account live status](https://okdata.online/apis/douyin/live/users/get/): $0.004 per call
- [Douyin streamer live figures](https://okdata.online/apis/douyin/live/streamers/metrics/): $0.04 per call

## At a glance

- **Short name**: Douyin live streamer boards
- **Also called**: douyin live selling ranking, douyin streamer ranking, douyin live commerce leaderboard
- **Category**: [Creators](https://okdata.online/categories/creator/)
- **Status**: preview. It may still change; any change is announced beforehand.
- **Price**: $0.006 per call · bad parameters are free
- **Returns**: A list of LiveStreamer, from a snapshot up to 5 minutes old
- **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.006 per call
- Bad parameters, too little balance, a paused endpoint: Free

| When | Charge |
|---|---|
| Most one call costs | $0.006 |
| An empty answer | $0.006 |
| The data source fails or times out | $0.006 |
| 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.006 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: 16 calls to this endpoint.
- About 10 calls fetch 1,000 results: $0.06 in all.

## Known limits

- The whole list comes in one answer; there is no next page.
- Answers come from a shared snapshot up to 5 minutes old, so calls a few minutes apart may return the same data.

## 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`, `username`, `name`, `followers`, `rank`, `category`, `days`, `sessions`, `avg_views`, `avg_viewers`, `new_followers`, `gmv`, `avg_gmv`, `products`
- `standard`: `avatar_url`, `score`, `room_id`, `avg_unique_viewers`, `peak_viewers`, `avg_watch_seconds`, `engagement_rate`, `gpm`, `avg_price`
- `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 |
| 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/)

## Presets

- [Douyin live streamer boards: board sales](https://okdata.online/apis/douyin/live/streamers/trending/sales/)
- [Douyin live streamer boards: board top_entertainment](https://okdata.online/apis/douyin/live/streamers/trending/top_entertainment/)
- [Douyin live streamer boards: board top_gaming](https://okdata.online/apis/douyin/live/streamers/trending/top_gaming/)
- [Douyin live streamer boards: board rising_entertainment](https://okdata.online/apis/douyin/live/streamers/trending/rising_entertainment/)
- [Douyin live streamer boards: board rising_gaming](https://okdata.online/apis/douyin/live/streamers/trending/rising_gaming/)

## Use it in your AI

> Read https://okdata.online/apis/douyin/live/streamers/trending.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use Douyin live streamer boards and list the top ten streamers with their followers and figures.

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