tiktok-api-dl/README.md
2023-04-03 21:19:08 +07:00

102 lines
1.4 KiB
Markdown

# Tiktok Downloader
- Used to download videos, images, music from TikTok
- No login or password are required
## Installation
- @tobyg74/tiktok-api-dl requires Node.js v10+ to run.
### Install from NPM
```
npm install @tobyg74/tiktok-api-dl
```
### Install from YARN
```
yarn add @tobyg74/tiktok-api-dl
```
## Usage
### Tiktok Downloader
```
const { TiktokDL } = require("@tobyg74/tiktok-api-dl");
const tiktok_url = "https://vt.tiktok.com/ZS84BnrU9"
TiktokDL(tiktok_url)
.then((result) => {
console.log(result);
})
```
### Tiktok Profile
```
const { TiktokStalk } = require("@tobyg74/tiktok-api-dl");
const username = "tobz2k19"
TiktokStalk(username)
.then((result) => {
console.log(result);
})
```
## Response
### Tiktok Downloader
```
{
status: "success",
result: {
type: "video" // "image",
id: ...,
create_time: ...,
description: ...,
author: {
...
},
statistics: {
...
},
video // images: [
...
],
music: [
...
]
}
}
```
### Tiktok Profile
```
{
status: "success",
result: {
users: {
username: ...,
nickname: ...,
avatar: ...,
signature: ...,
verified: ...,
region: ...
},
stats: {
followerCount: ...,
followingCount: ...,
heartCount: ...,
videoCount: ...,
likeCount: ...
}
}
}
```