tikapi - npm Package Compare versions

Comparing version 3.1.22 to 3.1.31

api.d.ts

@@ -537,2 +537,187 @@ /*!
 	/**
+	 * 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
+	
+
+	/**
+	 * 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 a user's 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
+	
+
+	/**
+	 * 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 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
+	
+
+	/**
+	 * 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 explore posts by category 
+	 */
+	exploreCategory: (params?: {
+	/**
+	 * The category ID.	
+	 * 
+	 * @example
+	 * 
+	 * `"1"`
+	 * 						 
+	 */
+	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
+	 * 					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 hashtag posts 
@@ -1088,2 +1273,133 @@ */
 	/**
+	 * 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 
@@ -1162,2 +1478,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> {
@@ -1352,2 +1806,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>;
+
 }
@@ -1453,3 +1998,3 @@
 	/**
-	 * The days time frame of analytics data	
+	 * The days time frame for the analytics data	
 	 * 
@@ -1481,3 +2026,3 @@ * @example
 	 */
-	following: (params?: {
+	followingV1: (params?: {
 	/**
@@ -1503,4 +2048,72 @@ * Maximum amount of items for one request
 	/**
-	 * Follow an user 
+	 * 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 a user 
+	 */
 	follow: (params?: {
@@ -1543,3 +2156,3 @@ /**
 	/**
-	 * Unfollows an user 
+	 * Unfollow a user 
 	 */
@@ -1691,2 +2304,7 @@ unfollow: (params?: {
 	 */
+	conversationRequests: APIUserConversationRequests
+
+	/**
+	 * The user endpoints require an `accountKey` 
+	 */
 	live: APIUserLive
@@ -1693,0 +2311,0 @@

api.js

@@ -310,2 +310,103 @@ /**
 		},
+		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 a user's 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: {
@@ -370,2 +471,4 @@ help: "Get hashtag posts",
 		},
+
+		
 		discover: {
@@ -547,3 +650,3 @@ help: "Discover users, music, hashtags",
 					fields:{
-						security: userSecurity(['view_profile']),
+						security: userSecurity(['view_notifications']),
 						tags: [
@@ -572,3 +675,3 @@ "Profile"
 					default: 7,
-					help: "The days time frame of analytics data",
+					help: "The days time frame for the analytics data",
 					validate: "^[0-9]+$",
@@ -614,6 +717,6 @@ type: "number"
 		},
-		following: {
+		followingV1: {
 			help: "Get following list",
 			comment: "Get current user's following list",
-			path: "/user/following",
+			path: "/user/following/v1",
 			params: {
@@ -628,2 +731,3 @@ count: p.count,
 				openapi: {
+					hide: true,
 					fields:{
@@ -633,3 +737,3 @@ tags: [
 						],
-						security: userSecurity(['view_profile']),
+						security: userSecurity(['view_followers']),
 					},
@@ -639,4 +743,52 @@ }
 		},
+		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: {
-			help: "Follow an user",
+			help: "Follow a user",
 			comment: specialBadge + `<br>This endpoint is deprecated and might not work as excpeted.`,
@@ -664,2 +816,3 @@ path: "/user/follow",
 				openapi: {
+					hide: true,
 					fields:{
@@ -676,3 +829,3 @@ deprecated: true,
 		unfollow: {
-			help: "Unfollows an user",
+			help: "Unfollow a user",
 			comment: specialBadge + `<br>This endpoint is deprecated and might not work as excpeted.`,
@@ -700,2 +853,3 @@ path: "/user/unfollow",
 				openapi: {
+					hide: true,
 					fields:{
@@ -759,2 +913,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: {
@@ -1067,2 +1321,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: {
@@ -1216,7 +1578,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
+						},
+					}
+				}
+			},
 		},		
@@ -1223,0 +1666,0 @@ },

dist/index.d.ts

@@ -524,2 +524,187 @@ interface FormData {
 	/**
+	 * 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
+	
+
+	/**
+	 * 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 a user's 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
+	
+
+	/**
+	 * 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 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
+	
+
+	/**
+	 * 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 explore posts by category 
+	 */
+	exploreCategory: (params?: {
+	/**
+	 * The category ID.	
+	 * 
+	 * @example
+	 * 
+	 * `"1"`
+	 * 						 
+	 */
+	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
+	 * 					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 hashtag posts 
@@ -1075,2 +1260,133 @@ */
 	/**
+	 * 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 
@@ -1149,2 +1465,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> {
@@ -1339,2 +1793,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>;
+
 }
@@ -1440,3 +1985,3 @@
 	/**
-	 * The days time frame of analytics data	
+	 * The days time frame for the analytics data	
 	 * 
@@ -1468,3 +2013,3 @@ * @example
 	 */
-	following: (params?: {
+	followingV1: (params?: {
 	/**
@@ -1490,4 +2035,72 @@ * Maximum amount of items for one request
 	/**
-	 * Follow an user 
+	 * 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 a user 
+	 */
 	follow: (params?: {
@@ -1530,3 +2143,3 @@ /**
 	/**
-	 * Unfollows an user 
+	 * Unfollow a user 
 	 */
@@ -1678,2 +2291,7 @@ unfollow: (params?: {
 	 */
+	conversationRequests: APIUserConversationRequests
+
+	/**
+	 * The user endpoints require an `accountKey` 
+	 */
 	live: APIUserLive
@@ -1680,0 +2298,0 @@

package.json

 {
   "name": "tikapi",
-  "version": "3.1.22",
+  "version": "3.1.31",
   "description": "A fully managed unofficial TikTok API with OAuth capabilities",
@@ -5,0 +5,0 @@ "main": "./dist/index.cjs",

No alert changes

Improved metrics

Total package byte prevSize

196951

increased by30.01%

Lines of code

7576

increased by32.31%

No dependency changes