Skip to main content
API docs by Redocly

TokApi - mobile version (1.0.0)

Download OpenAPI specification:Download

Introduction

TokAPI is the easiest way to scrape TikTok social network.

Building a custom social scraping solution can be expensive and time-consuming. TokAPI will do everything for you, just call the desired API endpoint and take your smoothies, we will do the rest.

Advanced endpoints

We can provide access to a private API endpoints (login/signup and other), contact with us to get more information.

Python SDK

You can take a look on simple python SDK, in examples folder you can find a different examples how to use it.

Authentication

All requests are authenticated using your private API key, which you can find on dashboard. Also you need provide the x-project-name header with tokapi value.

Example CURL request:

curl -X GET "https://api.tokapi.online/v1/feed/recommended?pull_type=0&region=US" \
    -H "accept: application/json" \
    -H "x-project-name: tokapi" \
    -H "x-api-key: 7380a994229a49fcab2c50a0d49934c6"

Trending

Trending categories list

Trending categories list

Authorizations:
ApiKeyAuth
query Parameters
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next data set

region
string
Default: "US"
header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Trending feed

Trending feed

Authorizations:
ApiKeyAuth
query Parameters
pull_type
integer
Default: 0

The type of loading feed (0 - Initial loading, 2 - Load more, 8 - Reload)

region
string
Default: "US"
header Parameters
x-device
string

Device configuration

x-cookie
string

Cookie string

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Video

Video by ID

Video by ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string
Default: "6977747303692078337"
query Parameters
region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Story info by ID

Story info by ID

Authorizations:
ApiKeyAuth
path Parameters
story_id
required
string
Default: "7306595946136112389"
query Parameters
region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Video by web URL

Video by web URL, can be vm.tiktok.com or tiktok.com

Authorizations:
ApiKeyAuth
query Parameters
video_url
required
string
Default: "https://vm.tiktok.com/ZMekDdYeX/"
region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Comment info by video and comment ID

Comment info by video and comment ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string
Default: "7370738225385868549"
comment_id
required
string
Default: "7394119686785123073"
query Parameters
region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "author_pin": false,
  • "aweme_id": "7370738225385868549",
  • "cid": "7394119686785123073",
  • "collect_stat": 0,
  • "comment_language": "en",
  • "comment_post_item_ids": null,
  • "create_time": 1721577674,
  • "digg_count": 0,
  • "forbid_reply_with_video": false,
  • "image_list": null,
  • "is_author_digged": false,
  • "is_comment_translatable": true,
  • "label_list": null,
  • "no_show": false,
  • "reply_comment": null,
  • "reply_comment_total": 0,
  • "reply_id": "0",
  • "reply_to_reply_id": "0",
  • "share_info": {},
  • "status": 1,
  • "stick_position": 0,
  • "text": "okay time to go to sleep now, nighty night everybody😍",
  • "text_extra": [ ],
  • "trans_btn_style": 0,
  • "user": {
    },
  • "user_buried": false,
  • "user_digged": 0
}

Comments by video ID

Comments by video ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string
Default: "6977747303692078337"
query Parameters
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Get comment replies

Get comment replies

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string
Default: "7241898955607510274"
comment_id
required
string
Default: "7244985003627741978"
query Parameters
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User video feed

User video feed

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6784563164518679557"

user's ID can be uid or sec_uid

query Parameters
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have max_cursor value for a next set

region
required
string
Default: "GB"

Alpha-2 country code

with_pinned_posts
integer
Default: 1

Add pinned posts in response

header Parameters
x-device
string

JSON string with device config from login API response

x-cookie
string

Cookie string from login API response

x-proxy
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User stories

User stories

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6820213403266335750"

user's ID can be uid or sec_uid

query Parameters
count
integer
Default: 5
offset
string
Default: 0

Use min_cursor as offset value if has_more_after is true

region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User video feed by different IDs

User video feed by different IDs

Authorizations:
ApiKeyAuth
query Parameters
user_id
string
sec_user_id
string
username
string
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have max_cursor value for a next set

region
required
string
Default: "GB"

Alpha-2 country code

with_pinned_posts
integer
Default: 1

Add pinned posts in response

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User liked video feed

User liked video feed

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6546356850533602319"

user's ID can be uid or sec_uid

query Parameters
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have max_cursor value for a next set

region
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Increase video views

Increase video views

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string
Default: "7266817843528748306"

Video ID

query Parameters
view_duration
required
integer

Video view duration in seconds

region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "status_code": 0,
  • "extra": {
    },
  • "log_pb": {
    }
}

Remove video

Remove video by ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string
Default: "7266817843528748306"

Video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0
}

Send video appeal

Send video appeal by video ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string
Default: "7266817843528748306"

Video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "appeal_status": 3,
  • "extra": {
    },
  • "feedback_status": 1,
  • "log_pb": {
    },
  • "penalties": [
    ],
  • "status_code": 0,
  • "status_msg": ""
}

Change video visibility

Change video visibility

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string
Default: "7266817843528748306"

Video ID

query Parameters
visibility_type
required
string
Default: "1"

Visibility type, can be: 1 - public, 2 - private, 3 - friends

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "hybrid_label": null,
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": "",
  • "video_text": null
}

Upload video

Upload video

Authorizations:
ApiKeyAuth
query Parameters
region
string

Alpha-2 country code

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/x-www-form-urlencoded
video
required
string <binary>

Video in MP4 format

data
object

Extra info

Responses

Response samples

Content type
application/json
{
  • "status_code": 0,
  • "extra": {
    },
  • "log_pb": {
    }
}

Update video description

Update video description

Authorizations:
ApiKeyAuth
query Parameters
aweme_id
string

Video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
description
required
string
hashtags
Array of strings
mentions
object

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "hashtags": [
    ],
  • "mentions": { }
}

Response samples

Content type
application/json
{
  • "biz_err_code": 0,
  • "edit_diff": {
    },
  • "error_msg": "",
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": ""
}

Search

Search users by text query

Search users by text query

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "nike"
region
required
string
Default: "GB"

Alpha-2 country code

follower_count
string

Filter by followers count, can be empty or one of: ZERO_TO_ONE_K (0 to 1k), ONE_K_TO_TEN_K (1k to 10k), TEN_K_TO_ONE_H_K(10k to 100k), ONE_H_K_PLUS(100k+)

profile_type
string

Filter by user profile type, can be empty or one of: VERIFIED

other_pref
string

Filter by other preference, can be empty or one of: USERNAME (keyword usage in username)

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Search hashtags by text query

Search hashtags by text query

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "work"

Query text

region
required
string
Default: "GB"

Alpha-2 country code

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "ad_info": { },
  • "challenge_list": [
    ],
  • "cursor": 1,
  • "extra": {
    },
  • "global_doodle_config": {
    },
  • "has_more": 1,
  • "is_match": false,
  • "keyword_disabled": 0,
  • "log_pb": {
    },
  • "qc": "",
  • "status_code": 0
}

Search music by text query

Search music by text query

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "nike"

Query text

region
required
string
Default: "GB"

Alpha-2 country code

filter_by
string

Filter by type, can be empty or one of: 0 - All, 1 - Title, 2 - Creators

sort_type
string

Sort type, can be empty or one of: 0 - Relevance, 1 - Most used, 2 - Most recent, 3 - Shortest, 4 - Longest

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Search videos by text query

Search videos by text query

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "nike"

Query text

region
required
string
Default: "GB"

Alpha-2 country code

sort_type
string

Sort type, can be empty or one of: 1 - Most liked, 0 - Relevance

