Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mahmovdsayed/tiktokapi
This API allows you to download media content from TikTok. You can retrieve video and audio download URLs, along with metadata about the video.
https://github.com/mahmovdsayed/tiktokapi
api free-api tiktok tiktok-api
Last synced: 6 days ago
JSON representation
This API allows you to download media content from TikTok. You can retrieve video and audio download URLs, along with metadata about the video.
- Host: GitHub
- URL: https://github.com/mahmovdsayed/tiktokapi
- Owner: Mahmovdsayed
- Created: 2024-07-29T04:04:27.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-07-30T01:41:45.000Z (6 months ago)
- Last Synced: 2024-07-31T05:51:22.241Z (6 months ago)
- Topics: api, free-api, tiktok, tiktok-api
- Language: JavaScript
- Homepage: https://tiktok-api-downloader.vercel.app
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TikTok Media Downloader API
This API allows you to download media content from TikTok. You can retrieve video and audio download URLs, along with metadata about the video.
## Installation
To get started, clone the repository and install the necessary dependencies:
```bash
git clone https://github.com/Mahmovdsayed/tiktokAPI.git
cd tiktokAPI
npm install
```
# Usage
Starting the Server
To start the server, run:
```bash
npm start
```
The server will be running on port 4000 by default.
# Endpoints
`GET /download`
This endpoint retrieves download URLs for a TikTok video.
Query Parameters:
url (required): The URL of the TikTok video you want to download.
Response:
On success, the response will include:
```json
{
"status": true,
"developer": "API BY MAHMOUD SAYED || https://github.com/Mahmovdsayed",
"metadata": {
"likes": Number,
"plays": Number,
"comment": Number,
"share": Number,
"downloadCount": Number,
"durationInSeconds": Number,
"title": String,
"thumbnail": String,
"url": String
},
"author": {
"id": String,
"unique_id": String,
"nickname": String,
"avatar": String,
"profileURL": String
},
"download": [
{
"url": String,
"quality": "hd",
"extension": "mp4",
"size": Number,
"formattedSize": String,
"videoAvailable": true,
"audioAvailable": true,
"chunked": false,
"cached": false
},
{
"url": String,
"quality": "sd",
"extension": "mp4",
"size": Number,
"formattedSize": String,
"videoAvailable": true,
"audioAvailable": true,
"chunked": false,
"cached": false
},
{
"url": String,
"quality": "watermark",
"extension": "mp4",
"size": Number,
"formattedSize": String,
"videoAvailable": true,
"audioAvailable": true,
"chunked": false,
"cached": false
},
{
"url": String,
"quality": "128kbps",
"extension": "mp3",
"size": Number,
"formattedSize": String,
"videoAvailable": false,
"audioAvailable": true,
"chunked": false,
"cached": false
}
]
}
```
On failure, the response will include:
```json
{
"status": false,
"error": "Failed to download video"
}
```
# Example Request
To get the download URLs for a TikTok video:
```bash
curl "http://localhost:4000/download?url=https://www.tiktok.com/@username/video/1234567890"
```
# Error Handling
**Bad Request**: If the `url` query parameter is missing **400**.
**Internal Server Error**: If there is an error processing the request **500**.
# Contributing
If you would like to contribute to this project, please fork the repository and submit a pull request.
# License
This project is licensed under the MIT License. See the LICENSE file for details.
# Contact
For any inquiries, please contact [me](https://www.instagram.com/mahmoudsaayed).