New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

tikapi

Package Overview
Dependencies
Maintainers
1
Versions
32
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

tikapi - npm Package Compare versions

Comparing version 3.1.2 to 3.1.3

848

api.d.ts

@@ -249,2 +249,8 @@ /*!

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -254,6 +260,17 @@

/**
* Get trending posts
* Get a user's feed posts
*/
explore: (params?: {
posts: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request

@@ -270,5 +287,5 @@ *

/**
* Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
session_id?: number
cursor?: string

@@ -287,2 +304,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -292,5 +315,5 @@

/**
* Get a user's feed posts
* Get a user's liked posts
*/
posts: (params?: {
likes: (params?: {
/**

@@ -335,2 +358,8 @@ * The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -340,5 +369,5 @@

/**
* Get a user's liked posts
* Get a user's followers list
*/
likes: (params?: {
followersList: (params?: {
/**

@@ -367,5 +396,5 @@ * The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.

/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
*/
cursor?: string
nextCursor?: string

@@ -384,2 +413,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -389,2 +424,89 @@

/**
* Get a user's following list
*/
followingList: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
*/
nextCursor?: string
/**
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `"us"`
*
*/
country?: string
/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get trending posts
*/
explore: (params?: {
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `"us"`
*
*/
country?: string
/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get video information

@@ -415,2 +537,8 @@ */

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -420,23 +548,52 @@

/**
* Get hashtag posts
* Get related posts
*/
hashtag: (params?: {
relatedPosts: (params?: {
/**
* The hashtag ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
* The video ID from which to get related posts. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"4655293"`
* `"7109178205151464746"`
*
*/
id?: string
video_id?: string
/**
* The hashtag name
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `"us"`
*
*/
name?: string
country?: string
/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get an user playlists
*/
playlists: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request

@@ -469,2 +626,8 @@ *

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -474,14 +637,14 @@

/**
* Get music posts
* Get a playlist items
*/
music: (params?: {
playlistItems: (params?: {
/**
* The music ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
* The playlist ID.
*
* @example
*
* `"28459463"`
* `"6948562344666532614"`
*
*/
id?: string
playlist_id?: any

@@ -517,2 +680,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -522,17 +691,28 @@

/**
* Get music information
* Get explore posts by category
*/
musicInfo: (params?: {
exploreCategory: (params?: {
/**
* The music ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
* The category ID.
*
* @example
*
* `"28459463"`
* `"1"`
*
*/
id?: string
category_id?: any
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* You can optionally choose the proxy country from where the request

@@ -548,2 +728,8 @@ * is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -553,17 +739,23 @@

/**
* Discover users, music, hashtags
* Get hashtag posts
*/
discover: (params?: {
hashtag: (params?: {
/**
* The discover category
* The hashtag ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"users"`
* `"4655293"`
*
*/
category?: string
id?: string
/**
* The hashtag name
*/
name?: string
/**
* Maximum amount of items for one request

@@ -580,5 +772,5 @@ *

/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
offset?: number
cursor?: string

@@ -597,2 +789,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -602,66 +800,66 @@

/**
* Discover by keyword
* Get music posts
*/
discoverKeyword: (params?: {
music: (params?: {
/**
*
* The music ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"lilyachty"`
* `"28459463"`
*
*/
keyword?: string
id?: string
/**
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
* Maximum amount of items for one request
*
* @example
*
* `"us"`
* `30`
*
*/
country?: string
count?: number
} | FormData) => Promise<ResponseObject>;
/**
* Search
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
search: (params?: {
/**
* The search category
*
* @example
*
* `"general"`
*
*/
category?: string
cursor?: string
/**
* The search keyword
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `"lilyachty"`
* `"us"`
*
*/
query?: string
country?: string
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
cursor?: number
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* The cookies and IP are preserved through different requests for a longer amount of time. You should use this if you want to keep the search suggestions the same.
* Get music information
*/
session_id?: number
musicInfo: (params?: {
/**
* The music ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"28459463"`
*
*/
id?: string

@@ -680,2 +878,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -685,14 +889,14 @@

/**
* Get followers list
* Discover users, music, hashtags
*/
followersList: (params?: {
discover: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
* The discover category
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
* `"users"`
*
*/
secUid?: string
category?: string

@@ -712,5 +916,5 @@

/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
nextCursor?: string
offset?: number

@@ -729,2 +933,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -734,34 +944,75 @@

/**
* Get following list
* Discover by keyword
*/
followingList: (params?: {
discoverKeyword: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
* `"lilyachty"`
*
*/
secUid?: string
keyword?: string
/**
* Maximum amount of items for one request
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `30`
* `"us"`
*
*/
count?: number
country?: string
/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
nextCursor?: string
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* Search
*/
search: (params?: {
/**
* The search category
*
* @example
*
* `"general"`
*
*/
category?: string
/**
* The search keyword
*
* @example
*
* `"lilyachty"`
*
*/
query?: string
/**
* The cookies and IP are preserved through different requests for a longer amount of time. You should use this if you want to keep the search suggestions the same.
*/
session_id?: number
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: number
/**
* You can optionally choose the proxy country from where the request

@@ -1047,2 +1298,133 @@ * is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported

/**
* Get following posts
*/
followingPosts: (params?: {
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get related posts
*/
relatedPosts: (params?: {
/**
* The video ID from which to get related posts. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"7109178205151464746"`
*
*/
video_id?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get saved posts
*/
savedPosts: (params?: {
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get user playlists
*/
playlists: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get a playlist items
*/
playlistItems: (params?: {
/**
* The playlist ID.
*
* @example
*
* `"6948562344666532614"`
*
*/
playlist_id?: any
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get trending posts

@@ -1121,2 +1503,140 @@ */

export interface APIUserConversationRequests extends newCategory<APIUserConversationRequests> {
/**
* Get user conversation requests
*/
conversations: (params?: {
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
nextCursor?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get a conversation request messages
*/
messages: (params?: {
/**
* The conversation ID
*
* @example
*
* `"0:1:684574219823284956:69402435203845897564"`
*
*/
conversation_id?: any
/**
* The additional conversation short ID
*
* @example
*
* `"6940245147502654884"`
*
*/
conversation_short_id?: any
} | FormData) => Promise<ResponseObject>;
/**
* Mark a requests conversation as read
*/
markRead: (params?: {
/**
* The conversation ID
*
* @example
*
* `"0:1:684574219823284956:69402435203845897564"`
*
*/
conversation_id?: any
/**
* The additional conversation short ID
*
* @example
*
* `"6940245147502654884"`
*
*/
conversation_short_id?: any
} | FormData) => Promise<ResponseObject>;
/**
* Delete a conversation request
*/
delete: (params?: {
/**
* The conversation ID
*
* @example
*
* `"0:1:684574219823284956:69402435203845897564"`
*
*/
conversation_id?: any
/**
* The additional conversation short ID
*
* @example
*
* `"6940245147502654884"`
*
*/
conversation_short_id?: any
} | FormData) => Promise<ResponseObject>;
/**
* Accept a conversation request
*/
accept: (params?: {
/**
* The conversation ID
*
* @example
*
* `"0:1:684574219823284956:69402435203845897564"`
*
*/
conversation_id?: any
/**
* The additional conversation short ID
*
* @example
*
* `"6940245147502654884"`
*
*/
conversation_short_id?: any
/**
* The sender ID.
*
* @example
*
* `"6569595380449902597"`
*
*/
user_id?: string
} | FormData) => Promise<ResponseObject>;
}
export interface APIUserLive extends newCategory<APIUserLive> {

@@ -1311,2 +1831,93 @@

/**
* Search live videos
*/
search: (params?: {
/**
* The search keyword
*
* @example
*
* `"lilyachty"`
*
*/
query?: string
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get live analytics
*/
analytics: (params?: {
/**
* The days time frame for the analytics data
*
* @example
*
* `7`
*
*/
days?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get live videos list
*/
list: (params?: {
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
offset?: number
/**
* Sort results by ascending (1) or descending (0). Default is descending (0).
*
* @example
*
* `1`
*
*/
sort?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get a live video details
*/
details: (params?: {
/**
* The Live room ID.
*
* @example
*
* `"7112492061034646278"`
*
*/
room_id?: string
} | FormData) => Promise<ResponseObject>;
}

@@ -1412,3 +2023,3 @@

/**
* The days time frame of analytics data
* The days time frame for the analytics data
*

@@ -1440,3 +2051,3 @@ * @example

*/
following: (params?: {
followingV1: (params?: {
/**

@@ -1462,2 +2073,70 @@ * Maximum amount of items for one request

/**
* Get following list
*/
following: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
*/
nextCursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get followers list
*/
followers: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
*/
nextCursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Follow an user

@@ -1649,2 +2328,7 @@ */

*/
conversationRequests: APIUserConversationRequests
/**
* The user endpoints require an `accountKey`
*/
live: APIUserLive

@@ -1651,0 +2335,0 @@

@@ -159,2 +159,8 @@ /**

example: "us"
},
session_id:{
type: "number",
max: 100,
example: 0,
help: "(Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request."
}

@@ -188,3 +194,3 @@ },

openapi:{
hideParams: ['user_id'],
hideParams: ['user_id', 'session_id'],
showExamplesInCode: ['username']

@@ -194,21 +200,2 @@ }

},
explore: {
help: "Get trending posts",
comment: "Get a list of recommended posts from the *For You* section. <br/>" + videoLink,
path: "/public/explore",
params: {
count: p.count,
session_id:{
type: "number",
max: 20,
example: 0,
help: "Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request."
}
},
$other:{
openapi: {
...exploreCodeSamples()
}
}
},
posts: {

@@ -229,3 +216,4 @@ help: "Get a user's feed posts",

openapi: {
...iterationCodeSamples('cursor')
...iterationCodeSamples('cursor'),
hideParams: ['session_id']
}

@@ -249,6 +237,62 @@ }

openapi: {
...iterationCodeSamples('cursor')
...iterationCodeSamples('cursor'),
hideParams: ['session_id']
}
}
},
followersList:{
help: "Get a user's followers list",
comment: "Get followers list of any public profile.",
path: "/public/followers",
params: {
secUid: {
...p.secUid,
required: true,
example: exampleSecUid
},
count: p.count,
nextCursor: p.nextCursor
},
$other:{
openapi: {
...iterationCodeSamples('nextCursor'),
hideParams: ['session_id']
}
}
},
followingList:{
help: "Get a user's following list",
comment: "Get following list of any public profile.",
path: "/public/following",
params: {
secUid: {
...p.secUid,
required: true,
example: exampleSecUid
},
count: p.count,
nextCursor: p.nextCursor
},
$other:{
openapi: {
...iterationCodeSamples('nextCursor'),
hideParams: ['session_id']
}
}
},
explore: {
help: "Get trending posts",
comment: "Get a list of recommended posts from the *For You* section. <br/>" + videoLink,
path: "/public/explore",
params: {
count: p.count,
},
$other:{
openapi: {
...exploreCodeSamples(),
hideParams: ['session_id']
}
}
},
video: {

@@ -264,4 +308,110 @@ path: "/public/video",

}
},
$other:{
openapi: {
hideParams: ['session_id']
}
}
},
relatedPosts: {
path: "/public/related_posts",
help: "Get related posts",
comment: videoLink,
params: {
video_id: {
...p.videoId,
help: "The video ID from which to get related posts. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)",
required: true,
example: exampleVideoId
}
},
$other:{
openapi: {
hideParams: ['session_id'],
fields: {
'x-new': true
}
}
}
},
playlists: {
path: "/public/playlists",
help: "Get an user playlists",
params: {
secUid: {
...p.secUid,
required: true,
example: exampleSecUid
},
count: p.count,
cursor: p.cursor,
},
$other:{
openapi: {
...iterationCodeSamples('cursor'),
hideParams: ['session_id'],
fields: {
'x-new': true
}
}
}
},
playlistItems: {
path: "/public/playlist/items",
help: "Get a playlist items",
params: {
playlist_id: {
validate: "^[0-9]+$",
required: true,
example: "6948562344666532614",
help: "The playlist ID."
},
count: p.count,
cursor: p.cursor,
},
$other:{
openapi: {
...iterationCodeSamples('cursor'),
hideParams: ['session_id'],
fields: {
'x-new': true
}
}
}
},
exploreCategory: {
path: "/public/explore/category",
help: "Get explore posts by category",
comment: `The following categories are supported:<br/><br/>
"Comedy & Drama": 1,<br/>
"Dance & Music": 2,<br/>
"Relationships": 3,<br/>
"Nature & Pets": 4,<br/>
"Lifestyle": 5,<br/>
"Society": 6,<br/>
"Fashion": 7,<br/>
"Entertainment": 8,<br/>
"Informative": 10,<br/>
"Sports & Outdoors": 11,<br/>
"Auto & Vehicle": 12,`,
params: {
category_id: {
validate: "^[0-9]+$",
required: true,
example: "1",
help: "The category ID."
},
count: p.count,
},
$other:{
openapi: {
...iterationCodeSamples('cursor'),
hide: true,
fields: {
'x-new': true,
'x-beta': true,
}
}
}
},
hashtag: {

@@ -285,3 +435,4 @@ help: "Get hashtag posts",

openapi: {
...hashtagCodeSamples('cursor')
...hashtagCodeSamples('cursor'),
hideParams: ['session_id']
}

@@ -305,3 +456,4 @@ }

openapi: {
...iterationCodeSamples('cursor')
...iterationCodeSamples('cursor'),
hideParams: ['session_id']
}

@@ -319,4 +471,11 @@ }

}
},
$other:{
openapi: {
hideParams: ['session_id']
}
}
},
discover: {

@@ -340,3 +499,4 @@ help: "Discover users, music, hashtags",

openapi:{
...iterationCodeSamples('offset')
...iterationCodeSamples('offset'),
hideParams: ['session_id']
}

@@ -355,2 +515,7 @@ }

},
},
$other:{
openapi:{
hideParams: ['session_id']
}
}

@@ -380,3 +545,3 @@ },

type: "number",
max: 20,
max: 100,
example: 0,

@@ -388,43 +553,6 @@ help: "The cookies and IP are preserved through different requests for a longer amount of time. You should use this if you want to keep the search suggestions the same."

openapi:{
...iterationCodeSamples('cursor')
...iterationCodeSamples('cursor'),
hideParams: ['session_id']
}
}
},
followersList:{
help: "Get followers list",
comment: "Get followers list of any public profile.",
path: "/public/followers",
params: {
secUid: {
...p.secUid,
required: true,
example: exampleSecUid
},
count: p.count,
nextCursor: p.nextCursor
},
$other:{
openapi: {
...iterationCodeSamples('nextCursor')
}
}
},
followingList:{
help: "Get following list",
comment: "Get following list of any public profile.",
path: "/public/following",
params: {
secUid: {
...p.secUid,
required: true,
example: exampleSecUid
},
count: p.count,
nextCursor: p.nextCursor
},
$other:{
openapi: {
...iterationCodeSamples('nextCursor')
}
}
}

@@ -533,3 +661,3 @@ },

fields:{
security: userSecurity(['view_profile']),
security: userSecurity(['view_notifications']),
tags: [

@@ -558,3 +686,3 @@ "Profile"

default: 7,
help: "The days time frame of analytics data",
help: "The days time frame for the analytics data",
validate: "^[0-9]+$",

@@ -600,6 +728,6 @@ type: "number"

},
following: {
followingV1: {
help: "Get following list",
comment: "Get current user's following list",
path: "/user/following",
path: "/user/following/v1",
params: {

@@ -614,2 +742,3 @@ count: p.count,

openapi: {
hide: true,
fields:{

@@ -619,3 +748,3 @@ tags: [

],
security: userSecurity(['view_profile']),
security: userSecurity(['view_followers']),
},

@@ -625,2 +754,50 @@ }

},
following:{
help: "Get following list",
comment: "Get current user following list (or a friends by specifying the secUid).",
path: "/user/following",
params: {
secUid: {
...p.secUid,
example: exampleSecUid
},
count: p.count,
nextCursor: p.nextCursor
},
$other:{
openapi: {
...iterationCodeSamples('nextCursor'),
fields:{
tags: [
"Followers"
],
security: userSecurity(['view_followers']),
},
}
}
},
followers:{
help: "Get followers list",
comment: "Get current user followers list (or a friends by specifying the secUid).",
path: "/user/followers",
params: {
secUid: {
...p.secUid,
example: exampleSecUid
},
count: p.count,
nextCursor: p.nextCursor
},
$other:{
openapi: {
...iterationCodeSamples('nextCursor'),
fields:{
tags: [
"Followers"
],
security: userSecurity(['view_followers']),
},
}
}
},
follow: {

@@ -650,2 +827,3 @@ help: "Follow an user",

openapi: {
hide: true,
fields:{

@@ -685,2 +863,3 @@ deprecated: true,

openapi: {
hide: true,
fields:{

@@ -744,2 +923,102 @@ deprecated: true,

},
followingPosts: {
path: "/user/following_posts",
help: "Get following posts",
comment: videoLink,
params: {
count: p.count,
cursor: p.cursor,
},
$other:{
openapi: {
fields: {
'x-new': true,
security: userSecurity(['explore'])
}
}
}
},
relatedPosts: {
path: "/user/related_posts",
help: "Get related posts",
comment: videoLink,
params: {
video_id: {
...p.videoId,
help: "The video ID from which to get related posts. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)",
required: true,
example: exampleVideoId
}
},
$other:{
openapi: {
fields: {
'x-new': true,
security: userSecurity(['explore'])
}
}
}
},
savedPosts: {
path: "/user/saved",
help: "Get saved posts",
comment: videoLink,
params: {
count: p.count,
cursor: p.cursor,
},
$other:{
openapi: {
fields: {
'x-new': true,
security: userSecurity(['view_collections'])
}
}
}
},
playlists: {
path: "/user/playlists",
help: "Get user playlists",
params: {
secUid: {
...p.secUid,
required: false,
example: exampleSecUid
},
count: p.count,
cursor: p.cursor,
},
$other:{
openapi: {
...iterationCodeSamples('cursor'),
fields: {
'x-new': true,
security: userSecurity(['view_collections'])
}
}
}
},
playlistItems: {
path: "/user/playlist/items",
help: "Get a playlist items",
params: {
playlist_id: {
validate: "^[0-9]+$",
required: true,
example: "6948562344666532614",
help: "The playlist ID."
},
count: p.count,
cursor: p.cursor,
},
$other:{
openapi: {
...iterationCodeSamples('cursor'),
fields: {
'x-new': true,
security: userSecurity(['view_collections'])
}
}
}
},
explore: {

@@ -1052,2 +1331,110 @@ help: "Get trending posts",

},
conversationRequests: {
$options:{
$other:{
openapi: {
fields:{
tags: [
"Messages"
],
security: userSecurity(['conversation_requests']),
'x-new': true,
},
}
}
},
conversations: {
path: '/user/conversations/requests',
help: "Get user conversation requests",
comment: premiumBadge + "Get a list of current user conversations requests including the latest message.",
params: {
nextCursor: p.offset
},
$other:{
openapi: {
...iterationCodeSamples('nextCursor'),
}
}
},
messages: {
path: '/user/messages/requests',
help: "Get a conversation request messages",
comment: premiumBadge + "Get the messages of a conversation in the requests tab (generally there is a 3 message limit).",
params: {
conversation_id: {
help: "The conversation ID",
required: true,
example: "0:1:684574219823284956:69402435203845897564"
},
conversation_short_id: {
help: "The additional conversation short ID",
required: true,
example: "6940245147502654884"
}
}
},
markRead: {
path: '/user/conversations/requests/mark_read',
help: "Mark a requests conversation as read",
comment: premiumBadge,
params: {
conversation_id: {
help: "The conversation ID",
required: true,
example: "0:1:684574219823284956:69402435203845897564"
},
conversation_short_id: {
help: "The additional conversation short ID",
required: true,
example: "6940245147502654884"
}
},
$other:{
openapi: {
hide: true
}
}
},
delete: {
path: '/user/conversations/requests/delete',
help: "Delete a conversation request",
comment: premiumBadge,
params: {
conversation_id: {
help: "The conversation ID",
required: true,
example: "0:1:684574219823284956:69402435203845897564"
},
conversation_short_id: {
help: "The additional conversation short ID",
required: true,
example: "6940245147502654884"
}
}
},
accept: {
path: '/user/conversations/requests/accept',
help: "Accept a conversation request",
comment: premiumBadge,
params: {
conversation_id: {
help: "The conversation ID",
required: true,
example: "0:1:684574219823284956:69402435203845897564"
},
conversation_short_id: {
help: "The additional conversation short ID",
required: true,
example: "6940245147502654884"
},
user_id: {
...p.user_id,
help: "The sender ID.",
required: true,
example: "6569595380449902597"
}
}
},
},
live: {

@@ -1201,7 +1588,88 @@ $options:{

fields:{
security: userSecurity(['view_profile']),
security: userSecurity(['view_coins']),
},
}
}
}
},
search:{
help: "Search live videos",
path: "/user/search/live",
params:{
query:{
type: 'string',
example: "lilyachty",
required: true,
help: 'The search keyword'
},
cursor: p.offset,
},
$other:{
openapi:{
fields:{
...iterationCodeSamples('cursor'),
'x-new': true
},
}
}
},
analytics:{
help: "Get live analytics",
path: "/user/live/analytics",
params:{
days:{
default: 7,
help: "The days time frame for the analytics data",
validate: "^[0-9]+$",
type: "number"
},
},
$other:{
openapi:{
fields:{
'x-new': true,
security: userSecurity(['view_analytics']),
},
}
}
},
list:{
help: "Get live videos list",
path: "/user/live/list",
params:{
count: p.count,
offset: p.offset,
sort: {
help: "Sort results by ascending (1) or descending (0). Default is descending (0).",
in: [0, 1],
default: 0,
type: "number",
example: 1
}
},
$other:{
openapi:{
fields:{
'x-new': true
},
}
}
},
details:{
help: "Get a live video details",
path: "/user/live/detail",
params:{
room_id: {
...p.roomId,
help: "The Live room ID.",
required: true
}
},
$other:{
openapi:{
fields:{
'x-new': true
},
}
}
},
},

@@ -1208,0 +1676,0 @@ },

@@ -236,2 +236,8 @@ interface FormData {

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -241,6 +247,17 @@

/**
* Get trending posts
* Get a user's feed posts
*/
explore: (params?: {
posts: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request

@@ -257,5 +274,5 @@ *

/**
* Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
session_id?: number
cursor?: string

@@ -274,2 +291,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -279,5 +302,5 @@

/**
* Get a user's feed posts
* Get a user's liked posts
*/
posts: (params?: {
likes: (params?: {
/**

@@ -322,2 +345,8 @@ * The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -327,5 +356,5 @@

/**
* Get a user's liked posts
* Get a user's followers list
*/
likes: (params?: {
followersList: (params?: {
/**

@@ -354,5 +383,5 @@ * The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.

/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
*/
cursor?: string
nextCursor?: string

@@ -371,2 +400,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -376,2 +411,89 @@

/**
* Get a user's following list
*/
followingList: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
*/
nextCursor?: string
/**
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `"us"`
*
*/
country?: string
/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get trending posts
*/
explore: (params?: {
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `"us"`
*
*/
country?: string
/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get video information

@@ -402,2 +524,8 @@ */

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -407,23 +535,52 @@

/**
* Get hashtag posts
* Get related posts
*/
hashtag: (params?: {
relatedPosts: (params?: {
/**
* The hashtag ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
* The video ID from which to get related posts. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"4655293"`
* `"7109178205151464746"`
*
*/
id?: string
video_id?: string
/**
* The hashtag name
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `"us"`
*
*/
name?: string
country?: string
/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get an user playlists
*/
playlists: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request

@@ -456,2 +613,8 @@ *

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -461,14 +624,14 @@

/**
* Get music posts
* Get a playlist items
*/
music: (params?: {
playlistItems: (params?: {
/**
* The music ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
* The playlist ID.
*
* @example
*
* `"28459463"`
* `"6948562344666532614"`
*
*/
id?: string
playlist_id?: any

@@ -504,2 +667,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -509,17 +678,28 @@

/**
* Get music information
* Get explore posts by category
*/
musicInfo: (params?: {
exploreCategory: (params?: {
/**
* The music ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
* The category ID.
*
* @example
*
* `"28459463"`
* `"1"`
*
*/
id?: string
category_id?: any
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* You can optionally choose the proxy country from where the request

@@ -535,2 +715,8 @@ * is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -540,17 +726,23 @@

/**
* Discover users, music, hashtags
* Get hashtag posts
*/
discover: (params?: {
hashtag: (params?: {
/**
* The discover category
* The hashtag ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"users"`
* `"4655293"`
*
*/
category?: string
id?: string
/**
* The hashtag name
*/
name?: string
/**
* Maximum amount of items for one request

@@ -567,5 +759,5 @@ *

/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
offset?: number
cursor?: string

@@ -584,2 +776,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -589,66 +787,66 @@

/**
* Discover by keyword
* Get music posts
*/
discoverKeyword: (params?: {
music: (params?: {
/**
*
* The music ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"lilyachty"`
* `"28459463"`
*
*/
keyword?: string
id?: string
/**
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
* Maximum amount of items for one request
*
* @example
*
* `"us"`
* `30`
*
*/
country?: string
count?: number
} | FormData) => Promise<ResponseObject>;
/**
* Search
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
search: (params?: {
/**
* The search category
*
* @example
*
* `"general"`
*
*/
category?: string
cursor?: string
/**
* The search keyword
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `"lilyachty"`
* `"us"`
*
*/
query?: string
country?: string
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
cursor?: number
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* The cookies and IP are preserved through different requests for a longer amount of time. You should use this if you want to keep the search suggestions the same.
* Get music information
*/
session_id?: number
musicInfo: (params?: {
/**
* The music ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"28459463"`
*
*/
id?: string

@@ -667,2 +865,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -672,14 +876,14 @@

/**
* Get followers list
* Discover users, music, hashtags
*/
followersList: (params?: {
discover: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
* The discover category
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
* `"users"`
*
*/
secUid?: string
category?: string

@@ -699,5 +903,5 @@

/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
nextCursor?: string
offset?: number

@@ -716,2 +920,8 @@

/**
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
session_id?: number
} | FormData) => Promise<ResponseObject>;

@@ -721,34 +931,75 @@

/**
* Get following list
* Discover by keyword
*/
followingList: (params?: {
discoverKeyword: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
* `"lilyachty"`
*
*/
secUid?: string
keyword?: string
/**
* Maximum amount of items for one request
* You can optionally choose the proxy country from where the request
* is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported
*
* @example
*
* `30`
* `"us"`
*
*/
count?: number
country?: string
/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
* (Optional) Longer sessions. The cookies and IP are preserved through different requests for a longer amount of time. You should include this in order to get different posts on every request.
*/
nextCursor?: string
session_id?: number
} | FormData) => Promise<ResponseObject>;
/**
* Search
*/
search: (params?: {
/**
* The search category
*
* @example
*
* `"general"`
*
*/
category?: string
/**
* The search keyword
*
* @example
*
* `"lilyachty"`
*
*/
query?: string
/**
* The cookies and IP are preserved through different requests for a longer amount of time. You should use this if you want to keep the search suggestions the same.
*/
session_id?: number
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: number
/**
* You can optionally choose the proxy country from where the request

@@ -1034,2 +1285,133 @@ * is being sent by providing an ISO Code (e.g us, ca, gb) — 200+ countries supported

/**
* Get following posts
*/
followingPosts: (params?: {
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get related posts
*/
relatedPosts: (params?: {
/**
* The video ID from which to get related posts. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU)
*
* @example
*
* `"7109178205151464746"`
*
*/
video_id?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get saved posts
*/
savedPosts: (params?: {
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get user playlists
*/
playlists: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get a playlist items
*/
playlistItems: (params?: {
/**
* The playlist ID.
*
* @example
*
* `"6948562344666532614"`
*
*/
playlist_id?: any
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting point of the items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get trending posts

@@ -1108,2 +1490,140 @@ */

interface APIUserConversationRequests extends newCategory<APIUserConversationRequests> {
/**
* Get user conversation requests
*/
conversations: (params?: {
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
nextCursor?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get a conversation request messages
*/
messages: (params?: {
/**
* The conversation ID
*
* @example
*
* `"0:1:684574219823284956:69402435203845897564"`
*
*/
conversation_id?: any
/**
* The additional conversation short ID
*
* @example
*
* `"6940245147502654884"`
*
*/
conversation_short_id?: any
} | FormData) => Promise<ResponseObject>;
/**
* Mark a requests conversation as read
*/
markRead: (params?: {
/**
* The conversation ID
*
* @example
*
* `"0:1:684574219823284956:69402435203845897564"`
*
*/
conversation_id?: any
/**
* The additional conversation short ID
*
* @example
*
* `"6940245147502654884"`
*
*/
conversation_short_id?: any
} | FormData) => Promise<ResponseObject>;
/**
* Delete a conversation request
*/
delete: (params?: {
/**
* The conversation ID
*
* @example
*
* `"0:1:684574219823284956:69402435203845897564"`
*
*/
conversation_id?: any
/**
* The additional conversation short ID
*
* @example
*
* `"6940245147502654884"`
*
*/
conversation_short_id?: any
} | FormData) => Promise<ResponseObject>;
/**
* Accept a conversation request
*/
accept: (params?: {
/**
* The conversation ID
*
* @example
*
* `"0:1:684574219823284956:69402435203845897564"`
*
*/
conversation_id?: any
/**
* The additional conversation short ID
*
* @example
*
* `"6940245147502654884"`
*
*/
conversation_short_id?: any
/**
* The sender ID.
*
* @example
*
* `"6569595380449902597"`
*
*/
user_id?: string
} | FormData) => Promise<ResponseObject>;
}
interface APIUserLive extends newCategory<APIUserLive> {

@@ -1298,2 +1818,93 @@

/**
* Search live videos
*/
search: (params?: {
/**
* The search keyword
*
* @example
*
* `"lilyachty"`
*
*/
query?: string
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
cursor?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get live analytics
*/
analytics: (params?: {
/**
* The days time frame for the analytics data
*
* @example
*
* `7`
*
*/
days?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get live videos list
*/
list: (params?: {
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* The starting offset of items list. Returned in every response, should be included in the next request for iteration.<br><br> *(A simple iteration method is already implemented in the Javascript & Python libraries as seen in the request samples)*
*/
offset?: number
/**
* Sort results by ascending (1) or descending (0). Default is descending (0).
*
* @example
*
* `1`
*
*/
sort?: number
} | FormData) => Promise<ResponseObject>;
/**
* Get a live video details
*/
details: (params?: {
/**
* The Live room ID.
*
* @example
*
* `"7112492061034646278"`
*
*/
room_id?: string
} | FormData) => Promise<ResponseObject>;
}

@@ -1399,3 +2010,3 @@

/**
* The days time frame of analytics data
* The days time frame for the analytics data
*

@@ -1427,3 +2038,3 @@ * @example

*/
following: (params?: {
followingV1: (params?: {
/**

@@ -1449,2 +2060,70 @@ * Maximum amount of items for one request

/**
* Get following list
*/
following: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
*/
nextCursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Get followers list
*/
followers: (params?: {
/**
* The TikTok user secUid. You can get this from the <a href='#tag/Public/operation/public.check'>Get profile information</a> endpoint using the username.
*
* @example
*
* `"MS4wLjABAAAAsHntXC3s0AvxcecggxsoVa4eAiT8OVafVZ4OQXxy-9htpnUi0sOYSr0kGGD1Loud"`
*
*/
secUid?: string
/**
* Maximum amount of items for one request
*
* @example
*
* `30`
*
*/
count?: number
/**
* A iteration parameter returned in each response, should be included in the next requests to get the next items.
*/
nextCursor?: string
} | FormData) => Promise<ResponseObject>;
/**
* Follow an user

@@ -1636,2 +2315,7 @@ */

*/
conversationRequests: APIUserConversationRequests
/**
* The user endpoints require an `accountKey`
*/
live: APIUserLive

@@ -1638,0 +2322,0 @@

4

package.json
{
"name": "tikapi",
"version": "3.1.2",
"description": "A fully managed unofficial TikTok app with OAuth capabilities",
"version": "3.1.3",
"description": "A fully managed unofficial TikTok API with OAuth capabilities",
"main": "./dist/index.cjs",

@@ -6,0 +6,0 @@ "module": "./index.js",

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc