Douyin Creator Fetch Creator Hot Props Billboard
## Purpose Retrieve the Douyin creator hot props billboard for discovering popular props by category, ranking metric, and time window. ## Inputs All three inputs are optional integers. - `billboard_tag` (default `0`): category ID; `0` means all categories. Documented IDs: `333` Food, `334` Travel, `299` Lifestyle, `335` Automotive, `336` Technology, `302` Gaming, `296` Anime, `337` Entertainment, `311` Celebrity, `298` Sports, `300` Culture & Education, `301` Campus, `297` Government, `305` Fashion, `306` Talent Show, `669` Finance, `314` Random, `307` Animals & Plants, `309` Graphics & Text, `308` Drama, `315` Parenting, `718` Agriculture, `310` Creative, `312` Outdoor, `926` Public Welfare. Additional category IDs require confirmation from category configuration; do not guess them. - `order_key` (default `1`): `1` highest views, `5` most submissions, `6` highest exposure, `7` most favorites. - `time_filter` (default `1`): `1` 24 hours, `2` 7 days, `3` 30 days. ## Result Returns hot props billboard data for the selected filters and ordering. The response's `data` holds the result and may be null; individual ranking-item fields are not specified. This is a props billboard, not a creator or video ranking. ## Example `{"billboard_tag":0,"order_key":1,"time_filter":1}` requests all categories ranked by highest views over 24 hours.
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 |
|---|---|---|---|---|
order_key | integer | No | 排序键: 1=播放最高, 5=投稿最多, 6=展现最高, 7=收藏最高/Order key: 1=highest views, 5=most submissions, 6=highest exposure, 7=most favorites | 1 |
time_filter | integer | No | 时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days | 1 |
billboard_tag | integer | No | 榜单标签,0=全部,其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface | 0 |
Invocation example
Parameter templateGenerated from the parameter configuration. Replace the sample values before use.
/agent-api/v1/tool/executeX-Api-Keycurl --request POST \
--url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_douyin_creator_fetch_creator_hot_props_billboard' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {}
}'No response example available yet.

