Douyin Billboard Fetch Hot Total Video List
## Purpose Retrieve a paginated Douyin video ranking, with a choice of time window and ranking category and optional keyword or vertical-category filters. ## Inputs All filters belong inside the optional `request_body` object. - `page`: Integer page number; default `1`. - `page_size`: Integer number of items per page; default `10`. - `date_window`: Time window in hours: `1` (last hour), `24` (last day), `72` (last three days), or `168` (last seven days). Default: `24`. - `sub_type`: Ranking category: `1001` overall video ranking, `1002` breakout videos from low-follower creators, `1003` high completion rate, `1004` high follower growth rate, or `1005` high like rate. Default: `1001`. - `keyword`: Keyword used to filter the ranking; default `""` means no keyword filter. - `tags`: Array of vertical-category filters; an empty array means all categories. Each item contains a top-level category ID in `value` and may include a `children` array of objects with subcategory IDs in `value`. Omit `children` to include all subcategories under that top-level category. Use IDs obtained from the content-tag lookup. ## Example ```json { "request_body": { "page": 1, "page_size": 10, "date_window": 24, "sub_type": 1001, "keyword": "", "tags": [] } } ``` ## Result Returns the video ranking for the selected criteria in the response's `data`, with status and response metadata. The documented response does not define individual ranking-entry fields, so specific metrics or identifiers are not guaranteed by the schema. This tool retrieves ranking data, not video media.
Pricing
| Condition | Charge |
|---|---|
| Each call | 2.07 credits/call |
2.07 credits/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 |
|---|---|---|---|---|
request_body | object | No | 获取抖音视频榜的请求体对象,包含分页参数 page、page_size,时间窗口 date_window,榜单分类 sub_type,以及关键词 keyword 和垂类标签 tags 筛选条件。 | — |
request_body.page | integer | No | 页码,默认1 | 1 |
request_body.tags | array | No | 垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取 | — |
request_body.tags[].value | integer | null | No | 顶级垂类标签id,从fetch_content_tag接口获取/Top-level vertical category tag id, obtained from the fetch_content_tag endpoint | — |
request_body.tags[].children | array | null | No | 子级垂类标签列表,省略则为该顶级垂类下全部/Sub-level vertical category tags, omit for all under this top-level tag | — |
request_body.tags[].children[].value | integer | null | No | 子级垂类标签id,从fetch_content_tag接口获取/Sub-level vertical category tag id, obtained from the fetch_content_tag endpoint | — |
request_body.keyword | string | No | 搜索关键词,对榜单按关键词过滤,空为全部 | "" |
request_body.sub_type | integer | No | 榜单分类,1001 视频总榜 1002 低粉爆款 1003 高完播率 1004 高涨粉率 1005 高点赞率 | 1001 |
request_body.page_size | integer | No | 每页数量,默认10 | 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_video_list' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"request_body": {
"date_window": 168,
"keyword": "泪痕",
"page": 3,
"page_size": 50,
"sub_type": 1001
}
}
}'{
"code": 200,
"data": {
"code": 0,
"data": {
"objs": [],
"page": {
"page": 3,
"page_size": 50,
"total": 41
}
},
"extra": {
"now": 1794453297000
},
"message": ""
},
"docs": "https://api.tikhub.io/#/Douyin-Billboard-API/fetch_hot_total_video_list_api_v1_douyin_billboard_fetch_hot_total_video_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.