publish_time
string

Date posted filter, can be empty or one of: 0 - All time, 1 - Yesterday, 7 - This week, 30 - This month, 90 - Last 3 months, 180 - Last 6 months

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Top search by text query

General search by text query

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "nike"

Query text

region
required
string
Default: "GB"

Alpha-2 country code

sort_type
string

Sort type, can be empty or one of: 1 - Most liked, 0 - Relevance

publish_time
string

Date posted filter, can be empty or one of: 0 - All time, 1 - Yesterday, 7 - This week, 30 - This month, 90 - Last 3 months, 180 - Last 6 months

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Search insights by text query

Search insights by text query

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "makeup"

Query text

region
required
string
Default: "US"

Alpha-2 country code

count
integer
Default: 25
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Search trending insights

Search trending insights

Authorizations:
ApiKeyAuth
query Parameters
tab
required
string
Default: "all"

Filter category, can be: all, Fashion, Food, Sports, Tourism, Gaming, Science

region
required
string
Default: "US"

Alpha-2 country code

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "banners": {},
  • "cost_tracker": {
    },
  • "cursor": 20,
  • "extra": {
    },
  • "has_more": true,
  • "inspiration_list": [
    ],
  • "status_code": 0,
  • "status_msg": ""
}

Search comment suggested users

Search comment suggested users

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "username"

Username or nickname

region
required
string
Default: "GB"

Alpha-2 country code

count
integer
Default: 10
header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "sug_list": [],
  • "status_code": 0,
  • "status_msg": "",
  • "rid": "20240724154754BEC00A3E8C1C5C50A833",
  • "extra": {
    },
  • "log_pb": {
    },
  • "has_more": 1
}

Search live streams by text query

Search live streams by text query

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "nike"

Query text

region
required
string
Default: "GB"

Alpha-2 country code

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "cursor": 1,
  • "data": [
    ],
  • "extra": {
    },
  • "extra_data": null,
  • "feedback_type": "live",
  • "global_doodle_config": {
    },
  • "guide_search_words": null,
  • "has_more": 1,
  • "log_pb": {
    },
  • "status_code": 0
}

Search locations by text query

Search locations by text query

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "London"

Query text

region
required
string
Default: "GB"

Alpha-2 country code

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "cursor": 20,
  • "extra": {
    },
  • "feedback_type": "poi",
  • "global_doodle_config": {
    },
  • "has_more": 1,
  • "log_pb": {
    },
  • "poi_info": {
    },
  • "status_code": 0
}

Effects

Effect information by ID

Effect information by ID (look at stickers field in video response)

Authorizations:
ApiKeyAuth
path Parameters
sticker_id
required
string
Default: "1108584"
header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Effects information by IDs

Effects information by IDs (look at stickers field in video response)

Authorizations:
ApiKeyAuth
query Parameters
sticker_ids
required
string
Default: "1108584,1108584"

Comma separated ids

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Video by effect ID

Video by effect ID (look at stickers field in video response)

Authorizations:
ApiKeyAuth
path Parameters
sticker_id
required
string
Default: "1108584"
query Parameters
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User

User information by different ID types

User information by different ID types

Authorizations:
ApiKeyAuth
query Parameters
user_id
string
sec_user_id
string
username
string
region
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User information by ID

User information by ID

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6784563164518679557"

user's ID can be uid or sec_uid

query Parameters
region
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User information by username

User information by username

Authorizations:
ApiKeyAuth
path Parameters
username
required
string
Default: "nike"

User public name

query Parameters
region
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User identifiers by username

Get user identifiers by username

Authorizations:
ApiKeyAuth
path Parameters
username
required
string
Default: "nike"

username

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "status_code": 0,
  • "uid": "208464585232822272",
  • "sec_uid": "MS4wLjABAAAA_3ndMt8d_tECTdpKgCxcx238tOnQZX-20wqN01aMui5zQ7hsqSdff-jC5qYC-Cl_",
  • "extra": {
    },
  • "log_pb": {
    }
}

User followers

User followers

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6784563164518679557"

user's ID can be uid or sec_uid

query Parameters
ids_only
integer
Default: 0

If 1 will return only followers IDs, otherwise will return full information

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have min_time value for a next request

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User following list

User following list

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6784563164518679557"

user's ID can be uid or sec_uid

query Parameters
count
integer
Default: 10
ids_only
integer
Default: 0

If 1 will return only followings IDs, otherwise will return full information

offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have min_time value for a next request

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

User playlists

User playlists

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6896921279983977474"

user's ID can be uid or sec_uid

query Parameters
offset
integer
Default: 0

Cursor value from previous response

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "cursor": 2,
  • "extra": {
    },
  • "has_more": false,
  • "log_pb": {
    },
  • "mix_list": [
    ],
  • "status_code": 0,
  • "status_msg": "",
  • "total": 0
}

Playlist information by ID

Playlist information by ID

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6896921279983977474"

user's ID can be uid or sec_uid

playlist_id
required
string
Default: "6974449062670027522"

playlist ID

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Video by playlist ID

Video by playlist ID

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6896921279983977474"

user's ID can be uid or sec_uid

playlist_id
required
string
Default: "6974449062670027522"

Playlist ID

query Parameters
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have max_cursor value for a next set

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

QR code by user ID

QR code by user ID

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6784563164518679557"

user's ID can be uid or sec_uid

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Get live event info by ID

Get live event info by ID

Authorizations:
ApiKeyAuth
path Parameters
event_id
required
string
Default: "7295967245652459563"

Live event ID, can be obtained from user info

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Hashtag (Challenge)

Get hashtag info by ID

Get hashtag info by ID

Authorizations:
ApiKeyAuth
path Parameters
hashtag_id
required
string
Default: "2878999"
header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "rec_list": null,
  • "slide_list": null,
  • "dynamic_list": null,
  • "extra": {
    },
  • "log_pb": {
    },
  • "ch_info": {
    },
  • "status_code": 0
}

Search videos by hashtag ID

Search videos by hashtag ID

Authorizations:
ApiKeyAuth
path Parameters
hashtag_id
required
string
Default: "2878999"
query Parameters
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Music

Music information by ID

Music information by ID

Authorizations:
ApiKeyAuth
path Parameters
music_id
required
string
Default: "6928004115846924290"
query Parameters
region
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Search videos by music ID

Search videos by music ID

Authorizations:
ApiKeyAuth
path Parameters
music_id
required
string
Default: "6928004115846924290"
query Parameters
count
integer
Default: 20
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Get user music list

Get user music list

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "121078843527806976"
query Parameters
count
integer
Default: 30
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Get music charts

Get music charts

Authorizations:
ApiKeyAuth
query Parameters
chart_type
integer
Default: 0

Possible values: 0 - Top 50, 1 - Viral 50. You can get all available values from music_chart_rank.chart_music_info value of the music detail info

region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Location

Get location info by ID

Get location info by ID

Authorizations:
ApiKeyAuth
path Parameters
location_id
required
string
Default: "22535796485353377"
header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Get videos by location ID

Get videos by location ID

Authorizations:
ApiKeyAuth
path Parameters
location_id
required
string
Default: "22535796485353377"
query Parameters
count
integer
Default: 20
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Shop

List of user products from shop tab

List of user products from shop tab

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "MS4wLjABAAAAGSD3UQtwhYFymLHB6uBa1WSvFTuFbJE85rowHL01x7LyVKynsG2BIlsJvAIAM7EB"

user 'sec_uid'

query Parameters
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have next_scroll_param value for a next request

