Logo

TikTok LIVE Rankings

Leaderboards

Manage leaderboards within the TikTok LIVE Rankings API. This section covers endpoints for working with leaderboards including retrieval, creation, and management operations.

Endpoints
GET/webcast/rankings/catalog/anchors/{anchor_id}/rank_namesGET/webcast/rankings/catalog/leaderboards/{region}/{rank_name}/datesGET/webcast/rankings/catalog/leaderboards/{region}/{rank_name}/anchors/{anchor_id}/historyGET/webcast/rankings/catalog/leaderboards/{region}/{rank_name}GET/webcast/rankings/catalog/leaderboards

Get user leaderboards over timespan

GET/webcast/rankings/catalog/anchors/{anchor_id}/rank_names

Discovery: The leaderboards a creator appears on within a UTC date range, returned as a map of region to rank_types.

Rate limited to 30 requests/min. Does NOT count towards normal API limits.

Path Parameters

anchor_id*string

Query Parameters

from*string (date-time)
to*string (date-time)

Responses

200Ok

Response Attributes

code*number (double)
messagestring
user_numeric_idstring
fromstring
tostring
leaderboardsobject

region -> rank_names the creator appeared on (e.g. "DAILY_RANK", "SALE_RANK").

||
Request
Response200

Get available dates

GET/webcast/rankings/catalog/leaderboards/{region}/{rank_name}/dates

Retrieve the list of dates that have leaderboard data for a given rank type and region.

Requests to catalogue endpoints do NOT count towards normal API limits.

Path Parameters

rank_name*enum
region*string

Query Parameters

leagueenum

Responses

200Ok

Response Attributes

code*number (double)
messagestring
dates*string[]
||
Request
Response200

Get user history

GET/webcast/rankings/catalog/leaderboards/{region}/{rank_name}/anchors/{anchor_id}/history

Retrieve a creator's daily standing on a given board over a UTC date range, oldest first.

Requests to catalogue endpoints do NOT count towards normal API limits.

Path Parameters

rank_name*enum
region*string
anchor_id*string

Query Parameters

from*string (date-time)
to*string (date-time)

Responses

200Ok

Response Attributes

code*number (double)
messagestring
userobject
regionstring
rank_nameenum
historyobject[]
||
Request
Response200

Get leaderboard

GET/webcast/rankings/catalog/leaderboards/{region}/{rank_name}

Retrieve the most recent leaderboard snapshot for a given rank type, region, and date.

Requests to catalogue endpoints do NOT count towards normal API limits.

Path Parameters

rank_name*enum
region*string

Query Parameters

datestring (date-time)
leagueenum

Responses

200Ok

Response Attributes

code*number (double)
messagestring
tsstring
datestring
regionstring
rank_nameenum
leagueenum
resets_atstring | null
is_latestboolean
ranksobject[]
||
Request
Response200

Get available rankings

GET/webcast/rankings/catalog/leaderboards

Returns the available ranking types and league tiers for each tracked region, based on the most recent day of data in the ranking service.

Requests to catalogue endpoints do NOT count towards normal API limits.

Responses

200Ok

Response Attributes

code*number (double)
messagestring
regions*object

Construct a type with a set of properties K of type T

||
Request
Response200