# Douyin index: brand trends API

> A brand's search, content and spread indexes on Douyin day by day over a date range, from 巨量算数 (the Douyin index), with the brand's industry. An index is the platform’s score, not a count. Days are China-time calendar days.

Canonical page: https://okdata.online/apis/douyin/index/brands/history/

- **Endpoint**: `GET /v1/douyin/index/brands/history`
- **ID**: `douyin.index.brands.history`
- **Price**: $0.002 per call
- **Returns**: one BrandHistory object (`data.item`)
- **Status**: preview
- **Good for**: Competitor monitoring, Trend research

## Price

One call costs $0.002 and returns one brand_history. 1,000 lookups cost $2.00. Failed calls are not charged.

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `brand` | string | yes |  | The brand name, spelled the way the Douyin index lists it. (e.g. `泡泡玛特`) |
| `since` | string | yes |  | The first day wanted, as an ISO date or time: the China-time (UTC+8) calendar day it falls on. (e.g. `2026-10-01T00:00:00Z`) |
| `until` | string | yes |  | The last day wanted, read the same way. The index publishes a day or two late, so the latest days may be missing or have a null index. (e.g. `2026-10-31T00:00:00Z`) |
| `view` | string: compact / standard / full | no | `standard` | How much of each object comes back. 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 [BrandHistory](https://okdata.online/docs/objects/brand_history/).

| Field | Type | Description |
|---|---|---|
| `brand` | string | The brand's name. |
| `category` | string \| null | The industry the platform files the brand under, in its words. |
| `points` | BrandPoint[] | One entry a day, oldest first. |
| `ext` | object | Platform-specific extras. Only returned with view=full. |

## Request examples

### cURL

```bash
curl -G "https://api.okdata.online/v1/douyin/index/brands/history" \
  -H "Authorization: Bearer $OKDATA_API_KEY" \
  --data-urlencode 'brand=泡泡玛特' \
  --data-urlencode 'since=2026-10-01T00:00:00Z' \
  --data-urlencode 'until=2026-10-31T00:00:00Z'
```

### Python

```python
import os
import requests

resp = requests.get(
    "https://api.okdata.online/v1/douyin/index/brands/history",
    headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
    params={"brand": "泡泡玛特", "since": "2026-10-01T00:00:00Z", "until": "2026-10-31T00:00:00Z"},
    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)
print("cost: $" + body["meta"]["billing"]["amount"])
```

### TypeScript

```ts
const url = new URL('https://api.okdata.online/v1/douyin/index/brands/history');
url.searchParams.set('brand', "泡泡玛特");
url.searchParams.set('since', "2026-10-01T00:00:00Z");
url.searchParams.set('until', "2026-10-31T00:00:00Z");

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);
console.log('cost: $' + body.meta.billing.amount);
```

### MCP

```json
{
  "name": "call",
  "arguments": {
    "capability": "douyin.index.brands.history",
    "brand": "泡泡玛特",
    "since": "2026-10-01T00:00:00Z",
    "until": "2026-10-31T00:00:00Z"
  }
}
```

Or ask an agent that has the MCP server connected:

> Use Douyin index: brand trends and sum up what comes back.

## Response example

```json
{
  "code": "ok",
  "request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
  "data": {
    "item": {
      "brand": null,
      "category": null,
      "points": [
        {
          "date": null,
          "search_index": null,
          "content_index": null,
          "spread_index": null
        }
      ]
    }
  },
  "warnings": [],
  "meta": {
    "capability": "douyin.index.brands.history",
    "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. They are not charged, except not_found here, which costs $0.002 because the source bills it (charged: true with amount); only settlement_unknown is unknown until looked up. The full table: https://okdata.online/docs/errors/

## Questions

### How much does the Douyin index: brand trends API cost?

One call costs $0.002 and returns one brand_history. 1,000 lookups cost $2.00. Failed calls are not charged.

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

No. Every error response says charged: false, except a timeout, which says charged: null until the outcome is known. Resend with the same Idempotency-Key and you are never charged twice.

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

## At a glance

- **Short name**: Douyin index: brand trends
- **Also called**: douyin brand index, douyin brand trend, brand buzz on douyin
- **Category**: [Social media](https://okdata.online/categories/social/)
- **Group**: [Douyin Ocean Engine index API](https://okdata.online/apis/douyin/index/)
- **Status**: preview. It may still change; any change is announced beforehand.
- **Price**: $0.002 per call · failed calls are free
- **Returns**: One BrandHistory, as data.item
- **If a call fails**: Not charged. When a data source fails, the next one is tried; errors and timeouts cost nothing.

## When it is charged

- Data comes back: $0.002 per call
- Bad parameters, errors, timeouts: Free

| When | Charge |
|---|---|
| Most one call costs | $0.002 |
| An empty answer | Free |
| Not found (the platform has no such item) | $0.002 |
| Bad parameters, errors, timeouts | Free |
| A retry with the same Idempotency-Key within 24 hours | Charged once |

A failed call is free; an empty answer is free; not found costs $0.002.

Prices from price book 1b273c48fea9634e. [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.

## 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`: `brand`, `category`, `points`
- `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. Endpoints whose charge_when_not_found is above 0 charge this answer (the source billed us for it): the body then says charged: true and amount. | no | 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. | no | yes |
| 503 | `capability_paused` | This endpoint is paused right now; nothing ran. | no | yes |
| 504 | `timeout` | The data did not come back in time. The hold was released, so nothing was charged. | no | yes |

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

## Use it in your AI

> Read https://okdata.online/apis/douyin/index/brands/history.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use Douyin index: brand trends and sum up what comes back.

## Douyin endpoints by group

- [Douyin Ocean Engine index API](https://okdata.online/apis/douyin/index/): 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
- [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