region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "success",
  • "data": {
    }
}

Get product info by ID

Get product info by ID

Authorizations:
ApiKeyAuth
path Parameters
product_id
required
string
Default: "1729443471139309751"

Product ID

query Parameters
locale
string

You can set custom language parameter

region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

List of product reviews

List of product reviews

Authorizations:
ApiKeyAuth
path Parameters
product_id
required
string
Default: "1729443471139309751"

product ID

query Parameters
count
integer
Default: 10
sort_type
integer
Default: 1

1 - Sort by Relevance, 2 - Sort by Recent

filter_id
string

Value from data.review_filters[].filter_id

offset
integer
Default: 1

If in a response the data.has_more parameter equals to 1 then you should use data.next_cursor value for a next request

region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "success",
  • "data": {
    }
}

Shop homepage

Shop homepage

Authorizations:
ApiKeyAuth
query Parameters
region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    },
  • "message": "success"
}

List of recommended products by category

List of recommended products by category

Authorizations:
ApiKeyAuth
query Parameters
count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have 'next_cursor' value for a next request

region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi
Request Body schema: application/json
Array of objects
Default: []

The list of viewed products, which will be excluded from feed list

tab_id
integer
Default: 0

You can get tab_id from 'homepage' request under 'data.feed_data.tabs'

session_id
string

You can get session id from 'homepage' request under 'data.feed data.session id'

Responses

Request samples

Content type
application/json
{
  • "exposure_item_list": [ ],
  • "tab_id": 0,
  • "session_id": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "success",
  • "data": {
    }
}

List of products for new users

List of products for new users

Authorizations:
ApiKeyAuth
query Parameters
session_id
string

You can get 'session_id' from 'data.session_id'

main_tab_id
string

You can get 'main_tab_id' from 'data.main_tab_list[].main_tab_id'

sub_tab_id
string

You can get 'sub_tab_id' from 'data.main_tab_list[].tab_list[].sub_tab_id'

tab_type
string

You can get 'tab_type' from 'data.main_tab_list[].tab_type'

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have 'next_cursor' value for a next request

region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "success",
  • "data": {
    },
  • "uid_prefix": 725,
  • "uid_suffix": 578
}

List of products from flash sale event

List of products from flash sale event

Authorizations:
ApiKeyAuth
query Parameters
session_id
string

You can get 'session_id' from 'data.event_tab_list[].session_id'

event_id
string

You can get 'event_id' from 'data.event_tab_list[].event_id'

tab_id
string

You can get 'tab_id' from 'data.event_tab_list[].tab_list[].tab_id'

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have 'next_cursor' value for a next request

region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "success",
  • "data": {
    },
  • "timestamp": 1688122536
}

Search products by text query

Search products by text query

Authorizations:
ApiKeyAuth
query Parameters
keyword
required
string
Default: "Baby"

Query text

sort_by
string
Default: "PRICE_ASC"

Sort types, possible values: PRICE_ASC, PRICE_DESC, BEST_SELLERS, RELEVANCE

filters_data
string
Default: ""

All available filters can be found under "filter_groups" field from response. The "filters_data" value must be JSON array in format: [{simple filter button},{range/multiple select}, and more filters]. Example for {simple filter button} - {"type": 2, "value": "true"}. Example for {range/multiple select} - {"type":8, "value_list": ["1,1000"]}. Full example with filter by "price" and "4 Stars & Up": [{"type": 2, "value": "true"},{"type":8, "value_list": ["1,1000"]}]

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have cursor value for a next set

region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "status_code": 0,
  • "e_com_items": [],
  • "cursor": 2,
  • "has_more": 1,
  • "extra": {
    },
  • "log_pb": {
    },
  • "global_doodle_config": {
    },
  • "feedback_type": "e_com",
  • "filter_groups": [
    ],
  • "sorters": [
    ],
  • "correct_info": {
    },
  • "e_com_creator_items": [ ],
  • "result_type": 1,
  • "gs_group": [ ],
  • "e_com_shop_card_items": [ ],
  • "server_perf_info": {
    },
  • "voucher_cards": null,
  • "search_query_info": { },
  • "e_com_style": {
    },
  • "guide_type": 0,
  • "backtrace": "ad_cursor%3D2"
}

List of available tabs for seller detail page

List of available tabs for seller detail page

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "7108267082714678277"

user 'uid'

query Parameters
region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "success",
  • "data": {
    }
}

List of products from seller detail page

List of products from seller detail page

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "7108267082714678277"

Numeric user ID - 'uid'

query Parameters
tab_id
integer
Default: 1

You can get 'tab id' from '/v1/shop/products/{user id}/tab_list' response'

count
integer
Default: 10
offset
integer
Default: 0

If in a response you get parameter has more equal to 1 then you also have next scroll param value for a next request

region
required
string
Default: "VN"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

List of products from live stream

List of products from live stream

Authorizations:
ApiKeyAuth
query Parameters
user_id
required
string
Default: "6819032194527888389"

Numeric user ID - 'uid'

room_id
required
string
Default: "7303904795247610657"

Live stream ID

count
integer
Default: 15
offset
integer
Default: 0
region
required
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Get seller info by ID

Get seller info by ID

Authorizations:
ApiKeyAuth
query Parameters
seller_id
required
string
Default: "7495158462353148903"

Seller ID

region
required
string
Default: "US"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    },
  • "message": ""
}

Get product categories

Get product categories

Authorizations:
ApiKeyAuth
query Parameters
seller_id
required
string
Default: "7494986018328054725"

Seller ID

region
required
string
Default: "US"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Get products by category

Get products by category

Authorizations:
ApiKeyAuth
query Parameters
seller_id
required
string
Default: "7494986018328054725"

Seller ID

category_id
required
string
Default: "{\"category_id\":851976}"

Category ID

product_source_type
required
integer
Default: 7

Product source type

count
integer
Default: 20

Number of items per page

scroll_param
string
Default: ""

Scroll value from previous response: data.next_scroll_param

region
required
string
Default: "US"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Get available product sorters

Get available product sorters

Authorizations:
ApiKeyAuth
query Parameters
seller_id
required
string
Default: "7495158462353148903"

Seller ID

region
required
string
Default: "US"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    },
  • "message": ""
}

Get list of seller products

Get list of seller products

Authorizations:
ApiKeyAuth
query Parameters
seller_id
required
string
Default: "7495158462353148903"

Seller ID

locale
string

You can set custom language parameter

count
integer
Default: 20

Number of items per page

scroll_param
string
Default: ""

Scroll value from previous response: data.next_scroll_param

sort_field
integer
Default: 5

Sort type from Get available product sorters response: data.tab_list[*].sort_field

sort_order
integer
Default: 2

Sort type from Get available product sorters response: data.tab_list[*].sort_order

region
required
string
Default: "US"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "data": {
    },
  • "message": ""
}

Live

Get available ranking list

Get available ranking list

Authorizations:
ApiKeyAuth
query Parameters
room_id
required
string
Default: "7300624451387869995"

User room ID, can be obtained from user info response

user_id
required
string
Default: "7283609883211334699"

User numeric ID, can be obtained from user info response

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "extra": {
    },
  • "status_code": 0
}

Get ranking info

Get ranking info

Authorizations:
ApiKeyAuth
query Parameters
rank_type
required
string
Default: "8"

Rank type can be obtained from /v1/live/ranking/list response

room_id
required
string
Default: "7300624451387869995"

User room ID, can be obtained from user info response

user_id
required
string
Default: "7283609883211334699"

