Skip to main content
POST
Reference example
获取热门视频榜单 计费 — 按成功调用计费,最终扣费按你的套餐倍率浮动。仅当上游响应体 code 为 200 时计费。
响应结构尚未完整文档化 —— 以实际调用为准。

示例

请求规范

完整 OpenAPI 定义 有效请求与价格声明(包括认证和引用的 schema):

费用与请求规则

公开参考价格:每次成功请求 $0.001 USD。 最终费用以账户适用价格及实际结算为准。 公开参考值不是你的账户报价或最终扣费。对于支持 X-AISA-Cost-Mode: quote 的接口,执行前请针对完整请求获取免费报价;执行后通过响应费用元数据和 Usage Logs 核对结算费用。1 USD 等于 1,000,000 个整数 micro-USD。
  • 默认请求参考估价(USD): 0.001
  • 计费依据: fixed_success
  • 公开参考倍率: 1.0
  • 结算证据来源: request_snapshot

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
period_end_timestamp
integer
必填

The caller must generate this 10-digit Unix timestamp in seconds from the target ranking date, for example 1785024000; do not pass 0 because it returns an empty result

Usage: Period end timestamp in seconds, required - Generate this value from the target ranking date; it is not returned by another endpoint - Example: 1785024000; do not pass 0, which returns an empty result - For period_dimension 1, pass a Sunday 00:00 UTC timestamp; other dates return no data - For period_dimension 3 or 5, any past date works

示例:

1785024000

content_label_ids
string
默认值:""

Content label IDs, comma separated (e.g. 11002,11015), empty for all. Options: - 11001: Nature & Animals - 11002: Beauty & Care - 11003: Fashion - 11004: Music & Entertainment - 11005: Games - 11006: Education & Work - 11007: Sports & Outdoor - 11008: Creativity & Talent - 11009: Family & Relationship - 11010: Food & Beverage - 11011: Vlog & Selfie - 11012: Society - 11013: Lifestyle & Leisure - 11014: Vehicles & Transportation - 11015: Technology & Finance

Custom Cookie string, optional parameter, you can use your own Cookie to get more data

country_code
string
默认值:US

Country/region code

Usage: Country code, default US, see /tikhub/tiktok/ads/get_location_list for options

API references: get_location_list = POST /tikhub/tiktok/ads/get_location_list (operationId: post_tikhub_tiktok_ads_get_location_list).

limit
integer
默认值:20

Items per page, default 20, max 100

必填范围: x <= 100
order_by_metric
integer
默认值:1

Order by metric: 1=Views, 2=Engagement rate, 3=6-second completion rate

Usage: Sorting metric, default 1 - 1: By video views - 2: By engagement rate - 3: By 6-second view-through rate

示例:

1

organic_only
boolean
默认值:false

Organic content only

page
integer
默认值:1

Page number, default 1

period_dimension
integer
默认值:3

Period dimension: 1/3/5

Usage: Period, default 3 - 1: Weekly ranking - 3: Daily ranking - 5: Long-period ranking (covers videos over a longer time span)

示例:

1

响应

Successful response. The outer object follows ResponseModel; the endpoint-specific payload is in data.

Return Description

  • entityInfos: Video list (itemInfo / itemMetrics / itemAuthorInfo / itemAuthorMetrics / contentTags)
  • pagination: Pagination info (page / limit / pageCount / totalCount / hasMore)
cache_message
string | null
默认值:This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again.

Cache message (EN-US)

cache_message_zh
string | null
默认值:本次响应已缓存,可通过下方 URL 直接查看,有效期 24 小时,访问缓存链接无额外费用。缓存仅用于请求溯源,不影响接口数据的时效性,也不会再次通过接口返回。

Cache message (ZH-CN)

cache_url
string | null

The URL to access the cached result

code
integer
默认值:200

HTTP 状态码

data
any

Endpoint-specific response payload. The official shared model does not declare a fixed type or field set. Use the operation's documented return fields or response example; an operation-specific schema, when present, describes the documented fields. Undocumented fields must be read from the actual response rather than assumed.

docs
string | null

Link to the API Swagger documentation for this endpoint

message
string
默认值:Request successful. This request will incur a charge.

Response message (EN-US)

message_zh
string
默认值:请求成功,本次请求将被计费。

Response message (ZH-CN)

params
any
默认值:{}

The parameters used in the request

request_id
string | null

Unique request identifier

router
string
默认值:""

The endpoint that generated this response

support
string
默认值:Discord: https://discord.gg/aMEAS8Xsvz

Support message

time
string

The time the response was generated

time_stamp
integer

The timestamp the response was generated

time_zone
string
默认值:America/Los_Angeles

The timezone of the response time