repository·main·Indexed 27 days ago
https://github.com/davidteather/tiktok-apiAn unofficial Python wrapper for TikTok.com designed for data retrieval, such as trending data and specific user information. It requires Python 3.9+ and Playwright. The library is intended for data retrieval only and does not support posting content or authenticated user routes.
If you prefer using Docker, you can build an image based on the Playwright focal image. This assumes your script (e.g., your_script.py) is located in the root of the repository directory.
docker pull mcr.microsoft.com/playwright:focal
docker build . -t tiktokapi:latest
docker run -v TikTokApi --rm tiktokapi:latest python3 your_script.pyYou can run the API using Docker by pulling the Playwright image, building the local repository, and running your script. Note that the following example assumes your script is named your_script.py and is located in the repository root.
docker pull mcr.microsoft.com/playwright:focal
docker build . -t tiktokapi:latest
docker run -v TikTokApi --rm tiktokapi:latest python3 your_script.pydocker pull mcr.microsoft.com/playwright:focal
docker build . -t tiktokapi:latest
docker run -v TikTokApi --rm tiktokapi:latest python3 your_script.pyTo install the TikTokApi package, you must have Python 3.9 or higher installed. You also need to install the Playwright browsers used by the library for scraping.
Run the following commands in your terminal:
pip install TikTokApi
python -m playwright installTo use this library, you need Python 3.9 or higher. Install the package via pip and ensure the Playwright browsers are installed by running the following commands:
pip install TikTokApi
python -m playwright installpip install TikTokApi
python -m playwright installThis error indicates that TikTok has intercepted the request and detected a bot. This is often due to environment settings. Using a proxy (residential or datacenter) may be required for stable scraping.
Ensure you have installed the Playwright browsers by running:
python3 -m playwright install.
Many methods in this library are asynchronous. Ensure you use the await keyword when calling these methods within an async function.
Coroutine objects instead of data, ensure you are using the await keyword, as many methods in this library are asynchronous.python -m playwright install.EmptyResponseException indicates that TikTok is blocking the request and detecting the client as a bot. To resolve this, you may need to use a proxy. Residential proxies are often more successful than data center IPs for bypassing these blocks.Use the TikTokApi class to fetch trending videos. Note that many methods are asynchronous and must be awaited. It is recommended to provide an ms_token (retrieved from your cookies on tiktok.com) to improve request success rates.
from TikTokApi import TikTokApi
import asyncio
import os
ms_token = os.environ.get("ms_token", None) # get your own ms_token from your cookies on tiktok.com
async def trending_videos():
async with TikTokApi() as api:
await api.create_sessions(ms_tokens=[ms_token], num_sessions=1, sleep_after=3, browser=os.getenv("TIKTOK_BROWSER", "chromium"))
async for video in api.trending.videos(count=30):
print(video)
print(video.as_dict)
if __name__ == "__main__":
asyncio.run(trending_videos())This example demonstrates how to fetch the latest trending videos using TikTokApi.
Requirements:
ms_token from your browser cookies on tiktok.com and provide it via an environment variable or directly in the script.await and run within an asyncio loop.TIKTOK_BROWSER environment variable (defaults to chromium).To run the provided example script directly from the repository root:
python -m examples.trending_examplefrom TikTokApi import TikTokApi
import asyncio
import os
ms_token = os.environ.get("ms_token", None) # 从 tiktok.com 的浏览器 Cookie 中获取你的 ms_token
async def trending_videos():
async with TikTokApi() as api:
await api.create_sessions(ms_tokens=[ms_token], num_sessions=1, sleep_after=3, browser=os.getenv("TIKTOK_BROWSER", "chromium"))
async for video in api.trending.videos(count=30):
print(video)
print(video.as_dict)
if __name__ == "__main__":
asyncio.run(trending_videos()).as_dict property. Note that TikTok's data structure changes frequently, so it is recommended to inspect the dictionary structure during development.