User numeric ID, can be obtained from user info response

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "extra": {
    },
  • "status_code": 0
}

Get live feed

Get live feed

Authorizations:
ApiKeyAuth
query Parameters
draw_room_id
string
Default: "7303904572811692833"

The first livestream id (data[0].id_str) from initial live feed response

max_time
string
Default: "1700573843637"

Unix timestamp, use extra.max_time value from previous response

region
string
Default: "GB"

Alpha-2 country code

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "extra": {
    },
  • "status_code": 0
}

Get live info

Get live info

Authorizations:
ApiKeyAuth
query Parameters
room_id
required
string
Default: "7300624451387869995"

User room ID, can be obtained from user info response

user_id
required
string
Default: "7283609883211334699"

User numeric ID, can be obtained from user info response

header Parameters
x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "extra": {
    },
  • "status_code": 0
}

MSSDK

Update device and dyn_seed MSSDK tokens

Update device and dyn_seed MSSDK tokens

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "openudid": "11a486abae082525",
  • "iid": "7377795119196571424",
  • "device_id": "7377793617739646497",
  • "dyn_seed": "MDGlEp3SrXsGJDd6yWpilYWzx+Z/HnAhVzsv9q8IHR3RLxuBGjdrE1d1RkfiNQam2ekGIQfOwhGTtw7OUKz0AQbGlDWMVuZWLNtnmkYQujQyrpMUFrzorioSOX+NuYPLUvE=",
  • "dyn_version": 7,
  • "device_token": "ALT4Aaf35e4kiw6BeDSyAUuwD",
  • "login_token": "0579fbe12a7059c3d921d723f8d99daa230260e9011eaec261159936a5077d85c15ac3f39d8dc813fc8a7fb8067c89be90b03c2b2de64c6ba7f5fd6f5f1d22fc7aa8841c320240771f51124d9a292a584c024be416c08f8111f3ddd0c2a8a09e662bc-CkA4NjViOGM4NTdhOTc5NDQxOWE1YjE3NjA3OWVlNzYwZjJlMGQwYWJmNWFmODgwY2U4ZTI2ZjcxNDg2Y2JhMjJi-2.0.0",
  • "login_token_sign": "1b19fd134bb33a0a442b61055e880ecae8e3d8328d4e0da3b688c401e681a315e012e008c38266345d9a999db782b04e918bffed82617811002aa42822a092065aed73dc5c3150d75e631b2664af99ac8d4d4d9cc543bb5e34e2c5449c0633437721adb3589741354e081bb7606ea678d1bdc54e9f1242dd0e251eb45ff9a178",
  • "cmpl_token": "AgICA6AAFikrPEDsvf3umVda3C9b0jjUliqfF-RPsLZd32cwat0Z_AKpB2wbP6MTYNdChg",
  • "x_bd_lanusk": "#CEvQOeBTSpUvB04WyEX6whfQGTZYeMwUeOXQ7UHBJnjuXTpKWaWtpRKiQzRYm3cSb6YLgBWOUWFjGtsL",
  • "x_bd_lanusv": "0",
  • "client_key": "",
  • "kmsv": "",
  • "region": "GB",
  • "app_language": "en",
  • "language": "en",
  • "sys_region": "GB",
  • "carrier_region": "GB",
  • "op_region": "GB",
  • "locale": "en-GB",
  • "device_type": "SM-N985F",
  • "device_brand": "Samsung",
  • "device": "c2s",
  • "cpu_support_64": "false",
  • "host_abi": "arm64-v8a",
  • "resolution_width": "1080",
  • "resolution_height": "2009",
  • "clientudid": "f6dc5813-c6ba-495a-afc8-5628d124461e",
  • "request_id": "60297256-46cc-4058-b2b4-f5be05a1fa09",
  • "ac2": "wifi5g",
  • "cdid": "176a5d57-b710-4891-9d99-7b64d7994b50",
  • "os_api": "30",
  • "timezone_name": "Europe/London",
  • "dpi": 300,
  • "display_density": "mdpi",
  • "ac": "wifi",
  • "os_version": "11",
  • "timezone_offset": 3600,
  • "mcc_mnc": "23415",
  • "carrier_name": "Vodafone",
  • "carrier_region_v2": 234,
  • "device_platform": "android",
  • "install_time": 1717942441,
  • "rom": "N985FXXU1CTL5",
  • "ro_incr": "N985FXXU1CTL5",
  • "build_id": "RP1A.200720.012.N985FXXU1CTL5",
  • "rom_compile_UTC": 1686413701,
  • "rom_version": "RP1A.200720.012",
  • "app_log_session_id": "ee18828e-cb73-4c3e-bd99-a313038e309c",
  • "token_request_session_id": "0aaebc9e-6d8f-4a99-a06e-c15f8e94d163",
  • "ram_total_size": 3221225472,
  • "internal_storage_size": 68719476736,
  • "internal_free_size": 64514678146,
  • "sdcard_size": 68719476736,
  • "drm_id": "EVBfY1zp8JUsqqpUmdDutviXGWQjfTXtnUaa9lSowM0=",
  • "report_session_id": "40af9bdb-fda2-46d7-82f2-a42c698ee87a",
  • "boot_time_UTC": 1717778241,
  • "wifi_ip_full": "192.168.0.37",
  • "wifi_ip": "620800192",
  • "wifi_gateway_ip": "192.168.0.16",
  • "dns_list": "[\"8.8.8.8\",\"1.1.1.1\"]",
  • "app_start_time": 1717780341,
  • "storage_change": 1717778241,
  • "package_path": "/data/app/~~GWewt1ZLULxLih0_i5Ck6Q==/com.zhiliaoapp.musically-Ky_KAWxqI3hdbt6CaszlxQ==/base.apk",
  • "cpu_core_num": 8,
  • "proc_name": "exynos990",
  • "cpu_max_frequency": "2002000",
  • "cpu_min_frequency": "442000",
  • "supported_commands": "fp asimd evtstrm aes pmull sha1 sha2 crc32 atomics fphp asimdhp cpuid asimdrdm lrcpc dcpop asimddp",
  • "board": "exynos990",
  • "ro_product_name": "c2sxx",
  • "platform_board": "exynos990",
  • "launch_first_time": 1717942501000,
  • "device_product": "SM-N985F",
  • "arch": "arm64",
  • "libc_hash": 419838062,
  • "libc_hash_2": "2560b9c58465d98db78b5f4ca410b68f067a38ff",
  • "ro_build_tags": "release-keys",
  • "fingerprint": "samsung/c2sxx/c2s:11/RP1A.200720.012/N985FXXU1CTL5:user/release-keys",
  • "ro_desc": "Samsung SM-N985F c2s 11 RP1A.200720.012 N985FXXU1CTL5 user release-keys",
  • "battery_capacity": 4900,
  • "total_requests": null,
  • "report_count": null,
  • "settings_count": null
}

Messages

Create conversation

Create conversation

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
from_user_id
required
string
Default: "6753671359782732806"

Logged in user ID

to_user_id
required
string
Default: "614376625114341274"

Conversation partner user ID

Responses

Request samples

Content type
application/json
{
  • "from_user_id": "6753671359782732806",
  • "to_user_id": "614376625114341274"
}

Response samples

Content type
application/json
{
  • "cmd": 609,
  • "sequence_id": "85368",
  • "status_code": 0,
  • "error_desc": "OK",
  • "inbox_type": 0,
  • "body": {
    },
  • "log_id": "20230924224544E7152CD7FF85D590B242",
  • "request_arrived_time": "1695595545599",
  • "server_execution_end_time": "1695595545640"
}

