TikTok Shop Livestream Detail
12 credits/call
ae_tiktok_shop_livestream_detail
Retrieve TikTok Shop livestream performance details from Kalodata for a specific livestream ID and selected country, currency, language, and date range. The response may include revenue, viewers, creator information, and top product IDs.
12 credits/call
Pricing
12 credits/call
| Condition | Charge |
|---|---|
| Each call | 12 credits/call |
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
region | enum (US | BR | MX | ID | JP | MY | PH | SG | TH | VN | GB | ES | DE | FR | IT | PL | NL | BE | CZ | AT | GR | PT | HU | IE) | Yes | Country whose TikTok Shop data to query. Choose a supported country code: US, BR, MX, ID, JP, MY, PH, SG, TH, VN, GB, ES, DE, FR, IT, PL, NL, BE, CZ, AT, GR, PT, HU, IE. | — |
currency | enum (CNY | USD | IDR | VND | THB | MYR | JPY | PHP | GBP | SGD | MXN | EUR | BRL | PLN | CZK | HUF) | Yes | Currency used for revenue and price fields. Supported values: CNY, USD, IDR, VND, THB, MYR, JPY, PHP, GBP, SGD, MXN, EUR, BRL, PLN, CZK, HUF. | — |
language | enum (zh-CN | en-US | id-ID | th-TH | vi-VN | es-ES | ja-JP | pt-BR | ko-KR | fr-FR | de-DE | pl-PL | nl-NL | cs-CZ | el-GR | hu-HU | pt-PT | it-IT) | Yes | Language for text fields in the response. Supported values: zh-CN, en-US, id-ID, th-TH, vi-VN, es-ES, ja-JP, pt-BR, ko-KR, fr-FR, de-DE, pl-PL, nl-NL, cs-CZ, el-GR, hu-HU, pt-PT, it-IT. | — |
date_range | string | Yes | Date range for the livestream data. The source lists named ranges lastDay, last7Day, last30Day, last60Day, last90Day, last180Day, and last365Day, a date range in yyyy-MM-dd~yyyy-MM-dd form, or a month in yyyy-MM form. | — |
need_extra | boolean | No | Whether to request extra information for the livestream details. | — |
livestream_id | string | Yes | ID of the livestream to query. | — |
Invocation example
Copy the request and explore its response example.
POST
/agent-api/v1/tool/executeX-Api-KeyRequest coderequest.sh
curl --request POST \
--url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_tiktok_shop_livestream_detail' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"currency": "IDR",
"date_range": "2026-11-02~2026-11-11",
"language": "zh-CN",
"livestream_id": "7703991053111659282",
"region": "ID"
}
}'Response exampleresponse.json
{
"cached": null,
"code": null,
"data": {
"creator_handle": "huaweimobileid",
"creator_id": "7213592961815430170",
"gpm": 1218935.71,
"livestream_duration": 172774,
"livestream_end_time": 1793898008000,
"livestream_id": "7703991053111659282"
},
"message": null,
"success": true
}This example shows part of the response. Copied content is valid JSON.

