Douyin Fetch Live Gift Ranking
Retrieve the gift-giving user leaderboard for a Douyin live room. Inputs: - room_id (required, string): The live room ID, for example "7356585666190461731". - rank_type (optional, integer): Leaderboard type. Defaults to 30 and normally does not need to be changed. Other values are not documented. Returns: A response containing the leaderboard payload in data, along with status and response metadata. The detailed leaderboard fields are not specified; data may be null. Example: {"room_id":"7356585666190461731","rank_type":30}
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.
The 2.07-credit-per-call charge applies to normal successful calls; it is not an absolute minimum for empty results or other out-of-scope cases.
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
room_id | string | Yes | 直播间room_id/Room room_id | — |
rank_type | integer | No | 排行类型/Leaderboard type | 30 |
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_fetch_live_gift_ranking' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"room_id": "xxx"
}
}'No response example available yet.