Send message

Send message

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
message
required
string
Default: "Hey, test"

Message text

conversation_id
required
string
Default: "0:1:6584376625114349574:6732671359782731206"

Conversation ID

conversation_short_id
required
string
Default: "7282508034432385296"

Conversation short ID

conversation_type
required
integer
Default: 1

Conversation type

Responses

Request samples

Content type
application/json
{
  • "message": "Hey, test",
  • "conversation_id": "0:1:6584376625114349574:6732671359782731206",
  • "conversation_short_id": "7282508034432385296",
  • "conversation_type": 1
}

Response samples

Content type
application/json
{
  • "cmd": 100,
  • "sequence_id": "974388",
  • "status_code": 0,
  • "error_desc": "OK",
  • "inbox_type": 0,
  • "body": {
    },
  • "log_id": "202309242332146107B04ACEAEA5A13A2E",
  • "request_arrived_time": "1695598335673",
  • "server_execution_end_time": "1695598335845"
}

User messages

User messages

Authorizations:
ApiKeyAuth
query Parameters
cursor
integer
Default: 0

Cursor value from previous response

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "cmd": 200,
  • "sequence_id": "678913",
  • "status_code": 0,
  • "error_desc": "OK",
  • "inbox_type": 0,
  • "body": {
    },
  • "log_id": "20230924234809C2268AE4CA8DB7DFCFDD",
  • "request_arrived_time": "1695599290613",
  • "server_execution_end_time": "1695599290631"
}

User conversations

User conversations

Authorizations:
ApiKeyAuth
query Parameters
cursor
integer
Default: 0

Cursor value from previous response

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "cmd": 2006,
  • "sequence_id": "876670",
  • "status_code": 0,
  • "error_desc": "OK",
  • "inbox_type": 0,
  • "body": {
    },
  • "log_id": "20230925211849C75FB5D38F51897C52D6",
  • "request_arrived_time": "1695676730208",
  • "server_execution_end_time": "1695676730257"
}

User conversation requests

Get list of current user conversations requests including the latest message.

Authorizations:
ApiKeyAuth
query Parameters
count
integer
Default: 10
cursor
integer
Default: 0

Cursor value from previous response

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "cmd": 1001,
  • "sequence_id": "310555",
  • "status_code": 0,
  • "error_desc": "OK",
  • "inbox_type": 0,
  • "body": {
    },
  • "log_id": "20230925211553474ACA49685D6500CE6D",
  • "request_arrived_time": "1695676553950",
  • "server_execution_end_time": "1695676553997"
}

Messages from conversation request

Get list of messages from conversation request

Authorizations:
ApiKeyAuth
query Parameters
conversation_short_id
required
string
Default: "7282867602539053328"

Conversation short id from conversation info

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "cmd": 1002,
  • "sequence_id": "656376",
  • "status_code": 0,
  • "error_desc": "OK",
  • "inbox_type": 0,
  • "body": {
    },
  • "log_id": "2023092521254162E2A9357C09A601813B",
  • "request_arrived_time": "1695677141132",
  • "server_execution_end_time": "1695677141164"
}

Messages from conversation

Get list of messages from conversation

Authorizations:
ApiKeyAuth
query Parameters
conversation_id
required
string
Default: "0:1:6753671359782732806:7267974963185271850"

Conversation ID from conversation info

conversation_short_id
required
string
Default: "7282867602539053328"

Conversation short ID from conversation info

cursor
integer
Default: 0

If in a response you get parameter has_more equal to 1 then you also have next_cursor value for a next request

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "cmd": 301,
  • "sequence_id": "641119",
  • "status_code": 0,
  • "error_desc": "OK",
  • "inbox_type": 0,
  • "body": {
    },
  • "log_id": "20230925223540217D256B1BD4BA03795E",
  • "request_arrived_time": "1695681340604",
  • "server_execution_end_time": "1695681340626"
}

Approve conversation request

Approve conversation request

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
to_user_id
required
string
Default: "6753671359782732806"

User ID from conversation request

sec_to_user_id
required
string
Default: "0:1:6584376625114349574:6732671359782731206"

Sec user ID from conversation request

conversation_id
required
string
Default: "0:1:6584376625114349574:6732671359782731206"

Conversation ID

Responses

Request samples

Content type
application/json
{
  • "to_user_id": "6753671359782732806",
  • "sec_to_user_id": "0:1:6584376625114349574:6732671359782731206",
  • "conversation_id": "0:1:6584376625114349574:6732671359782731206"
}

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": ""
}

Delete conversation request

Delete conversation request

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
conversation_id
required
string
Default: "0:1:6584376625114349574:6732671359782731206"

Conversation ID

conversation_short_id
required
string
Default: "7282689113353945362"

Conversation short ID

Responses

Request samples

Content type
application/json
{
  • "conversation_id": "0:1:6584376625114349574:6732671359782731206",
  • "conversation_short_id": "7282689113353945362"
}

Response samples

Content type
application/json
{
  • "cmd": 603,
  • "sequence_id": "803363",
  • "status_code": 0,
  • "error_desc": "OK",
  • "inbox_type": 0,
  • "body": { },
  • "log_id": "202309252202578FE3EBDDDCA16900CE81",
  • "request_arrived_time": "1695679377556",
  • "server_execution_end_time": "1695679377599"
}

Manipulations

Like video by ID

Like video by ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string

Numeric video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "is_digg": 0,
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": ""
}

Dislike video by ID

Dislike video by ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string

Numeric video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "is_digg": 1,
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": ""
}

Save video by ID

Save video by ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string

Numeric video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": "saved"
}

Remove saved videos by video ID

Remove from saved videos by video ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string

Numeric video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": "unsave"
}

Share video by ID

Share video by ID

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string

Numeric video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0
}

View user profile by IDs

View user profile by IDs

Authorizations:
ApiKeyAuth
query Parameters
user_id
required
string

Numeric user ID

sec_user_id
required
string

String user ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": ""
}

Follow user by ID

Follow user by ID

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string

user's ID can be uid or sec_uid

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "follow_status": 1,
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": "",
  • "watch_status": 1
}

Unfollow user by ID

Unfollow user by ID

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string

user's ID can be uid or sec_uid

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "follow_status": 0,
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": "",
  • "watch_status": 0
}

Send email verification code

Send email verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Check email verification code

Check email verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "success"
}

Set initial password

Set initial password. You can't change password by this endpoint.

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "data": null,
  • "message": "success"
}

Send mobile verification code

Send mobile verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
string
Default: "+55 12345678901"

Phone number MUST be separated by space between country code and number

Responses

Request samples

Content type
application/json
{
  • "phone": "+55 12345678901"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "success"
}

Check mobile verification code

Check mobile verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "success"
}

Link mobile phone

Link mobile phone

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
code
required
string

6 digits code from SMS

phone
required
string
Default: "+55 12345678901"

Phone number MUST be separated by space between country code and number

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "phone": "+55 12345678901"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "success"
}

Unlink mobile phone

Unlink mobile phone

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
ticket
required
string

Responses

Request samples

Content type
application/json
{
  • "ticket": "string"
}

Response samples

Content type
application/json
{
  • "data": { },
  • "message": "success"
}

Account

Update user profile

Update user profile

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6753671359782732806"

Numeric user ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
required
object
bio_url
string

Company website link (can not be set time to time and API throw 2433 error)

bio_email
string

Company email

nickname
string

User nickname

signature
string

