335 lines
7.1 KiB
Markdown
335 lines
7.1 KiB
Markdown
<h1 align="center">
|
|
Tiktok Downloader & Stalk User
|
|
</h1>
|
|
|
|
<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/network/members" title="forks"><img src="https://img.shields.io/github/forks/TobyG74/tiktok-api-dl.svg?style=for-the-badge"></img></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"></img></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>
|
|
</div>
|
|
<br>
|
|
<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>
|
|
</div>
|
|
|
|
<br>
|
|
|
|
# Table of Contents
|
|
|
|
- [Description](#description)
|
|
- [How to get Tiktok Cookie](#how-to-get-tiktok-cookie)
|
|
- [Build this project](#build-this-project)
|
|
- [Install](#install)
|
|
- [From NPM](#from-npm)
|
|
- [From Yarn](#from-yarn)
|
|
- [From Github](#from-github)
|
|
- [Examples](#examples)
|
|
- [Tiktok Downloader](#tiktok-downloader)
|
|
- [Tiktok Search](#tiktok-search)
|
|
- [Tiktok Stalker](#tiktok-stalker)
|
|
- [Response](#response)
|
|
- [Contributors](#contributors)
|
|
|
|
# Description
|
|
|
|
This project uses the Unofficial API from Tiktok.
|
|
|
|
- Can be used to download videos, images / slides and music from Tiktok
|
|
- Can be used to view someone's profile from Tiktok
|
|
- No login or password are required
|
|
- It is recommended to use your own cookies on Tiktok Stalker
|
|
|
|
# How to get Tiktok Cookie
|
|
|
|
You can use cookies in the form of String or JSON
|
|
|
|
- Method 1 (String) :
|
|
|
|
Login to the [Tiktok website](https://tiktok/.com) -> Open the **Inspect Element** or you can press the shortcut **CTRL + SHIFT + I** -> Go to network -> Find the request that goes to tiktok then open the request and look for **Cookie**
|
|
|
|
|
|
|
|
- Method 2 (JSON) :
|
|
|
|
You can use the chrome extension [EditThisCookies](https://chromewebstore.google.com/detail/editthiscookie/fngmhnnpilhplaeedifhccceomclgfbg) -> Login to the [Tiktok website](https://tiktok/.com) -> Then open the **EditThisCookie** extension -> Then click **Export Cookie**
|
|
|
|
|
|
|
|
# Build this project
|
|
|
|
- Clone the repository
|
|
- Install the dependencies
|
|
- Run the build script
|
|
|
|
```bash
|
|
git clone https://github.com/TobyG74/tiktok-api-dl.git
|
|
cd tiktok-api-dl
|
|
npm install
|
|
npm run build
|
|
```
|
|
|
|
# Install
|
|
|
|
- This module requires Node.js v10+ to run.
|
|
|
|
## From NPM
|
|
|
|
```
|
|
npm install @tobyg74/tiktok-api-dl
|
|
```
|
|
|
|
## From YARN
|
|
|
|
```
|
|
yarn add @tobyg74/tiktok-api-dl
|
|
```
|
|
|
|
## From Github
|
|
|
|
```
|
|
npm install github:TobyG74/tiktok-api-dl
|
|
```
|
|
|
|
# Examples
|
|
|
|
## Tiktok Downloader
|
|
|
|
- V1 uses the API from TiktokAPI
|
|
- V2 uses the API from [SSSTik](https://ssstik.io/)
|
|
- V3 uses the API from [MusicalDown](https://musicaldown.com/)
|
|
|
|
```js
|
|
const Tiktok = require("@tobyg74/tiktok-api-dl")
|
|
|
|
const tiktok_url = "https://vt.tiktok.com/ZS84BnrU9"
|
|
|
|
Tiktok.Downloader(tiktok_url, {
|
|
version: "v1" // version: "v1" | "v2" | "v3"
|
|
}).then((result) => {
|
|
console.log(result)
|
|
})
|
|
```
|
|
|
|
## Tiktok Search
|
|
|
|
### Search User
|
|
|
|
- Using Your Cookie
|
|
|
|
```js
|
|
const Tiktok = require("@tobyg74/tiktok-api-dl")
|
|
|
|
const username = "tobz2k19"
|
|
|
|
Tiktok.Search(username, {
|
|
type: "user",
|
|
page: 1,
|
|
cookie: process.env.COOKIE || "Your Cookie"
|
|
}).then((result) => {
|
|
console.log(result)
|
|
})
|
|
```
|
|
|
|
## Tiktok Stalker
|
|
|
|
- Using Your Cookie
|
|
|
|
```js
|
|
const Tiktok = require("@tobyg74/tiktok-api-dl")
|
|
|
|
const username = "tobz2k19"
|
|
|
|
Tiktok.StalkUser(username, {
|
|
cookie: process.env.COOKIE || "Your Cookie"
|
|
}).then((result) => {
|
|
console.log(result)
|
|
})
|
|
```
|
|
|
|
# Response
|
|
|
|
<br>
|
|
<details>
|
|
<summary><b>Tiktok Downloader V1</b></summary>
|
|
<br>
|
|
|
|
```ts
|
|
{
|
|
status: "success" | "error"
|
|
message?: string
|
|
result?: {
|
|
type: "video" | "image"
|
|
id: string
|
|
createTime: number
|
|
description: string
|
|
isADS: boolean
|
|
hashtag: string[]
|
|
author: {
|
|
uid: string
|
|
username: string
|
|
nickname: string
|
|
signature: string
|
|
region: string
|
|
avatarLarger: string
|
|
avatarThumb: string
|
|
avatarMedium: string
|
|
url: string
|
|
}
|
|
statistics: {
|
|
playCount: number
|
|
downloadCount: number
|
|
shareCount: number
|
|
commentCount: number
|
|
diggCount: number
|
|
collectCount: number
|
|
forwardCount: number
|
|
whatsappShareCount: number
|
|
loseCount: number
|
|
loseCommentCount: number
|
|
whatsappShareCount: number
|
|
repostCount: number
|
|
}
|
|
video?: {
|
|
ratio: string
|
|
duration: number
|
|
playAddr: string
|
|
downloadAddr: string
|
|
cover: string
|
|
originCover: string
|
|
dynamicCover: string
|
|
}
|
|
images?: string[]
|
|
music: {
|
|
id: number
|
|
title: string
|
|
author: string
|
|
album: string
|
|
playUrl: string[]
|
|
coverLarge: string[]
|
|
coverMedium: string[]
|
|
coverThumb: string[]
|
|
duration: number
|
|
isCommerceMusic: boolean
|
|
isOriginalSound: boolean
|
|
isAuthorArtist: boolean
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
</details>
|
|
<details>
|
|
<summary><b>Tiktok Downloader V2</b></summary>
|
|
<br>
|
|
|
|
```ts
|
|
{
|
|
status: "success" | "error"
|
|
message?: string
|
|
result?: {
|
|
type: "video" | "image"
|
|
description: string
|
|
author: {
|
|
nickname: string
|
|
avatr: string
|
|
}
|
|
statistics: {
|
|
likeCount: string
|
|
commentCount: string
|
|
shareCount: string
|
|
}
|
|
video?: string
|
|
images?: string[]
|
|
music: string
|
|
}
|
|
}
|
|
```
|
|
|
|
</details>
|
|
<details>
|
|
<summary><b>Tiktok Downloader V3</b></summary>
|
|
<br>
|
|
|
|
```ts
|
|
{
|
|
status: "success" | "error"
|
|
message?: string
|
|
result?: {
|
|
type: "video" | "image"
|
|
desc?: string
|
|
author: {
|
|
avatar?: string
|
|
nickname: string
|
|
}
|
|
music?: string
|
|
images?: string[]
|
|
video1?: string
|
|
video2?: string
|
|
video_hd?: string
|
|
video_watermark?: string
|
|
}
|
|
}
|
|
```
|
|
|
|
</details>
|
|
<details>
|
|
<summary><b>Tiktok Search "User"</b></summary>
|
|
<br>
|
|
|
|
```ts
|
|
[{
|
|
status: "success" | "error"
|
|
message?: string
|
|
result?: {
|
|
uid: string
|
|
username: string
|
|
nickname: string
|
|
signature: string
|
|
followerCount: number
|
|
avatarThumb: string[]
|
|
isVerified: boolean
|
|
secUid: string
|
|
url: string
|
|
}
|
|
}]
|
|
```
|
|
|
|
</details>
|
|
<details>
|
|
<summary><b>Tiktok Stalker</b></summary>
|
|
<br>
|
|
|
|
```ts
|
|
{
|
|
status: "success" | "error"
|
|
message?: string
|
|
result?: {
|
|
users: {
|
|
username: string
|
|
nickname: string
|
|
avatar: string
|
|
signature: string
|
|
verified: boolean
|
|
region: string
|
|
}
|
|
stats: {
|
|
followerCount: number
|
|
followingCount: number
|
|
heartCount: number
|
|
videoCount: number
|
|
likeCount: number
|
|
}
|
|
posts: Posts[]
|
|
}
|
|
}
|
|
```
|
|
|
|
</details>
|
|
<br>
|
|
|
|
# Contributors
|
|
|
|
- [Nugraizy](https://github.com/nugraizy)
|
|
- [Aqul](https://github.com/zennn08)
|