Douyin Billboard Fetch Hot Total List
## Purpose Retrieve the Douyin overall hot-topic ranking at a snapshot time or over a date range, with pagination and optional filters. ## Inputs - Required: `page` (integer page number), `page_size` (integer number of items per page), and `type` (time-selection mode). - For `type="snapshot"`, use `snapshot_time` in `yyyyMMddHHmmss` format. Its default is `20250106151500`, not a request for the latest snapshot; set it explicitly for the intended time. - For `type="range"`, use `start_date` and `end_date` in `yyyyMMdd` format. They default to empty strings. `snapshot_time` applies only to snapshot mode; the date fields apply only to range mode. - Optional `sentence_tag`: category tags from the hot-ranking category list, separated by commas. An empty value includes all categories. - Optional `keyword`: a hot-topic search term; defaults to an empty string. ## Result Returns hot-topic ranking data for the requested page, time selection, and filters in the response's `data` field, along with response metadata. Individual ranking-item fields are not specified by the documented response schema.
Pricing
| Condition | Charge |
|---|---|
| Each call | 2.07 credits/call |
A fixed charge of 2.07 credits applies per call. Charges are per query. A successful query is billed even if it returns no results.
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
page | integer | Yes | 页码 | — |
type | string | Yes | 快照类型 snapshot 按时刻查看 range 按时间范围 | — |
keyword | string | No | 热点搜索词 | "" |
end_date | string | No | 快照结束时间 格式yyyyMMdd | "" |
page_size | integer | Yes | 每页数量 | — |
start_date | string | No | 快照开始时间 格式yyyyMMdd | "" |
sentence_tag | string | No | 热点分类标签,从热点榜分类获取,多个分类用逗号分隔,空为全部 | "" |
snapshot_time | string | No | 快照时间 格式yyyyMMddHHmmss | 20250106151500 |
Invocation example
Copy the request and explore its response example.
/agent-api/v1/tool/executeX-Api-Keycurl --request POST \
--url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_douyin_billboard_fetch_hot_total_list' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"end_date": "20261110",
"keyword": "A股三大指数集体高开",
"page": 1,
"page_size": 5,
"sentence_tag": "",
"snapshot_time": "",
"start_date": "20261110",
"type": "range"
}
}'{
"code": 200,
"data": {
"code": 0,
"data": {
"last_update_time": "",
"objs": [
{
"SnapshotID": 0,
"SnapshotSubType": "",
"SnapshotType": 0,
"allow_publish": true,
"city_code": 0,
"city_name": ""
}
],
"page": {
"page": 1,
"page_size": 5,
"total": 1
}
},
"extra": {
"now": 1794388716000
},
"message": ""
},
"docs": "https://api.tikhub.io/#/Douyin-Billboard-API/fetch_hot_total_list_api_v1_douyin_billboard_fetch_hot_total_list_get",
"message": "Request successful. This request will incur a charge.",
"message_zh": "请求成功,本次请求将被计费。",
"params": {
"end_date": "20261110",
"keyword": "A股三大指数集体高开",
"page": "1",
"page_size": "5",
"sentence_tag": "",
"type": "range"
}
}This example shows part of the response. Copied content is valid JSON.