User profile description

signature_user_mention_ids
object

Mentioned user identifiers

avatar_uri
string

Any http/https link to image, or base64 encoded string

Responses

Request samples

Content type
application/json
{
  • "profile": {
    }
}

Response samples

Content type
application/json
{}

Update username

Update username

Authorizations:
ApiKeyAuth
path Parameters
user_id
required
string
Default: "6753671359782732806"

Numeric user ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
username
string

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "success"
}

Enable business account

Enable business account.

Available category IDs:

  • "art_crafts",
  • "automotive_transportation",
  • "baby",
  • "beauty",
  • "clothing_accessories",
  • "education_training",
  • "electronics",
  • "finance_investing",
  • "food_beverage",
  • "gaming",
  • "health_wellness",
  • "home_furniture_appliances",
  • "machinery_equipment",
  • "media_entertainment",
  • "personalblog",
  • "pets",
  • "professional_services",
  • "public_administration",
  • "real_estate",
  • "restaurants_bars",
  • "shopping_retail",
  • "software_apps",
  • "sports_fitness_outdoors",
  • "travel_tourism",
  • "others"

Available category names:

  • "Art & Crafts",
  • "Automotive & Transportation",
  • "Baby",
  • "Beauty",
  • "Clothing & Accessories",
  • "Education & Training",
  • "Electronics",
  • "Finance & Investing",
  • "Food & Beverage",
  • "Gaming",
  • "Health & Wellness",
  • "Home,
  • Furniture & Appliances",
  • "Machinery & Equipment",
  • "Media & Entertainment",
  • "Personal Blog",
  • "Pets",
  • "Professional Services",
  • "Public Administration",
  • "Real Estate",
  • "Restaurants & Bars",
  • "Shopping & Retail",
  • "Software & Apps",
  • "Sports,
  • Fitness & Outdoors",
  • "Travel & Tourism",
  • "Others"
Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
required
object
category_id
string

Category ID

category_name
string

Category Name

Responses

Request samples

Content type
application/json
{
  • "settings": {
    }
}

Response samples

Content type
application/json
{}

Disable business account

Disable business account

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": ""
}

Change user account settings

Change user account settings, available field names:

  • profile_view_history - enable/disable profile view history
  • favorite - enable/disable liked videos public availability
  • author_review_all_comments - enable/disable comments moderation
  • private_account - enable/disable account visibility
Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
field
required
string

Field name, for example: 'author_review_all_comments'

value
required
string

Field value, for example: '1'

Responses

Request samples

Content type
application/json
{
  • "field": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": ""
}

Get list of users visited account profile

Get list of users visited account profile

Authorizations:
ApiKeyAuth
query Parameters
offset
string
Default: ""

Cursor value from previous response

count
integer
Default: 20

Number of items

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Get logged in user info

Get logged in user info

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{}

Login token beat

Use it to prevent login token expiration

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "success"
}

Get account region info by login

Get account region info by login

Authorizations:
ApiKeyAuth
header Parameters
x-project-name
required
string
Default: tokapi
Request Body schema: application/json
login
required
string

Can be email, login or phone number

Responses

Request samples

Content type
application/json
{
  • "login": "string"
}

Response samples

Content type
application/json
{
  • "region": "US"
}

Login

Login with email and password

Login with email and password

Authorizations:
ApiKeyAuth
header Parameters
x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-region
string
Default: US

Provide region in ISO-3166 format, this region will be used for device generation

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
email
required
string

Email or login

password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "cookie": "cmpl_token=AgQQAPP2F-RPsLEC6fb4890_-wnYvH*****PwCTQ;d_ticket=078ee01533ebc1beebc2f3d71c130765f0cd7;multi_sids=7006483*****230%3Ace6f9c10*****e19dc61538;odin_tt=0a31277*****869e3745bfa6ad6e51c35f5a7d3be87fb4ef40c204509822e4f4d0f099ce9f173ebba9d78018332860f382a21b78b833c83b1b722ee5d9364cd3fb2e0bd660f9f1895de1243;sessionid=ce6f9c102fcb*****e19dc61538;sessionid_ss=ce6f9c102fcbd90*****e19dc61538;sid_guard=ce6f9c*****61538%7C1634222995%7C5184000%7CMon%2C+13-Dec-2021+14%3A49%3A55+GMT;sid_tt=ce6f9c102f*****17b15e19dc61538;store-country-code=us;store-idc=maliva;uid_tt=c47f3bcb7d78fb*****c4cf6c4b2d3bf08fdd62ffb06380a362a0538fd482;uid_tt_ss=c47f3bcb7d78f*****c4b2d3bf08fdd62ffb06380a362a0538fd482",
  • "device": {
    },
  • "response": {
    }
}

Check email verification code

Check email verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
code
required
string
verify_ticket
required
string

verify ticket string from 403 login API response

email
required
string

Email login

password
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "verify_ticket": "string",
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "cookie": "cmpl_token=AgQQAPP2F-RPsLEC6fb4890_-wnYvH*****PwCTQ;d_ticket=078ee01533ebc1beebc2f3d71c130765f0cd7;multi_sids=7006483*****230%3Ace6f9c10*****e19dc61538;odin_tt=0a31277*****869e3745bfa6ad6e51c35f5a7d3be87fb4ef40c204509822e4f4d0f099ce9f173ebba9d78018332860f382a21b78b833c83b1b722ee5d9364cd3fb2e0bd660f9f1895de1243;sessionid=ce6f9c102fcb*****e19dc61538;sessionid_ss=ce6f9c102fcbd90*****e19dc61538;sid_guard=ce6f9c*****61538%7C1634222995%7C5184000%7CMon%2C+13-Dec-2021+14%3A49%3A55+GMT;sid_tt=ce6f9c102f*****17b15e19dc61538;store-country-code=us;store-idc=maliva;uid_tt=c47f3bcb7d78fb*****c4cf6c4b2d3bf08fdd62ffb06380a362a0538fd482;uid_tt_ss=c47f3bcb7d78f*****c4b2d3bf08fdd62ffb06380a362a0538fd482",
  • "device": {
    },
  • "response": {
    }
}

Check is phone registered

Check is phone registered

Authorizations:
ApiKeyAuth
header Parameters
x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
required
string
Default: "+55 12345678901"

Phone number MUST be separated by space between country code and number

Responses

Request samples

Content type
application/json
{
  • "phone": "+55 12345678901"
}

Response samples

Content type
application/json
{
  • "registered": true,
  • "raw_tiktok_response": {
    }
}

Login by phone number

Login by phone number

Authorizations:
ApiKeyAuth
header Parameters
x-device
string
x-cookie
string
x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-region
string
Default: US

Provide region in ISO-3166 format, this region will be used for device generation

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
required
string

Phone number MUST be separated by space between country code and number

Responses

Request samples

Content type
application/json
{
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "error"
}

Check mobile verification code

Check mobile verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
required
string

Phone number MUST be separated by space between country code and number

code
required
string

