Douyin Social media Douyin Ocean Engine index API

Douyin index: brand vs industry API

A brand's daily average search, content and spread indexes on Douyin over a date range (巨量算数), next to the averages of its whole industry and of the industry's top 3, 5, 10, 15 and 30 brands. An index is the platform’s score, not a count.

GEThttps://api.okdata.online/v1/douyin/index/brands/metrics

Also calleddouyin brand benchmarkdouyin brand radarbrand index vs industry

Price: $0.002; per call · failed calls are free
Returns: One BrandMetrics; as data.item
If a call fails: Not charged; When a data source fails, the next one is tried; errors and timeouts cost nothing.
Status: preview; It may still change; any change is announced beforehand.

Parameters

Name	Type	Description
`brand`required	string	The brand name, spelled the way the Douyin index lists it. e.g. `泡泡玛特`
`since`required	string	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`required	string	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`	stringcompactstandardfull	How much of each object comes back. full adds platform-specific fields under ext. default `standard`
`fields`	string[]	Fields to keep, by path (author.name), to save tokens. In a query string: comma-separated.

cursor, view and fields work the same on every endpoint: how requests work.

Request

cURL

curl -G "https://api.okdata.online/v1/douyin/index/brands/metrics" \
  -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

import os
import requests

resp = requests.get(
    "https://api.okdata.online/v1/douyin/index/brands/metrics",
    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

const url = new URL('https://api.okdata.online/v1/douyin/index/brands/metrics');
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);

MCPtools/call

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

Response

200 · application/jsonmeta.billing.amount = 0.002

{
  "code": "ok",
  "request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
  "data": {
    "item": {
      "brand": null,
      "category": null,
      "search_index": null,
      "content_index": null,
      "spread_index": null,
      "benchmarks": [
        {
          "scope": null,
          "search_index": null,
          "content_index": null,
          "spread_index": null
        }
      ]
    }
  },
  "warnings": [],
  "meta": {
    "capability": "douyin.index.brands.metrics",
    "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. Failed calls are free. Your key goes only to that address and is never stored on this site.

Returned fields

data.item is one BrandMetrics.

Field	Type	View	Description
`brand`	string	compact	The brand's name.
`category`	string \| null	compact	The industry the platform files the brand under, in its words.
`search_index`	integer \| null	compact	Daily average search index over the period.
`content_index`	integer \| null	compact	Daily average content index over the period.
`spread_index`	integer \| null	compact	Daily average spread index over the period.
`benchmarks`	BrandBenchmark[] \| null	compact	The same averages for the whole industry and for its leading brands.

Show all 7 fieldsHide the other 1

Field	Type	View	Description
`ext`	object	full	Platform-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 brand_metrics. 1,000 lookups cost $2.00. Failed calls are not charged.

Data comes back$0.002 per call

Bad parameters, errors, timeoutsFree

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 →

Common errors

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

HTTP	Code	Meaning	Charged
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.Retry: after a fix	no
401	`unauthorized`	The key is missing, malformed, revoked, disabled or expired (reason says which when known).Retry: no	no
402	`insufficient_balance`	The balance (available) cannot cover the most this call could cost (required).Retry: after a fix	no
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.Retry: no	no
429	`rate_limited`	The account sent too many requests this minute (reason: rate) or has too many calls running (reason: concurrency).Retry: yes	no
500	`settlement_unknown`	The data came back, but the charge could not be confirmed.Retry: with the same Idempotency-Key	unknown until looked up
502	`upstream_failed`	Every data source for this endpoint failed on this request.Retry: yes	no
503	`capability_paused`	This endpoint is paused right now; nothing ran.Retry: yes	no
504	`timeout`	The data did not come back in time. The hold was released, so nothing was charged.Retry: yes	no

All error codes →

Questions

How much does the Douyin index: brand vs industry API cost?

One call costs $0.002 and returns one brand_metrics. 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).

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/index/brands/metrics.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use Douyin index: brand vs industry and sum up what comes back.

With the MCP server connected, just ask: Use Douyin index: brand vs industry and sum up what comes back.

Connect your agent → MCP →

All 38 Douyin endpoints

Douyin Ocean Engine index API

Main Douyin endpoints

Douyin Xingtu API

Douyin API overview →Douyin API pricing →

Names and ID

Name: Douyin index: brand vs industry API
Short name: Douyin index: brand vs industry
ID: douyin.index.brands.metrics
Endpoint: GET /v1/douyin/index/brands/metrics
Category: Social media
Group: Douyin Ocean Engine index API
Also called: douyin brand benchmark, douyin brand radar, brand index vs industry
Returns: BrandMetrics: 7 fields