Comparing version 3.1.41 to 3.2.0
161
api.d.ts
@@ -397,3 +397,3 @@ /*! | ||
*/ | ||
nextCursor?: string | ||
nextCursor?: number | ||
@@ -450,3 +450,3 @@ | ||
*/ | ||
nextCursor?: string | ||
nextCursor?: number | ||
@@ -518,3 +518,3 @@ | ||
* | ||
* `"7109178205151464746"` | ||
* `"7003402629929913605"` | ||
* | ||
@@ -865,2 +865,117 @@ */ | ||
/** | ||
* Get a video comments list | ||
*/ | ||
commentsList: (params?: { | ||
/** | ||
* The video ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU) | ||
* | ||
* @example | ||
* | ||
* `"7109178205151464746"` | ||
* | ||
*/ | ||
media_id?: 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?: 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 a comment replies list | ||
*/ | ||
commentRepliesList: (params?: { | ||
/** | ||
* The video ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU) | ||
* | ||
* @example | ||
* | ||
* `"7109178205151464746"` | ||
* | ||
*/ | ||
media_id?: string | ||
/** | ||
* The comment ID | ||
* | ||
* @example | ||
* | ||
* `"7109185042560680750"` | ||
* | ||
*/ | ||
comment_id?: 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?: 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 music posts | ||
@@ -1512,2 +1627,36 @@ */ | ||
/** | ||
* Search | ||
*/ | ||
search: (params?: { | ||
/** | ||
* The search category | ||
* | ||
* @example | ||
* | ||
* `"general"` | ||
* | ||
*/ | ||
category?: string | ||
/** | ||
* The search keyword | ||
* | ||
* @example | ||
* | ||
* `"lilyachty"` | ||
* | ||
*/ | ||
query?: string | ||
/** | ||
* 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 video information | ||
@@ -1521,3 +1670,3 @@ */ | ||
* | ||
* `"7109178205151464746"` | ||
* `"7003402629929913605"` | ||
* | ||
@@ -2164,3 +2313,3 @@ */ | ||
*/ | ||
nextCursor?: string | ||
nextCursor?: number | ||
@@ -2199,3 +2348,3 @@ } | FormData) => Promise<ResponseObject>; | ||
*/ | ||
nextCursor?: string | ||
nextCursor?: number | ||
@@ -2202,0 +2351,0 @@ } | FormData) => Promise<ResponseObject>; |
106
api.js
@@ -86,2 +86,3 @@ /** | ||
const exampleVideoId = '7109178205151464746'; | ||
const exampleVideoIdMoreParameters = '7003402629929913605'; | ||
const exampleCommentId = '7109185042560680750'; | ||
@@ -251,3 +252,6 @@ | ||
count: p.count, | ||
nextCursor: p.nextCursor | ||
nextCursor: { | ||
...p.nextCursor, | ||
type: "number" | ||
} | ||
}, | ||
@@ -272,3 +276,6 @@ $other:{ | ||
count: p.count, | ||
nextCursor: p.nextCursor | ||
nextCursor: { | ||
...p.nextCursor, | ||
type: "number" | ||
} | ||
}, | ||
@@ -305,3 +312,3 @@ $other:{ | ||
required: true, | ||
example: exampleVideoId | ||
example: exampleVideoIdMoreParameters | ||
} | ||
@@ -480,2 +487,49 @@ }, | ||
}, | ||
commentsList: { | ||
help: "Get a video comments list", | ||
path: "/public/comment/list", | ||
params: { | ||
media_id: { | ||
...p.videoId, | ||
required: true, | ||
example: exampleVideoId | ||
}, | ||
count: p.count, | ||
cursor: { | ||
...p.cursor, | ||
type: "number" | ||
}, | ||
}, | ||
$other:{ | ||
openapi:{ | ||
...iterationCodeSamples('cursor') | ||
} | ||
} | ||
}, | ||
commentRepliesList: { | ||
help: "Get a comment replies list", | ||
path: "/public/comment/reply/list", | ||
params: { | ||
media_id: { | ||
...p.videoId, | ||
required: true, | ||
example: exampleVideoId | ||
}, | ||
comment_id: { | ||
...p.commentId, | ||
required: true, | ||
example: exampleCommentId | ||
}, | ||
count: p.count, | ||
cursor: { | ||
...p.cursor, | ||
type: "number" | ||
} | ||
}, | ||
$other:{ | ||
openapi:{ | ||
...iterationCodeSamples('cursor') | ||
} | ||
} | ||
}, | ||
music: { | ||
@@ -793,3 +847,6 @@ help: "Get music posts", | ||
count: p.count, | ||
nextCursor: p.nextCursor | ||
nextCursor: { | ||
...p.nextCursor, | ||
type: "number" | ||
} | ||
}, | ||
@@ -818,3 +875,6 @@ $other:{ | ||
count: p.count, | ||
nextCursor: p.nextCursor | ||
nextCursor: { | ||
...p.nextCursor, | ||
type: "number" | ||
} | ||
}, | ||
@@ -1068,2 +1128,32 @@ $other:{ | ||
}, | ||
search:{ | ||
help: "Search", | ||
comment: "Search anything, users, videos, or get keyword autocomplete suggestions. Using this instead of the Public Search endpoint will give you more personalized and consistent results. <br/>" + videoLink, | ||
path: '/user/search/{category}', | ||
params: { | ||
category: { | ||
help: "The search category", | ||
in: ["general", "users", "videos", "autocomplete"], | ||
required: true, | ||
type: "string", | ||
example: "general", | ||
location: "path" | ||
}, | ||
query:{ | ||
type: 'string', | ||
example: "lilyachty", | ||
required: true, | ||
help: 'The search keyword' | ||
}, | ||
nextCursor: p.nextCursor, | ||
}, | ||
$other:{ | ||
openapi:{ | ||
...iterationCodeSamples('nextCursor'), | ||
fields:{ | ||
security: userSecurity(['explore']), | ||
}, | ||
} | ||
} | ||
}, | ||
video: { | ||
@@ -1077,3 +1167,3 @@ help: "Get video information", | ||
required: true, | ||
example: exampleVideoId | ||
example: exampleVideoIdMoreParameters | ||
} | ||
@@ -1143,3 +1233,3 @@ }, | ||
help: "Get a video comments list", | ||
path: "/comment/list", | ||
path: "/user/comment/list", | ||
params: { | ||
@@ -1165,3 +1255,3 @@ media_id: { | ||
help: "Get a comment reply list", | ||
path: "/comment/reply/list", | ||
path: "/user/comment/reply/list", | ||
params: { | ||
@@ -1168,0 +1258,0 @@ media_id: { |
@@ -384,3 +384,3 @@ interface FormData { | ||
*/ | ||
nextCursor?: string | ||
nextCursor?: number | ||
@@ -437,3 +437,3 @@ | ||
*/ | ||
nextCursor?: string | ||
nextCursor?: number | ||
@@ -505,3 +505,3 @@ | ||
* | ||
* `"7109178205151464746"` | ||
* `"7003402629929913605"` | ||
* | ||
@@ -852,2 +852,117 @@ */ | ||
/** | ||
* Get a video comments list | ||
*/ | ||
commentsList: (params?: { | ||
/** | ||
* The video ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU) | ||
* | ||
* @example | ||
* | ||
* `"7109178205151464746"` | ||
* | ||
*/ | ||
media_id?: 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?: 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 a comment replies list | ||
*/ | ||
commentRepliesList: (params?: { | ||
/** | ||
* The video ID. Can also be a short TikTok link (e.g. vm.tiktok.com/UwU) | ||
* | ||
* @example | ||
* | ||
* `"7109178205151464746"` | ||
* | ||
*/ | ||
media_id?: string | ||
/** | ||
* The comment ID | ||
* | ||
* @example | ||
* | ||
* `"7109185042560680750"` | ||
* | ||
*/ | ||
comment_id?: 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?: 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 music posts | ||
@@ -1499,2 +1614,36 @@ */ | ||
/** | ||
* Search | ||
*/ | ||
search: (params?: { | ||
/** | ||
* The search category | ||
* | ||
* @example | ||
* | ||
* `"general"` | ||
* | ||
*/ | ||
category?: string | ||
/** | ||
* The search keyword | ||
* | ||
* @example | ||
* | ||
* `"lilyachty"` | ||
* | ||
*/ | ||
query?: string | ||
/** | ||
* 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 video information | ||
@@ -1508,3 +1657,3 @@ */ | ||
* | ||
* `"7109178205151464746"` | ||
* `"7003402629929913605"` | ||
* | ||
@@ -2151,3 +2300,3 @@ */ | ||
*/ | ||
nextCursor?: string | ||
nextCursor?: number | ||
@@ -2186,3 +2335,3 @@ } | FormData) => Promise<ResponseObject>; | ||
*/ | ||
nextCursor?: string | ||
nextCursor?: number | ||
@@ -2189,0 +2338,0 @@ } | FormData) => Promise<ResponseObject>; |
{ | ||
"name": "tikapi", | ||
"version": "3.1.41", | ||
"version": "3.2.0", | ||
"description": "A fully managed unofficial TikTok API with OAuth capabilities", | ||
@@ -5,0 +5,0 @@ "main": "./dist/index.cjs", |
Sorry, the diff of this file is not supported yet
213027
8205