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
{}

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-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
}

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": {
    }
}

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 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
{}

Service

Sign request

Sign request

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

Device config object from generate_device endpoint

app_parameters
object

Application parameters from generate_device endpoint

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "headers": {
    },
  • "device": { },
  • "app_parameters": { }
}

Response samples

Content type
application/json
{
  • "X-Argus": "V92ftPqBHMxhN9rTFm4Rbrh4Itzwt+OBRw/2i3bU5lhePnCWMaHAGoNEArRvdyAG1axDWz9dVJ/tpuH/QFpIqseaC5RMZBppkyLj4EKji+Tz1qLVxyOFJcDBq3CQiPpCrYl35p6q1q9s24bZvch++DJ6bZCH55bSneapZeP7WAX/hBah+YlHtF0A8b0g/51yRPb44mEiMZ7Mr8IK+OnCoGMG6Q6uAW4e4XOCPSmz6A8AHQog+iltoJwfNJJu3Svt39Y=",
  • "X-Gorgon": "0404809400006ad894871658c6a9b250136de9bceec5c65da21e",
  • "X-Khronos": "1635197733",
  • "X-Ladon": "EZqUIlagRBCdE3Z9X7CLdbZGTXZRVCnwJfpm+WQrzhbO4fMi"
}

Generate a new device

Generate a new device

Authorizations:
ApiKeyAuth
header Parameters
x-proxy
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
region
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "cookie": "install_id=7086462661483218690;store-country-code=us;store-idc=alisg;ttreq=1$b00e22b9e6b19d61fcd335a94f0496a834f748cd",
  • "device": {
    }
}

Decrypt x-argus

Decrypt x-argus

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

base64 encoded string

Responses

Request samples

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

Response samples

Content type
application/json
"08d2a4808204100218ee869f870b220431323333320a323134323834303535313a0632362e342e3542147630342e30342e30302d6f762d616e64726f696448c080a040520800000000000000006088a7cbd00c6a0666e70bdc8421720673bd402436597a0e086410022802300238a086cbd00c880188a7cbd00ca201046e6f6e65a801f004ba01200a0a4d4756323030325f484b100e1a0a676f6f676c65706c61792080a083c402"

Encrypt x-argus

Encrypt x-argus

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

argus protobuf message in hex format

Responses

Request samples

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

Response samples

Content type
application/json
"mYAzQO/Ig/NxMsd8c8IfpWRhV7LqsAVvBTCUyA3opxOaRDd9gIoS7nH+rCrEO7UfDe8f/VGA6agoKIfqyrzUvPDcvHBDdCZTRYVn0P/XCaYO0FDgaf865KhD8Vi9598MS+y+EQY9f4LDgJ5OsCQrVXNpqyvaJjaQjdX+4OqTL10AthT6atvGjU21D9rME7HlkvKSdZ6/dl0Czt+R6h8fNFMhdrMvX/S8I4Ynnqw7op/wgUNSvgvVAAMy5D+yO2pdxswH0zH5Q/J5TKnDshkibzk6"

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

Send sdi/get_token

Send sdi/get_token request and return device_token string

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
"Ag3NiE93HosYioaTRPRX3z639"

Send ms/get_seed

Send ms/get_seed request and return dyn_seed and dyn_version strings

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
{
  • "dyn_seed": "MDGiEp/UqnYDIDYxhWhjwYS0nLQtHSMnUmAupKheSEjSexmBQzY6F1IpEk34cU3r3+4DIwTByxaZ80KCFfD2BlaRmmCUSOEDfcR+y0AX8XtnrsEJC+60pSsQNnvYu4LJZfI=",
  • "dyn_version": 8
}

Send ri/report

Send ri/report

Authorizations:
ApiKeyAuth
query Parameters
report_type
string
Default: "cold_start"

Report type, can be install, cold_start and autoReport

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
""

Decode MSSDK payload

This endpoint can decode mssdk requests and responses. You must provide only encrypted part from full protobuf request or response.

For example we got MSSDK request by mitmproxy: 08c4908082041002180422709e16d0f374e56b2a1c58c623e60698d0bd2789f75aea121c62500c9fd6053f99cf5d05e647037dc10c0f1cf4b198fe9846532be4716a5b3390963ba5ba521dd1a646b6ec6a7300d5e7897a8fe4c82c713204cfe8a461c80c868f1a3c198525a97b62f87768165236f8cba3a2f07ba8ec2892efb4f99762 We can use https://protobuf-decoder.netlify.app/ to decode protobuf message. After that, in decode endpoint we must to provide a value from 4 field (in our example case it will be 9e16d0f374e56b2a1c58c623e60698d0bd2789f75a...)

For example we got MSSDK response by mitmproxy: 08a48c9081041002280232408fa0f8cd7812e2be6547aa8e3a22627d68c25f4890859ce7988145f4bd896d812cef7b24faf8ab224c7991bba07077a5310de071209f1999f585830fa952d598 We can use https://protobuf-decoder.netlify.app/ to decode protobuf message. After that, in decode endpoint we must to provide a value from 6 field (in our example case it will be 8fa0f8cd7812e2be6547aa8e3a2262...)

Decode result is a protobuf message.

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

payload - encoded bytes as a hex string mode - can be full or raw. In the full mode endpoint will return final decode result. In the raw mode endpoint will return padded zip payload

payload
string
mode
string

Responses

Request samples

Content type
application/json
{
  • "payload": "string",
  • "mode": "string"
}

Response samples