Code from SMS

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "cookie": "cmpl_token=AgQQAPNSF-RPsI2HMvYxpp0_-wkD8BIQ_4PZYPwEwA;d_ticket=dd29cf732a6eea7816ef7dfead****e1de02b;multi_sids=675367135978273****%3A55efe570bb0ed1d9433b0b****c9a51a;odin_tt=31be249827bee9bb31fb5de212855aa****497c824e2e0dd77c34d4f8a5fa7b8cdef813c583e6bd77aaddfbdffb9dec2417023b2ae27fb467f8d47989351a377ce3132848ecbdc771fbf77ac3f4a1aa;sessionid=55efe570bb0ed****33b0b3a21c9a51a;sessionid_ss=55efe570bb0ed****33b0b3a21c9a51a;sid_guard=55efe570bb0ed1d9433b0b3****9a51a%7C1634245738%7C5184000%7CMon%2C+13-Dec-2021+21%3A08%3A58+GMT;sid_tt=55efe570bb0ed1****3b0b3a21c9a51a;store-country-code=ru;store-idc=alisg;uid_tt=976e7baef19e35c20834****39607d1ab59b04708c2e19c1d8b90a6e2969857;uid_tt_ss=976e7baef19e****0834bae9f39607d1ab59b04708c2e19c1d8b90a6e2969857",
  • "device": {
    },
  • "response": {
    }
}

Send verification code for password reset

Send verification code for password reset

Authorizations:
ApiKeyAuth
header Parameters
x-region
required
string

Provide region in ISO-3166 format, this region will be used for device generation

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "response": {},
  • "device": {
    },
  • "cookie": "sessionid=32004b3e280e38abe38ebf21cb36dd3d;sessionid_ss=32004b3e280e38abe38ebf21cb36dd3d;install_id=7368437175451879173;store-country-code=ru;store-country-code-src=did;store-idc=alisg;ttreq=1$52c92dd24cb97d61850a6dfa78423c9c34c03b0c;msToken=Q85IlVY4gFzCczog8XQX-EZY3aJQA2plHUfIQV1rqo0tvufWZCNA1Hz849OcyfkVwOJkiT7Re5dbMY4P3ZZU9KEwYvxkjedN0osq-5jVpvFmsWANogrV7_ToitS6JGWM;odin_tt=b0bab8ba22a137b5212651bbe70eeebadc1b293deea00799944945d72e135b6a2fc4b0c980511fc3b88b3c09d983a68316087c5fc9b35c1ba1de18174cf538c05f73ae1cc1ca6321d7ee9d78f4c90cc1;passport_csrf_token=474c69a02f1a64b17787eb5dc883e30e;passport_csrf_token_default=474c69a02f1a64b17787eb5dc883e30e;tt-target-idc=alisg;tt-target-idc-sign=dDURSFLY4nb-gkc7Tv_alu1XHwO01rbe4Sit4sJVB18EKJouZfzNMPcPGeUGCqT-ld_B2giRfwoIdDI8u8PWWEzyjfrcSLUMfi2I5Cpvc88WbFtREF610uxb9KFf7gOvwiCLylSJJtjJe2AlkgTD1eq7cqCrMuRfbI3Qi_-aBoo_2NibDf4xrVzetOc-jYByFQy50fzwgNORV_uvaQzDmXQmHOejC1Ajk1XbUIp0PxfRVNJNQuraPAjAY0BALlW2wK0NrWwlti6EN0CFncBEYJodVlsJU0Ql0XjtEEpBIIQA1UA-nXMvf4WheOlb1EOnhIZtb0QGyKImaJWcQrQkO0wcaaUBFyI7GNmOGMCAxpwrK7VN9J1gXZo33s1WZ4ezgSiNyhkNfNDBAhdPNz-1jRmedOoHcZJT3Srpzw411NTvcyOmeSzo2aA4utYg-MMD7vsszcxz9hpn61X-m0tJBkehReYKOQy0JpQkjFl6kjj8iM5SRamD4ctRZKvgLja_"
}

Check forgot password verification code

Check forgot password verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
email
required
string
code
required
string
password
required
string

New password

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "code": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "cookie": "cmpl_token=AgQQAPP2F-RPsLEC6fb4890_-wnYvH*****PwCTQ;d_ticket=078ee01533ebc1beebc2f3d71c130765f0cd7;multi_sids=7006483*****230%3Ace6f9c10*****e19dc61538;odin_tt=0a31277*****869e3745bfa6ad6e51c35f5a7d3be87fb4ef40c204509822e4f4d0f099ce9f173ebba9d78018332860f382a21b78b833c83b1b722ee5d9364cd3fb2e0bd660f9f1895de1243;sessionid=ce6f9c102fcb*****e19dc61538;sessionid_ss=ce6f9c102fcbd90*****e19dc61538;sid_guard=ce6f9c*****61538%7C1634222995%7C5184000%7CMon%2C+13-Dec-2021+14%3A49%3A55+GMT;sid_tt=ce6f9c102f*****17b15e19dc61538;store-country-code=us;store-idc=maliva;uid_tt=c47f3bcb7d78fb*****c4cf6c4b2d3bf08fdd62ffb06380a362a0538fd482;uid_tt_ss=c47f3bcb7d78f*****c4b2d3bf08fdd62ffb06380a362a0538fd482",
  • "device": {
    },
  • "response": {
    }
}

Send verification code for password reset

Send verification code for password reset

Authorizations:
ApiKeyAuth
header Parameters
x-region
required
string

Provide region in ISO-3166 format, this region will be used for device generation

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "device": {
    },
  • "cookie": "sessionid=32004b3e280e38abe38ebf21cb36dd3d;sessionid_ss=32004b3e280e38abe38ebf21cb36dd3d;install_id=7368437175451879173;store-country-code=ru;store-country-code-src=did;store-idc=alisg;ttreq=1$52c92dd24cb97d61850a6dfa78423c9c34c03b0c;msToken=Q85IlVY4gFzCczog8XQX-EZY3aJQA2plHUfIQV1rqo0tvufWZCNA1Hz849OcyfkVwOJkiT7Re5dbMY4P3ZZU9KEwYvxkjedN0osq-5jVpvFmsWANogrV7_ToitS6JGWM;odin_tt=b0bab8ba22a137b5212651bbe70eeebadc1b293deea00799944945d72e135b6a2fc4b0c980511fc3b88b3c09d983a68316087c5fc9b35c1ba1de18174cf538c05f73ae1cc1ca6321d7ee9d78f4c90cc1;passport_csrf_token=474c69a02f1a64b17787eb5dc883e30e;passport_csrf_token_default=474c69a02f1a64b17787eb5dc883e30e;tt-target-idc=alisg;tt-target-idc-sign=dDURSFLY4nb-gkc7Tv_alu1XHwO01rbe4Sit4sJVB18EKJouZfzNMPcPGeUGCqT-ld_B2giRfwoIdDI8u8PWWEzyjfrcSLUMfi2I5Cpvc88WbFtREF610uxb9KFf7gOvwiCLylSJJtjJe2AlkgTD1eq7cqCrMuRfbI3Qi_-aBoo_2NibDf4xrVzetOc-jYByFQy50fzwgNORV_uvaQzDmXQmHOejC1Ajk1XbUIp0PxfRVNJNQuraPAjAY0BALlW2wK0NrWwlti6EN0CFncBEYJodVlsJU0Ql0XjtEEpBIIQA1UA-nXMvf4WheOlb1EOnhIZtb0QGyKImaJWcQrQkO0wcaaUBFyI7GNmOGMCAxpwrK7VN9J1gXZo33s1WZ4ezgSiNyhkNfNDBAhdPNz-1jRmedOoHcZJT3Srpzw411NTvcyOmeSzo2aA4utYg-MMD7vsszcxz9hpn61X-m0tJBkehReYKOQy0JpQkjFl6kjj8iM5SRamD4ctRZKvgLja_"
}

Check forgot password verification code

Check forgot password verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
required
string
code
required
string
password
required
string

