Unofficial TikTok API in Python 技术文档

Unofficial TikTok API in Python 技术文档

【免费下载链接】TikTok-Api The Unofficial TikTok API Wrapper In Python 项目地址: https://gitcode.com/gh_mirrors/ti/TikTok-Api

安装指南

系统要求

• Python 3.9 及以上版本

安装步骤

1. 使用 pip 安装 TikTokApi 包：

   pip install TikTokApi
   

2. 安装 Playwright：

   python -m playwright install
   

Docker 安装

1. 克隆项目仓库或仅下载 Dockerfile。
2. 运行以下命令：

   docker pull mcr.microsoft.com/playwright:focal
   docker build . -t tiktokapi:latest
   docker run -v TikTokApi --rm tiktokapi:latest python3 your_script.py
   

   注意：假设你的脚本名为 your_script.py 并位于根目录。

项目的使用说明

快速开始

以下代码示例展示了如何获取 TikTok 上最新的热门视频：

from TikTokApi import TikTokApi
import asyncio
import os

ms_token = os.environ.get("ms_token", None) # 从 tiktok.com 的 cookies 中获取你自己的 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)
        async for video in api.trending.videos(count=30):
            print(video)
            print(video.as_dict)

if __name__ == "__main__":
    asyncio.run(trending_videos())

示例脚本

你可以直接从仓库根目录运行示例脚本：

python -m examples.trending_example

项目API使用文档

API 方法

• trending.videos(count=30): 获取热门视频。
• user.info(username): 获取用户信息。
• video.info(url): 获取视频信息。

异步调用

所有 API 方法都是异步的，因此需要使用 await 关键字来调用。

项目安装方式

本地安装

通过 pip 安装 TikTokApi 包，并安装 Playwright。

Docker 安装

使用 Docker 镜像进行安装，适用于需要在容器中运行的场景。

常见问题

浏览器属性错误

确保已运行 python3 -m playwright install，如果问题依旧，请参考 Playwright 的快速入门指南。

API 方法返回 Coroutine

确保在调用 API 方法时使用 await 关键字。

升级指南

从 V5 升级到 V6

• 异步支持：所有方法现在都是异步的。
• 维护性提升：使用 Playwright 实例池来提高维护性。
• 用户灵活性：增加了更多的函数参数选项。
• 文档改进：使用 Sphinx 文档系统，提供更详细的文档。

升级示例

确保在调用异步函数时使用 await 关键字，并参考示例目录中的更多示例。

【免费下载链接】TikTok-Api The Unofficial TikTok API Wrapper In Python 项目地址: https://gitcode.com/gh_mirrors/ti/TikTok-Api