Content type
application/json
"0a2063336132313333343861326334633933396430316532326530313062393837391213363930343031323737313636303639353034351a07616e64726f696422097630342e30342e3035"

Encode MSSDK payload

This endpoint can encode protobuf payloads for MSSDK requests.

For example we have a prepared protobuf message (0a96050a08216e6f74736574211205594159474f1a074154562d3130312208216e6f74736574212a07416e64726f6964320231313a083736382a313138344080054a22414c353138362d73656c656e652d6275696c642d3230323230383135313535363431508ef4cfaf0c5a05656e5f4742620f4575726f70652f4c6f6e646f6e2c316846704478fef7e3e23f800180c0c4b7a8078801c0fbfbecf6019001a6b786dbdf029a0108216e6f7473657421a20108216e6f7473657421aa011034376265653437333133633635613966b20108216e6f7473657421ba0108216e6f7473657421c2012c51784f62686e74734d62387a53546e4d57414e4d4d4d326545436879635a6b35597955644f306768752f673dc80186f8c1cf0cd2012430316632353666652d633962662d346134342d626464612d623139663835646666346536d8018080f8dbed16e20108216e6f7473657421e801fd887af001fd887afa0108216e6f747365742182020a313639343531313036318a020d3139322e3136382e312e313936920208216e6f74736574219a0208216e6f7473657421a002d403a80232b20208216e6f7473657421ba0208216e6f7473657421c202155b22382e382e382e38222c22312e312e312e31225dc802fd887ad002fd887ae20208216e6f7473657421e8029eb5f6cf0cf00286becccf0cfa025f2f646174612f6170702f7e7e383668683943554d5353317a7441356f6266684a74773d3d2f636f6d2e7a68696c69616f6170702e6d75736963616c6c792d74535334364277546a5659376c6d52507258776f5a673d3d2f626173652e61706b80033c8803fd887a920308216e6f74736574219803fd887aa003fd887aaa0308216e6f7473657421b20308216e6f7473657421ba0308216e6f7473657421c003fd887a1a07616e64726f6964221c7630342e30342e30302d616c7068612e322d6f762d616e64726f696428c080a0403204313233333a0632362e342e354213373237373438353131393236363134353832344a103030303030303030303030303030303058fd887a622438353262643562382d383732612d346338642d396531392d6663376133646262373530618001fd887a) for sdi/get_token endpoint and we want to encode it. We should provide this message as payload body field with sdi/get_token payload type. In response we will get a encrypted hex string, which we will put to MSSDK request.

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

Encoded bytes as a hex string

payload_type
string

Different MSSDK endpoints use a different paddings. Supported payload types:

  • sdi/get_token - get token payload
  • ri/report - report payload
  • ms/get_seed - seed payload
  • raw - use this one if you want to just encrypt without padding and zipping

Responses

Request samples

Content type
application/json
{
  • "payload": "string",
  • "payload_type": "string"
}

Response samples

Content type
application/json
"cc87ccd0a2aea8bcffb93983498f7a004dad5912fed4d1ef9777ea269ab708e206efd736c19df8f6684000d3bb74e3d31cb3fe512507014522988428692dbaaa3349e938b1b48572141ebe9c10cc8feecce1e88bf6f5239c3a03ef7bd17b43395e559f70071fd34a8959d1726eafcb9d56fd045040547b6bcf9038f26db0d2ddaa12b78bee5e40187fd44579901f9a37906041a12c0f8d2cf7d8884f94eede7f41e44d7a6b0a2b5a74c1c55fffdf528a5cdd6f0d1e9798a656bc7731584ab427048d27e61e4b2b0b87797997a9de40bfb8188c3a76affb5c9a2690029998dfe5b11a7e14c326226f11c50854a18c20e29f579e246c3a2025a60817c09490ca549afaaa87eef171796258b3098f01e96707a2c1d28a443e093947b9eb91e31f0eda1f0f42bf7d1642f44ea58c91014f194de877cd0230ea1129c3480aa37a9783ecccc5f628e375eabf891c990b2ef07b13fbf9497186a99ee2bae92c241e163ee790a0a12a756e843e1e8e3ae24c51e73e9276d6be593e5ca26e158acd32119052d10541df6d262e02d4c6cedb2f848c73e468d19f953a2536fdf10e4515a3065db48c30e3b39ab5c8a8756854ed5d6ef4e9723d39235c0c25e3021a08aa82ac256fce6c1ff6ff056013e950f5b3cfb7b466ed7f34acace49f719bf194a658b1d63b62c8d14ded40198ccc927bf1f421e2671a5e4e2eaa921bcad823f5eba331983b4229819b2d27959a9a3f9459664d535e01dde31865dcaf8f7ee0392a4c0bcbd6dd608e015ee55e5536880ca0ce189dbe29d841728980e87dcbbfbcb6f148f75513b722ea4949cfa97fd232adea50ff5322999021274df35216fbbf0c701f905ce8d22f555c9035fc5531a4f8756505508a8fd526a1a592091482ffe7a3d7aa63abff949a419cff9ee21d2a58fc1bb545850ac0082a9be3a78e9b7cab4395"

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
}

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

Responses

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"
}

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

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": ""
}

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": {
    }
}

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

Responses

Request samples

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

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
}

Captcha

Solve captcha

Solve captcha

Authorizations:
ApiKeyAuth
header Parameters
x-device
required
string

JSON string with device config from /v1/service/device/generate response

x-cookie
required
string

Cookie string from /v1/service/device/generate 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
captcha_config
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "result": true
}