APIs/TikTok Data API/v1/Get ranking info

Get ranking info

GET/api/tiktok-data-api/v1/get-ranking-info1 credit/call

Test This Endpoint

Enter your credentials and parameters, then run a live request to see the real response

Authentication

X-Bodapi-Key

The key is kept in this tab's session storage only.

Query Parameters

room_idrequired

user_idrequired

rank_typerequired

Response

Click "Run Test" to send a live request and see the response here

Request Parameters

Validation rules grouped by request section.

Query Parameters

room_idstring

Type

string

Required

Yes

user_idstring

Type

string

Required

Yes

rank_typestring

Type

string

Required

Yes

Header Parameters

X-Bodapi-KeystringCreate one under API keys in the dashboard. The full key is shown once, at creation time.

Type

string

Required

Yes

Create one under API keys in the dashboard. The full key is shown once, at creation time.

Request Examples

curl -X GET '/api/tiktok-data-api/v1/get-ranking-info' \
  -H "X-Bodapi-Key: $BODAPI_API_KEY"

Get ranking info

Upstream: GET /v1/live/ranking (TokAPI)

Gateway route: GET /api/tiktok-data-api/v1/get-ranking-info

Auth headers

Name	Required	Description
X-API-Token	yes	Your bodapi API token
X-API-Secret	yes	Your bodapi API secret

Query parameters

Name	Required	Notes
rank_type	yes
room_id	yes
user_id	yes

Example

curl -X GET "https://gateway.bodapi.com/api/tiktok-data-api/v1/get-ranking-info?rank_type=VALUE&room_id=VALUE&user_id=VALUE" \
  -H "X-API-Token: YOUR_API_TOKEN" \
  -H "X-API-Secret: YOUR_API_SECRET"