New password

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "code": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "cookie": "cmpl_token=AgQQAPP2F-RPsLEC6fb4890_-wnYvH*****PwCTQ;d_ticket=078ee01533ebc1beebc2f3d71c130765f0cd7;multi_sids=7006483*****230%3Ace6f9c10*****e19dc61538;odin_tt=0a31277*****869e3745bfa6ad6e51c35f5a7d3be87fb4ef40c204509822e4f4d0f099ce9f173ebba9d78018332860f382a21b78b833c83b1b722ee5d9364cd3fb2e0bd660f9f1895de1243;sessionid=ce6f9c102fcb*****e19dc61538;sessionid_ss=ce6f9c102fcbd90*****e19dc61538;sid_guard=ce6f9c*****61538%7C1634222995%7C5184000%7CMon%2C+13-Dec-2021+14%3A49%3A55+GMT;sid_tt=ce6f9c102f*****17b15e19dc61538;store-country-code=us;store-idc=maliva;uid_tt=c47f3bcb7d78fb*****c4cf6c4b2d3bf08fdd62ffb06380a362a0538fd482;uid_tt_ss=c47f3bcb7d78f*****c4b2d3bf08fdd62ffb06380a362a0538fd482",
  • "device": {
    },
  • "response": {
    }
}

Send verification code for account recover

Send verification code for account recover

Authorizations:
ApiKeyAuth
header Parameters
x-region
required
string

Provide region in ISO-3166 format, this region will be used for device generation

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "device": {
    },
  • "cookie": "store-idc=alisg;store-country-code=..."
}

Check recover account verification code

Check recover account verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
required
string
ticket
required
string
code
required
string

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "ticket": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "response": {
    },
  • "device": {
    },
  • "cookie": "store-idc=alisg;store-country-code=..."
}

Signup

Signup by mobile phone number

Signup by mobile phone number

Authorizations:
ApiKeyAuth
header Parameters
x-device
string
x-cookie
string
x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-region
string
Default: US

Provide region in ISO-3166 format, this region will be used for device generation

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
required
string

Phone number MUST be separated by space between country code and number

birthday
required
string

Birthday date, format: YYYY-MM-D, example: 1983-10-16

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "birthday": "1983-10-16"
}

Response samples

Content type
application/json
{
  • "error": "The phone field in request body must be present"
}

Check mobile verification code

Check mobile verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
phone
required
string

Phone number MUST be separated by space between country code and number

code
required
string

Code from SMS

birthday
required
string

Birthday date, format: YYYY-MM-D, example: 1983-10-16

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "code": "string",
  • "birthday": "1983-10-16"
}

Response samples

Content type
application/json
{
  • "cookie": "cmpl_token=AgQQAPNSF-RPsI2HMvYxpp0_-wkD8BIQ_4PZYPwEwA;d_ticket=dd29cf732a6eea7816ef7dfead****e1de02b;multi_sids=675367135978273****%3A55efe570bb0ed1d9433b0b****c9a51a;odin_tt=31be249827bee9bb31fb5de212855aa****497c824e2e0dd77c34d4f8a5fa7b8cdef813c583e6bd77aaddfbdffb9dec2417023b2ae27fb467f8d47989351a377ce3132848ecbdc771fbf77ac3f4a1aa;sessionid=55efe570bb0ed****33b0b3a21c9a51a;sessionid_ss=55efe570bb0ed****33b0b3a21c9a51a;sid_guard=55efe570bb0ed1d9433b0b3****9a51a%7C1634245738%7C5184000%7CMon%2C+13-Dec-2021+21%3A08%3A58+GMT;sid_tt=55efe570bb0ed1****3b0b3a21c9a51a;store-country-code=ru;store-idc=alisg;uid_tt=976e7baef19e35c20834****39607d1ab59b04708c2e19c1d8b90a6e2969857;uid_tt_ss=976e7baef19e****0834bae9f39607d1ab59b04708c2e19c1d8b90a6e2969857",
  • "device": {
    },
  • "response": {
    }
}

Signup by email

Signup by email

Authorizations:
ApiKeyAuth
header Parameters
x-device
string
x-cookie
string
x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-region
string
Default: US

Provide region in ISO-3166 format, this region will be used for device generation

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
email
required
string
password
required
string
birthday
required
string

Birthday date, format: YYYY-MM-D, example: 1983-10-16

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "birthday": "1983-10-16"
}

Response samples

Content type
application/json
{
  • "error": "The email field in request body must be present"
}

Check email verification code

Check email verification code

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
email
required
string
code
required
string
birthday
required
string

Birthday date, format: YYYY-MM-D, example: 1983-10-16

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "code": "string",
  • "birthday": "1983-10-16"
}

Response samples

Content type
application/json
{
  • "cookie": "cmpl_token=AgQQAPP2F-RPsLEC6fb4890_-wnYvH*****PwCTQ;d_ticket=078ee01533ebc1beebc2f3d71c130765f0cd7;multi_sids=7006483*****230%3Ace6f9c10*****e19dc61538;odin_tt=0a31277*****869e3745bfa6ad6e51c35f5a7d3be87fb4ef40c204509822e4f4d0f099ce9f173ebba9d78018332860f382a21b78b833c83b1b722ee5d9364cd3fb2e0bd660f9f1895de1243;sessionid=ce6f9c102fcb*****e19dc61538;sessionid_ss=ce6f9c102fcbd90*****e19dc61538;sid_guard=ce6f9c*****61538%7C1634222995%7C5184000%7CMon%2C+13-Dec-2021+14%3A49%3A55+GMT;sid_tt=ce6f9c102f*****17b15e19dc61538;store-country-code=us;store-idc=maliva;uid_tt=c47f3bcb7d78fb*****c4cf6c4b2d3bf08fdd62ffb06380a362a0538fd482;uid_tt_ss=c47f3bcb7d78f*****c4b2d3bf08fdd62ffb06380a362a0538fd482",
  • "device": {
    },
  • "response": {
    }
}

Comments

Like comment

Like comment

Authorizations:
ApiKeyAuth
path Parameters
comment_id
required
string
Default: "7262426355802882823"

Comment ID

post_id
required
string
Default: "7261987687257754888"

Video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": ""
}

Unlike comment

Unlike comment

Authorizations:
ApiKeyAuth
path Parameters
comment_id
required
string
Default: "7262426355802882823"

Comment ID

post_id
required
string
Default: "7261987687257754888"

Video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "status_code": 0,
  • "status_msg": ""
}

Publish comment

Publish comment

Authorizations:
ApiKeyAuth
path Parameters
post_id
required
string
Default: "7026290767001816326"

Video ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi
Request Body schema: application/json
text
string
Default: "Comment text"
object

List of user identifiers in case if you use mention in comment text

reply_id
string
Default: "7367391866033488646"

ID of the comment we will reply

Responses

Request samples

Content type
application/json
{
  • "text": "Comment text",
  • "user_ids": {
    },
  • "reply_id": "7367391866033488646"
}

Response samples

Content type
application/json
{}

Delete comment

Delete comment

Authorizations:
ApiKeyAuth
path Parameters
comment_id
required
string
Default: "7026293859697804037"

Comment ID

header Parameters
x-device
required
string

JSON string with device config from login API response

x-cookie
required
string

Cookie string from login API response

x-proxy
required
string

Provide your proxy here. A http, https, socks4 and socks5 proxy supported

x-project-name
required
string
Default: tokapi

Responses

Response samples

Content type
application/json
{
  • "extra": {
    },
  • "log_pb": {
    },
  • "msg": "success",
  • "status_code": 0
}