admin/tiktok-api-dl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add tiktok get comments documentation

Browse Source
This commit is contained in:
Tobi Saputra 2024-12-07 23:49:11 +07:00
parent 4461e1199a
commit 46acd692e3
1 changed files with 72 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
README.md
View File

@ -3,14 +3,25 @@
</h1> </h1>
<div align="center"> <div align="center">
<a href="https://github.com/TobyG74/tiktok-api-dl/graphs/contributors" title="contributors"><img src="https://img.shields.io/github/contributors/TobyG74/tiktok-api-dl.svg?style=for-the-badge"></img></a> <a href="https://github.com/TobyG74/tiktok-api-dl/graphs/contributors" title="contributors">
<a href="https://github.com/TobyG74/tiktok-api-dl/network/members" title="forks"><img src="https://img.shields.io/github/forks/TobyG74/tiktok-api-dl.svg?style=for-the-badge"></img></a> <img src="https://img.shields.io/github/contributors/TobyG74/tiktok-api-dl.svg?style=for-the-badge">
<a href="https://github.com/TobyG74/tiktok-api-dl/issues" title="issues"><img src="https://img.shields.io/github/issues/TobyG74/tiktok-api-dl.svg?style=for-the-badge"></img></a> </a>
<a href="https://github.com/TobyG74/tiktok-api-dl/stargazers" title="stargazer"><img src="https://img.shields.io/github/stars/TobyG74/tiktok-api-dl.svg?style=for-the-badge"></img></a> <a href="https://github.com/TobyG74/tiktok-api-dl/network/members" title="forks">
<img src="https://img.shields.io/github/forks/TobyG74/tiktok-api-dl.svg?style=for-the-badge">
</a>
<a href="https://github.com/TobyG74/tiktok-api-dl/issues" title="issues">
<img src="https://img.shields.io/github/issues/TobyG74/tiktok-api-dl.svg?style=for-the-badge">
</a>
<a href="https://github.com/TobyG74/tiktok-api-dl/stargazers" title="stargazer">
<img src="https://img.shields.io/github/stars/TobyG74/tiktok-api-dl.svg?style=for-the-badge">
</a>
</div> </div>
<br> <br>
<div align="center"> <div align="center">
<a href="https://nodei.co/npm/@tobyg74/tiktok-api-dl" title="npm"><img src="https://nodei.co/npm/@tobyg74/tiktok-api-dl.png?downloads=true&downloadRank=true&stars=true"></img></a> <a href="https://nodei.co/npm/@tobyg74/tiktok-api-dl" title="npm">
<img src="https://nodei.co/npm/@tobyg74/tiktok-api-dl.png?downloads=true&downloadRank=true&stars=true">
</a>
</div> </div>
<br> <br>
@ -88,11 +99,11 @@ npm install github:TobyG74/tiktok-api-dl
# Examples # Examples
## Tiktok Downloader ## Tiktok Downloader By URL
- V1 uses the API from TiktokAPI - V1 uses the API from TiktokAPI
- Support Video, Images / Slide, Music - Support Video, Images / Slide, Music
- ## V2 uses the API from [SSSTik](https://ssstik.io/) - V2 uses the API from [SSSTik](https://ssstik.io/)
- V3 uses the API from [MusicalDown](https://musicaldown.com/) - V3 uses the API from [MusicalDown](https://musicaldown.com/)
### Options ### Options
@ -102,15 +113,17 @@ npm install github:TobyG74/tiktok-api-dl
- `v2` : SSSTik - `v2` : SSSTik
- `v3` : MusicalDown - `v3` : MusicalDown
- `proxy` : Proxy for request - `proxy` : Proxy for request
- `showOriginalResponse` : Show original response from API && Only for V1
```js ```js
const Tiktok = require("@tobyg74/tiktok-api-dl") const Tiktok = require("@tobyg74/tiktok-api-dl")
const tiktok_url = "https://vt.tiktok.com/ZS84BnrU9" const tiktok_url = "https://vt.tiktok.com/xxxxxxxx"
Tiktok.Downloader(tiktok_url, { Tiktok.Downloader(tiktok_url, {
version: "v1", // version: "v1" | "v2" | "v3" version: "v1", // version: "v1" | "v2" | "v3"
proxy: "YOUR_PROXY" // Support Proxy Http, Https, Socks5 proxy: "YOUR_PROXY" // Support Proxy Http, Https, Socks5
showOriginalResponse: true // Only for V1
}).then((result) => { }).then((result) => {
console.log(result) console.log(result)
}) })
@ -146,7 +159,7 @@ Tiktok.Search(username, {
}) })
``` ```
## Tiktok Stalker ## Tiktok Get Profile By Username
### Options ### Options
@ -168,6 +181,26 @@ Tiktok.StalkUser(username, {
}) })
``` ```
## Tiktok Get Comments From Video
### Options
- `postLimit` : Limit the number of posts to display
- `proxy` : Proxy for request
```js
const Tiktok = require("@tobyg74/tiktok-api-dl")
const url = "https://vt.tiktok.com/xxxxxxxx"
Tiktok.GetComments(url, {
commentLimit: 20, // Limit the number of comments to display
proxy: "YOUR_PROXY" // Support Proxy Http, Https, Socks5
}).then((result) => {
console.log(result)
})
```
## Response ## Response
<br> <br>
@ -184,6 +217,7 @@ Tiktok.StalkUser(username, {
id: string id: string
createTime: number createTime: number
description: string description: string
isTurnOffComment: boolean
isADS: boolean isADS: boolean
hashtag: string[] hashtag: string[]
author: { author: {
@ -236,6 +270,7 @@ Tiktok.StalkUser(username, {
isAuthorArtist: boolean isAuthorArtist: boolean
} }
} }
resultNotParsed?: any
} }
``` ```
@ -359,7 +394,7 @@ Tiktok.StalkUser(username, {
</details> </details>
<details> <details>
<summary><b>Tiktok Stalker</b></summary> <summary><b>Tiktok Get Profile</b></summary>
<br> <br>
```ts ```ts
@ -384,6 +419,33 @@ Tiktok.StalkUser(username, {
} }
posts: Posts[] posts: Posts[]
} }
totalPosts: number
}
```
</details>
<details>
<summary><b>Tiktok Get Comments</b></summary>
<br>
```ts
{
status: "success" | "error"
message?: string
result?: [{
cid: string
text: string
commentLanguage: string
createTime: number
likeCount: number
isAuthorLiked: boolean
isCommentTranslatable: boolean
replyCommentTotal: number
replyComment: []
user: User
url: string
}],
totalComments: number
} }
``` ```