untiktok-api
v1.4.0
Published
Unofficial TikTok API wrapper in TypeScript (ported from Python)
Maintainers
Readme
UnTikTok-Api
An unofficial TikTok API wrapper in TypeScript, originally ported from the TikTok-Api Python library.
Disclaimer: This project is not affiliated with, endorsed by, or connected to TikTok, ByteDance, or the original author of the Python TikTok-Api. It is an independent, open-source TypeScript port designed for integration into Node.js applications and AI tools.
Table of Contents
Features
This API allows you to extract and automate interactions with TikTok data without requiring an official developer API key. It achieves this by using Playwright and stealth scripts to interface directly with TikTok's web endpoints.
Capabilities include:
- Trending Feeds: Fetch the most viral and trending videos on the platform.
- User Profiles: Retrieve a user's uploaded videos, liked videos, favorited videos, reposted videos, pinned videos, followers/following lists, profile information, and live stream status.
- Hashtags: Fetch videos under specific hashtags.
- Search: Search for specific users or videos by keyword.
- Comments: Extract comments and replies from specific videos, including support for TikTok Stickers.
- Sounds/Music: Retrieve videos associated with a specific audio track or sound.
- Downloads: Download raw video bytes (without watermarks) and audio streams directly.
Installation
Install the package directly from NPM:
npm install untiktok-apiSince this wrapper relies on Playwright to interface with TikTok, you must also install the required Playwright browsers (specifically Chromium):
npx playwright install chromiumBuilding from Source
If you want to contribute, modify, or build the project locally:
git clone https://github.com/AlGhozaliRamadhan/UnTikTok-Api.git
cd UnTikTok-Api
npm install
npm run buildQuick Start
Looking to get started immediately? Check out the Quick Start Guide.
API Reference
For a full list of classes, methods, and constructor options, check out the API Reference.
Examples & Guides
For detailed examples and tutorials on how to use specific features, check out the dedicated guides in the docs/ folder:
