Skip to main content

Unofficial TikTok API wrapper in Python with Async

Project description

Unofficial TikTok API Wrapper in Python

This is an unofficial TikTok Api python wrapper. I have an App using this API, and thus will constantly keep updating this wrapper
This implementation is inspired by TikTokApi, but runs faster.

Table of Contents

Getting Started

To get started using this API, follow the instructions below.

Installing

Pip

pip install PyTikTokAPI

Install from source

git clone https://github.com/avilash/TikTokAPI-Python.git
python setup.py install

Quick Start Guide

Import

from TikTokAPI import TikTokAPI

Get your keys from Cookie. You can get them from the Applications tab in Chrome developer console.
By default it used hardcoded values which may not work after some time.
The keys to extract are s_v_web_id and tt_webid

cookie = {
  "s_v_web_id": "<your_key>",
  "tt_webid": "<your_key>"
}

Get the most trending Videos on TikTok

api = TikTokAPI(cookie=cookie)
retval = api.getTrending(count=5)

Get a user by name

api = TikTokAPI(cookie=cookie)
user_obj = api.getUserByName("fcbarcelona")

Get videos of a user

api = TikTokAPI(cookie=cookie)
user_videos = api.getVideosByUserName("fcbarcelona")

Get likes of a user

api = TikTokAPI(cookie=cookie)
user_videos = api.getLikesByUserName("fcbarcelona")

Detailed Documentation

This section contains details about the parameters of each function and what it returns

Methods

Tiktok Class

Inputs

  • language - Self explanatory
  • region - Self explanatory
  • cookie - The TikTok Cookie containing the parameter s_v_web_id. If not provided, the parameter will be generated.
__init__(self, language='en', region='IN', cookie=None)

Get Trending Videos

Inputs

  • count - Number of videos to fetch
getTrending(self, count=30)

Get User

Inputs

  • user_name - Username, eg - fcbarcelona
getUserByName(self, user_name)

Get Videos By Username

Inputs

  • user_name - Username, eg - fcbarcelona
  • count - Number of videos to fetch
getVideosByUserName(self, user_name, count=30)

Get Likes By Username

Inputs

  • user_name - Username, eg - fcbarcelona
  • count - Number of videos to fetch
getLikesByUserName(self, user_name, count=30)

Get Hashtag

Inputs

  • hashTag - HashTag, eg - #fcbarcelona
getHashTag(self, hashTag)

Get Videos By Hashtag

Inputs

  • hashTag - HashTag, eg - #fcbarcelona
  • count - Number of videos to fetch
getVideosByHashTag(self, hashTag, count=30)

Get Music

Inputs

  • music_id - Music Id, eg - 6704854531001289474
getMusic(self, music_id)

Get Videos By Music

Inputs

  • music_id - Music Id, eg - 6704854531001289474
  • count - Number of videos to fetch
getVideosByMusic(self, music_id, count=30)

Get Video By Id

Inputs

  • video_id - Video Id, eg - 6843481669886954757
getVideoById(self, video_id)

Download Video

Inputs

  • video_id - Video Id, eg - 6843481669886954757
  • save_path - Path where the downloaded video should be saved
downloadVideoById(self, video_id, save_path)

Download Video No Watermark

Inputs

  • video_id - Video Id, eg - 6843481669886954757
  • save_path - Path where the downloaded video should be saved
downloadVideoByIdNoWatermark(self, video_id, save_path)

Built With

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details

Run on Repl.it

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PTTAPI-0.0.5.tar.gz (58.1 kB view details)

Uploaded Source

Built Distribution

PTTAPI-0.0.5-py3-none-any.whl (57.3 kB view details)

Uploaded Python 3

File details

Details for the file PTTAPI-0.0.5.tar.gz.

File metadata

  • Download URL: PTTAPI-0.0.5.tar.gz
  • Upload date:
  • Size: 58.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for PTTAPI-0.0.5.tar.gz
Algorithm Hash digest
SHA256 7491ad2027684ceb8141ce3b3a1e712a010aa9ceb04ed5e26ff131535740acc1
MD5 f9efe297b44e924083a014a91bd804b3
BLAKE2b-256 2d6f05d48e6457b61cf9dfee33c9c5fdf66f6377191ec91fa3649590ffce5323

See more details on using hashes here.

File details

Details for the file PTTAPI-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: PTTAPI-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 57.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for PTTAPI-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3743e9a9271cf92e1304869b0d8d4b8e643ba79f2d3cfcee91d4a7cc2509bb7c
MD5 edccb56be08e4e2c5a747d82d1836392
BLAKE2b-256 46acc6ca19425b5cac27396fee8aa58ebbc6b26970f9a71d563b43383bc2b49c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page