Douyin Billboard Fetch Hot Total High Play List

2.07 credits/call
ae_douyin_billboard_fetch_hot_total_high_play_list

## Purpose Retrieve the Douyin high-completion-rate leaderboard, optionally filtered by time window, keyword, and content category. ## Inputs All inputs are optional and belong inside `request_body`: - `page`: integer page number; default `1`. - `page_size`: integer number of items per page; default `10`. - `date_window`: integer time window in hours: `1`, `24`, `72`, or `168`, meaning the last hour, day, three days, or seven days. Default: `24`. - `keyword`: string used to filter the leaderboard; default `""` means no keyword filter. - `tags`: array of content-category filters; use `[]` for no category filter. Each object has `value` for a top-level category ID and optional `children`, an array of objects with `value` for subcategory IDs. Omitting `children` includes all subcategories under that top-level category. Obtain IDs from the content-tag lookup. ## Example ```json {"request_body":{"page":1,"page_size":10,"date_window":24,"keyword":"","tags":[]}} ``` ## Result Returns the requested high-completion-rate leaderboard in the response's `data`, with response status and metadata. The documented schema does not specify individual leaderboard entry fields or the precise metric calculation. This is a completion-rate leaderboard, not a view-count leaderboard.

VideoSocial
2.07 credits/call

Pricing

2.07 credits/call
ConditionCharge
Each call2.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.

ParameterTypeRequiredDescriptionDefault
request_bodyobjectNo获取高完播率榜的请求体对象,包含页码 page、每页数量 page_size、时间窗口 date_window、关键词 keyword 和垂类标签筛选数组 tags,用于设置分页与榜单筛选条件。—
request_body.pageintegerNo页码1
request_body.tagsarrayNo垂类标签筛选,空则为全部,标签id从 fetch_content_tag 接口获取—
request_body.tags[].valueinteger | nullNo顶级垂类标签id,从fetch_content_tag接口获取/Top-level vertical category tag id, obtained from the fetch_content_tag endpoint—
request_body.tags[].childrenarray | nullNo子级垂类标签列表,省略则为该顶级垂类下全部/Sub-level vertical category tags, omit for all under this top-level tag—
request_body.tags[].children[].valueinteger | nullNo子级垂类标签id,从fetch_content_tag接口获取/Sub-level vertical category tag id, obtained from the fetch_content_tag endpoint—
request_body.keywordstringNo搜索关键词,对榜单按关键词过滤,空为全部""
request_body.page_sizeintegerNo每页数量10
request_body.date_windowintegerNo时间窗口(小时),可选 1/24/72/168,代表近1小时/近1天/近3天/近7天,默认2424

Invocation example

Copy the request and explore its response example.

POST/agent-api/v1/tool/executeX-Api-Key
Request coderequest.sh
curl --request POST \
  --url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_douyin_billboard_fetch_hot_total_high_play_list' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "request_body": {
      "date_window": 168,
      "keyword": "茶具",
      "page": 1,
      "page_size": 10
    }
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "code": 200,
  "data": {
    "code": 0,
    "data": {
      "objs": [
        {
          "avatar_url": "https://p26.douyinpic.com/aweme/100x100/aweme-avatar/tos-cn-i-0813c001_o0E7IAAA9M6OAmDqNFAwf7YavFeAJEAgCnzUCv.jpeg?from=2956013662",
          "fans_cnt": 5673,
          "item_cover_url": "https://p5-ex-gddgtc-sign.douyinpic.com/tos-cn-p-0015/oMCB5eYAPZ6DwCmRGHD9aCfRAtAFLKEqgIMQDD~tplv-dy-resize-walign-adapt-aq:540:q75.jpeg?lk3s=138a59ce&x-expires=1795496400&x-signature=UnYJmtuXlhec3EtpO4Sj7VlSwa0%3D&from=327834062&s=PackSourceEnum_PUBLISH&s",
          "item_duration": 8500,
          "item_id": "7702726366189453494",
          "item_title": "清理茶具解压又治愈#玩壶愉快 #茶宠摆件 #茶宠 #茶具 #茶具好物推荐"
        }
      ],
      "page": {
        "page": 1,
        "page_size": 10,
        "total": 20
      }
    }
  },
  "docs": "https://api.tikhub.io/#/Douyin-Billboard-API/fetch_hot_total_high_play_list_api_v1_douyin_billboard_fetch_hot_total_high_play_list_post",
  "message": "Request successful. This request will incur a charge.",
  "message_zh": "请求成功,本次请求将被计费。",
  "request_id": "49bb2e21-8a77-4b3f-ad5d-23d582d4606a"
}

This example shows part of the response. Copied content is valid JSON.