Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TikHubIO/TikHub-API-Python-SDK
High-performance asynchronous Douyin(抖音) TikTok Xiaohongshu(小红书) Kuaishou(快手) Weibo(微博) Instagram YouTube(油管) Twitter(X) Captcha Solver(验证码解决器) Temp Mail(临时邮箱) API(接口).
https://github.com/TikHubIO/TikHub-API-Python-SDK
api captcha-solver crawler data-api douyin douyin-tiktok-api instagram kuaishou netease-cloud-music private-api scrapy tiktok twitter weibo xiaohongshu xiguashipin
Last synced: about 2 months ago
JSON representation
High-performance asynchronous Douyin(抖音) TikTok Xiaohongshu(小红书) Kuaishou(快手) Weibo(微博) Instagram YouTube(油管) Twitter(X) Captcha Solver(验证码解决器) Temp Mail(临时邮箱) API(接口).
- Host: GitHub
- URL: https://github.com/TikHubIO/TikHub-API-Python-SDK
- Owner: TikHubIO
- License: apache-2.0
- Created: 2022-12-17T08:28:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-27T21:35:37.000Z (about 2 months ago)
- Last Synced: 2024-07-28T08:04:00.156Z (about 2 months ago)
- Topics: api, captcha-solver, crawler, data-api, douyin, douyin-tiktok-api, instagram, kuaishou, netease-cloud-music, private-api, scrapy, tiktok, twitter, weibo, xiaohongshu, xiguashipin
- Language: Python
- Homepage: https://docs.tikhub.io
- Size: 1.73 MB
- Stars: 225
- Watchers: 4
- Forks: 36
- Open Issues: 0
-
Metadata Files:
- Readme: README.en.md
- License: LICENSE
Awesome Lists containing this project
README
#### **Introduction**
🎉「[TikHub.io](https://tikhub.io/)"Is a**A platform for out-of-the-box integration tools and services**, our goal is to help users quickly start business and support function customization. Our vision is to form a community entrepreneurship project. A single tree cannot grow into a forest, but cooperation can lead to a win-win situation.**Every community member has the opportunity to integrate the functions or interfaces they write into our platform and benefit from them**. We have accumulated a large number of registered users and community users, and in order to realize this vision, we are actively planning and implementing cooperation strategies to ensure the sustainable and healthy development of the ecosystem. Welcome everyone to join us[Discord](https://discord.gg/aMEAS8Xsvz)Community.
#### Remark
- TikHub API currently provides the following services and is constantly being updated:
- [Douyin web version data interface](https://api.tikhub.io/#/Douyin-Web-API)
- [Douyin App V1 data interface](https://api.tikhub.io/#/Douyin-App-V1-API)
- [Douyin App V2 data interface](https://api.tikhub.io/#/Douyin-App-V2-API)
- [Douyin App V3 data interface](https://api.tikhub.io/#/Douyin-App-V3-API)
- [TikTok web version data interface](https://api.tikhub.io/#/TikTok-Web-API)
- [TikTok App V2 data interface](https://api.tikhub.io/#/TikTok-App-V2-API)
- [TikTok App V3 data interface](https://api.tikhub.io/#/TikTok-App-V3-API)
- [Xigua Video App V2 data interface](https://api.tikhub.io/#/Xigua-App-V2-API)
- [Xiaohongshu web version data interface](https://api.tikhub.io/#/Xiaohongshu-Web-API)
- [Kuaishou web version data interface](https://api.tikhub.io/#/Kuaishou-Web-API)
- [Weibo web version data interface](https://api.tikhub.io/#/Weibo-Web-API)
- [Instagram Web and APP data interface](https://api.tikhub.io/#/Instagram-Web-And-APP-API)
- [YouTube web data interface](https://api.tikhub.io/#/YouTube-Web-API)
- [NetEase Cloud Music App Data Interface](https://api.tikhub.io/#/NetEase-Cloud-Music-API)
- [Twitter web data interface](https://api.tikhub.io/#/Twitter-Web-API)
- [Verification code bypass interface](https://api.tikhub.io/#/Captcha-Solver)
- [Temporary mailbox interface](https://api.tikhub.io/#/Temp-Mail-API)
- Please report any issues or bugs to[Discord server](https://discord.gg/aMEAS8Xsvz)。
* * *
#### **quick start**
> References
- **Swagger UI Docs**:[Swagger UI](https://api.tikhub.io)
- **Documentation/documentation**:[API Documentation](https://docs.tikhub.io/)
[TikHub.io](https://tikhub.io/)Most of the APIs are RESTFUL, which means you only need to use basic HTTP requests to complete the call.
All APIs are written based on the OPenAPI specification, which means you can use our`openapi.json`Automatically generate any form of API documentation:
Of course, we have used Swagger UI by default to display our API documents. You can open the following link on the web page, then authenticate the API Token on the web page, then click on any endpoint and click`Try it out`You can test the endpoints you need. Most endpoints already carry default values or demo values, which will better help you understand the required parameters of the call:
* * *
#### **Authentication**
> Introduction
The endpoints with the 🔒 icon in the interface document need to carry the API Token in the request header before they can be called. Calling these interfaces will use the remaining free quota or account balance in your account. At the same time, each endpoint will also be based on the email of the API Token owner. The address limits the request rate. Each endpoint has independent RPS (Requests per second). In most cases, users can request the same endpoint 5 times per second.
> Generate API Token
The steps to obtain API Token are also very simple, you only need to log in to our user backend[Stay tuned](https://beta-web.tikhub.io/users/api_keys), then click on the left`API Keys`You can generate your own API Token, and at the same time, you can customize the permissions of the API Token (`Scopes`), you can also set the expiration date of the API Token (`Expire Date`), you can also manually temporarily close the API Token (`Status`）。
> Used on the API documentation web page
After you complete the above steps, you can copy your API Token, then return to our Swagger UI web page and click the green on the right side of the page`Authorize`, and then at the bottom of the pop-up window`Value`Paste the API Token in the input box to complete the authentication.
> Used in HTTP requests
If you want to carry the API Token in the HTTP request, please read the format below carefully, and you need to carry an API token in the request header.`Authorization`Field, below I will give an example of JSON as header:
{
"Authorization":"Bearer Your_API_Token"
}
> Remark
Please do not share your API Token, as this may cause you to lose property and other problems. We strongly recommend using a different API Token for each of your projects, and don’t forget to check the corresponding box when creating the API Token.`Scopes`, otherwise you will encounter insufficient permissions when requesting.
* * *
## **Use SDK**
- Install ours via PyPi[SDK](https://pypi.org/project/tikhub/)
```console
pip install tikhub
```
- Import SDK
```python
from tikhub import Client
```
- InitializeClient
```python
client = Client(base_url="https://api.tikhub.io",
api_key="YOUR_API_TOKEN",
proxies=None,
max_retries=3,
max_connections=50,
timeout=60,
max_tasks=50)
```
- Request user data example
```python
# 请求用户信息 | Request user info
user_info = await client.TikHubUser.get_user_info()
print(user_info)
# 请求用户每日使用情况 | Request user daily usage
user_daily_usage = await client.TikHubUser.get_user_daily_usage()
print(user_daily_usage)
# 计算价格 | Calculate price
price = await client.TikHubUser.calculate_price(endpoint="/api/v1/douyin/app/v1/fetch_one_video", request_per_day=100)
print(price)
# 获取阶梯式折扣百分比信息 | Get tiered discount percentage information
tiered_discount_info = await client.TikHubUser.get_tiered_discount_info()
print(tiered_discount_info)
# 获取一个端点的信息 | Get information of an endpoint
endpoint_info = await client.TikHubUser.get_endpoint_info(endpoint="/api/v1/douyin/app/v1/fetch_one_video")
print(endpoint_info)
# 获取所有端点信息 | Get all endpoints information
all_endpoints_info = await client.TikHubUser.get_all_endpoints_info()
print(all_endpoints_info)
```
- Available properties in Client
```python
# TikHub User | TikHub用户接口
self.TikHubUser = TikHubUser(self.client)
# Douyin | 抖音
self.DouyinWeb = DouyinWeb(self.client)
self.DouyinAppV1 = DouyinAppV1(self.client)
self.DouyinAppV2 = DouyinAppV2(self.client)
self.DouyinAppV3 = DouyinAppV3(self.client)
# TikTok | TikTok
self.TikTokWeb = TikTokWeb(self.client)
self.TikTokAppV2 = TikTokAppV2(self.client)
self.TikTokAppV3 = TikTokAppV3(self.client)
# Instagram | Instagram
self.InstagramWeb = InstagramWeb(self.client)
# Weibo | 微博
self.WeiboWeb = WeiboWeb(self.client)
# Captcha Solver | 验证码解决器
self.CaptchaSolver = CaptchaSolver(self.client)
# Xigua Video APP V2 | 西瓜视频APP V2
self.XiguaAppV2 = XiguaAppV2(self.client)
# XiaoHongShu Web | 小红书网页端
self.XiaohongshuWeb = XiaohongshuWeb(self.client)
# KuaiShou Web | 快手网页端
self.KuaishouWeb = KuaishouWeb(self.client)
# YouTube Web | YouTube网页端
self.YouTubeWeb = YouTubeWeb(self.client)
# 网易云音乐APP | NetEase Cloud Music APP
self.NetEaseCloudMusicAppV1 = NetEaseCloudMusicAppV1(self.client)
# Twitter Web | Twitter网页端
self.TwitterWeb = TwitterWeb(self.client)
# Hybrid Parsing
self.HybridParsing = HybridParsing(self.client)
```
- use`DouyinAppV1`of`fetch_one_video`The method calls the interface to obtain single video data.
```python
# 导入异步io库 | Import asyncio
import asyncio
# 导入tikhub | Import tikhub
from tikhub import Client
# 初始化Client | Initialize Client
client = Client(base_url="https://api.tikhub.io",
api_key="YOUR_API_TOKEN",
proxies=None,
max_retries=3,
max_connections=50,
timeout=60,
max_tasks=50)
if __name__ == "__main__":
# 获取单个作品数据 | Get single video data
video_data = asyncio.run(client.DouyinAppV1.fetch_one_video(aweme_id="7345492945006595379"))
print(video_data)
```
- We have used HTTPX to asynchronously encapsulate most endpoints. If your code is executed synchronously, you can use the following code to prevent asynchronous infection.
```python
# 导入异步io库 | Import asyncio
import asyncio
# 导入tikhub | Import tikhub
from tikhub import Client
# 初始化Client | Initialize Client
client = Client(base_url="https://api.tikhub.io",
api_key="YOUR_API_TOKEN",
proxies=None,
max_retries=3,
max_connections=50,
timeout=60,
max_tasks=50)
# 获取抖音单一视频数据 | Get a single video data from Douyin
def fetch_one_video(aweme_id: str):
# 创建一个异步事件循环
# Create an asynchronous event loop
loop = asyncio.get_event_loop()
# 使用异步事件循环运行客户端的fetch_one_video方法，防止异步传染到其他代码。
# Run the client's fetch_one_video method with the asynchronous event loop, preventing asynchronous infection to other code.
try:
__video_data = loop.run_until_complete(client.DouyinAppV1.fetch_one_video(aweme_id=aweme_id))
return __video_data
except Exception as e:
# 如果出现异常，返回异常信息
# If an exception occurs, return the exception information
return str(e)
finally:
# 关闭异步事件循环
# Close the asynchronous event
loop.close()
# 调用fetch_one_video方法 | Call the fetch_one_video method
if __name__ == "__main__":
video_data = fetch_one_video(aweme_id="7345492945006595379")
print(video_data)
```
- Due to the limited chapters, the complete methods are not listed here. You can view the methods implemented in each attribute by viewing the source code. Each method is named according to the endpoint.`uri`to name, for example`/api/v1/douyin/app/v1/fetch_one_video`The method name is`fetch_one_video`, you can find the corresponding method according to the endpoint in the API document.
- And the parameters accepted by each method have been added`type hints`, you can understand the parameter types that the method needs to pass in by looking at the parameters of the method, which can better help you call the method.
- The document can automatically help you generate codes in different programming languages. Please check for details.[API Documentation](https://docs.tikhub.io/)。
- Currently, the programming languages that can automatically generate code are:
- Shell
- JavaScript
- Java
- Swift
- Go
- PHP
- Python
- HTTP
- C
- C#
- Objective-C
- Ruby
- OCaml
- Dart
- R