Douyin Billboard Fetch Hot Total Search List
## Purpose Retrieve the Douyin search leaderboard using a keyword, time window, and pagination settings. ## Inputs All inputs are optional and belong inside `request_body`: - `keyword` (string): Search keyword; default `抖音`. - `page_num` (integer): Page number; default `1`. - `page_size` (integer): Number of items per page; default `10`. - `date_window` (integer): Time window in hours. Documented values are `1`, `24`, `72`, and `168`, meaning the past hour, day, 3 days, and 7 days respectively; default `24`. ## Example ```json {"request_body":{"keyword":"抖音","page_num":1,"page_size":10,"date_window":24}} ``` ## Result Returns a response containing status information and search leaderboard data in `data`. The structure of individual entries, available metrics, and pagination metadata are not specified; `data` may be null. This is a leaderboard lookup, not a general video search.
Pricing
| Condition | Charge |
|---|---|
| Each call | 2.07 credits/call |
Each call has a fixed charge of 2.07 credits. 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 |
|---|---|---|---|---|
request_body | object | No | 获取抖音搜索榜的请求体对象,包含搜索关键词 keyword、页码 page_num、每页数量 page_size 和以小时为单位的时间窗口 date_window。 | — |
request_body.keyword | string | No | 搜索关键字 | 抖音 |
request_body.page_num | integer | No | 页码 | 1 |
request_body.page_size | integer | No | 每页数量 | 10 |
request_body.date_window | integer | No | 时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认24 | 24 |
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_search_list' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"request_body": {
"keyword": "护士副业",
"page_num": 1,
"page_size": 10
}
}
}'{
"code": 200,
"data": {
"code": 0,
"data": {
"objs": [
{
"key_word": "#护士懂护士",
"search_score": 190906,
"trends": [
{}
]
}
],
"page_num": 1,
"page_size": 10,
"search_list": [
{
"key_word": "#护士懂护士",
"search_score": 190906,
"trends": [
{}
]
}
],
"total_count": 17
},
"extra": {
"now": 1794451152000
},
"message": ""
},
"docs": "https://api.tikhub.io/#/Douyin-Billboard-API/fetch_hot_total_search_list_api_v1_douyin_billboard_fetch_hot_total_search_list_post",
"message": "Request successful. This request will incur a charge.",
"message_zh": "请求成功,本次请求将被计费。",
"params": {}
}This example shows part of the response. Copied content is valid JSON.

