Skip to content

Latest commit

 

History

History
408 lines (274 loc) · 20.9 KB

README.en.md

File metadata and controls

408 lines (274 loc) · 20.9 KB

Douyin_TikTok_Download_API(抖音/TikTok API)

English|Simplified Chinese

🚀"Douyin_TikTok_Download_API" is a high-performance asynchronous API that can be used out of the boxTik Tok|TikTok|BilibiliData crawling tool supports API calling, online batch analysis and downloading.

GitHub licenseRelease VersionGitHub StarGitHub ForkGitHub issuesGitHub closed issuesGitHub Repo size
PyPI vPyPI wheelPyPI dmPyPI pyversions
API statusTikHub-API status
爱发电KofiPatreon

👻Introduction

🚨If you need to use a private server to run this project, please refer to:Deployment preparations,Docker deployment,One-click deployment

This project is based onPyWebIOFastAPIHTTPX, fast and asynchronousTik Tok/TikTokData crawling tool, and realizes online batch parsing and downloading of videos or photo albums without watermarks, data crawling API, and iOS shortcut command without watermark downloads through the Web. You can deploy or modify this project yourself to achieve more functions, or you can call it directly in your projectscraper.pyor install an existingpip packageAs a parsing library, it is easy to crawl data, etc.....

Some simple application scenarios:

Download prohibited videos, perform data analysis, download without watermark on iOS (withShortcut command APP that comes with iOSCooperate with the API of this project to achieve in-app downloads or read clipboard downloads), etc.....

🔊 V4 version notes

  • If you are interested in writing this project together, please add us on WeChatEvil0ctalNote: Github project reconstruction, everyone can communicate and learn from each other in the group. Advertising and illegal things are not allowed. It is purely for making friends and technical exchanges.
  • used in this projectX-BogusThe algorithm can still call Douyin and TikTok APIs normally.A-BogusThe algorithm will not be open source for the time being.
  • Due to Douyin's risk control, after deploying this project, pleaseObtain the cookie of Douyin website in the browser and replace it in config.yaml.
  • Please read the document below before raising an issue. Solutions to most problems will be included in the document.
  • This project is completely free, but when using it, please comply with:Apache-2.0 license
  • This project has a closed source branch version, which contains more interfaces and services. Please see the information below for details.
  • Discord:Tikhub discord
  • Free Douyin/TikTok API:Tikhub Beta Opi

🖥Demo site: I am very vulnerable...please do not stress test (·•᷄ࡇ•᷅ )

😾The online download function of the demo site has been turned off, and due to cookie reasons, Douyin's parsing and API services cannot guarantee availability on the Demo site.

🍔Web APP:https://douyin.wtf/

🍟API Document:https://douyin.wtf/docs

🌭TikHub API Document:https://api.tikhub.io/docs

💾iOS Shortcut (shortcut command):Shortcut release

📦️Desktop downloader (recommended by warehouse):

⚗️Technology stack

/crawlers

  • Submit requests to APIs on different platforms and retrieve data. After processing, a dictionary (dict) is returned, and asynchronous support is supported.

/app/api

  • Get request parameters and useCrawlersThe related classes process the data and return it in JSON form, download the video, and cooperate with iOS shortcut commands to achieve fast calling and support asynchronous.

/app/web

  • usePyWebIOA simple web program created to process the values ​​entered on the web page and then use themCrawlersThe related class processing interface outputs related data on the web page.

Most of the parameters of the above files can be found in the correspondingconfig.yamlModify in

💡Project file structure

./Douyin_TikTok_Download_API
    ├─app
    │  ├─api
    │  │  ├─endpoints
    │  │  └─models
    │  ├─download
    │  └─web
    │      └─views
    └─crawlers
        ├─douyin
        │  └─web
        ├─hybrid
        ├─tiktok
        │  ├─app
        │  └─web
        └─utils

✨Supported functions:

  • Batch parsing on the web page (supports Douyin/TikTok mixed parsing)

  • Download videos or photo albums online.

  • makepip packageConveniently and quickly import your projects

  • iOS shortcut commands to quickly call APIAchieve in-app download of watermark-free videos/photo albums

  • Complete API documentation (Demo/Demonstration)

  • Rich API interface:

    • Douyin web version API

      • Video data analysis
      • Get user homepage work data
      • Obtain the data of works liked by the user's homepage
      • Obtain the data of collected works on the user's homepage
      • Get user homepage information
      • Get user collection work data
      • Get user live streaming data
      • Get the live streaming data of a specified user
      • Get the ranking of users who give gifts in the live broadcast room
      • Get single video comment data
      • Get the comment reply data of the specified video
      • Generate msToken
      • Generate verify_fp
      • Generate s_v_web_id
      • Generate X-Bogus parameters using interface URL
      • Extract a single user id
      • Extract list user id
      • Extract a single work id
      • Extract list work id
      • Extract live broadcast room number from list
      • Extract live broadcast room number from list
    • TikTok web version API

      • Video data analysis
      • Get user homepage work data
      • Obtain the data of works liked by the user's homepage
      • Get user homepage information
      • Get user homepage fan data
      • Get user homepage follow data
      • Get user homepage collection work data
      • Get user homepage collection data
      • Get user homepage playlist data
      • Get single video comment data
      • Get the comment reply data of the specified video
      • Generate msToken
      • Generate ttwid
      • Generate X-Bogus parameters using interface URL
      • Extract a single user sec_user_id
      • Extract list user sec_user_id
      • Extract a single work id
      • Extract list work id
      • Get user unique_id
      • Get list unique_id

📦Call the parsing library (obsolete and needs to be updated):

💡PyPi:https://pypi.org/project/douyin-tiktok-scraper/

Install the parsing library:pip install douyin-tiktok-scraper

import asyncio
from douyin_tiktok_scraper.scraper import Scraper

api = Scraper()

async def hybrid_parsing(url: str) -> dict:
    # Hybrid parsing(Douyin/TikTok URL)
    result = await api.hybrid_parsing(url)
    print(f"The hybrid parsing result:\n {result}")
    return result

asyncio.run(hybrid_parsing(url=input("Paste Douyin/TikTok/Bilibili share URL here: ")))

🗺️Supported submission formats:

💡Tip: Including but not limited to the following examples. If you encounter link parsing failure, please open a new one.issue

  • Douyin sharing password (copy in APP)
7.43 pda:/ 让你在几秒钟之内记住我  https://v.douyin.com/L5pbfdP/ 复制此链接,打开Dou音搜索,直接观看视频!
  • Douyin short URL (copy within APP)
https://v.douyin.com/L4FJNR3/
  • Douyin normal URL (copy from web version)
https://www.douyin.com/video/6914948781100338440
  • Douyin discovery page URL (APP copy)
https://www.douyin.com/discover?modal_id=7069543727328398622
  • TikTok short URL (copy within APP)
https://www.tiktok.com/t/ZTR9nDNWq/
  • TikTok normal URL (copy from web version)
https://www.tiktok.com/@evil0ctal/video/7156033831819037994
  • Douyin/TikTok batch URL (no need to use matching separation)
https://v.douyin.com/L4NpDJ6/
https://www.douyin.com/video/7126745726494821640
2.84 nqe:/ 骑白马的也可以是公主%%百万转场变身https://v.douyin.com/L4FJNR3/ 复制此链接,打开Dou音搜索,直接观看视频!
https://www.tiktok.com/t/ZTR9nkkmL/
https://www.tiktok.com/t/ZTR9nDNWq/
https://www.tiktok.com/@evil0ctal/video/7156033831819037994

🛰️API documentation

API documentation:

local:http://localhost/docs

Online:https://api.douyin.wtf/docs

API demo:

  • Crawl video data (TikTok or Douyin hybrid analysis)https://api.douyin.wtf/api/hybrid/video_data?url=[视频链接/Video URL]&minimal=false
  • Download videos/photo albums (TikTok or Douyin hybrid analysis)https://api.douyin.wtf/api/download?url=[视频链接/Video URL]&prefix=true&with_watermark=false

For more demonstrations, please view the document content...

⚠️Preparation work before deployment (please read carefully):

  • You need to solve crawler cookie risk control issues by yourself, otherwise the interface may become unusable.
    • Douyin web cookie (obtain and replace the cookie in the configuration file below):
    • Cookie: __ac_nonce=06629f03b000ca74fd5d0; __ac_signature=_02B4Z6wo00f018OnaAwAAIDCyYGzp89TogfDh2yAAJbJ17; s_v_web_id=verify_lvetxr14_jPt0ZofI_p5Nw_44FG_BGSL_SVodoPoGUlGG; ttwid=1%7CtCoZxPEZnSPKZQhxavM2S9G9udonQu1yTp4eeGEhmOU%7C1714024522%7Ce9786696e4a0d08ac93356835424aece59d214e5f5c1d054dcb62cc18a48b829; IsDouyinActive=true; home_can_add_dy_2_desktop=%220%22; dy_swidth=1463; dy_sheight=915; stream_recommend_feed_params=%22%7B%5C%22cookie_enabled%5C%22%3Atrue%2C%5C%22screen_width%5C%22%3A1463%2C%5C%22screen_height%5C%22%3A915%2C%5C%22browser_online%5C%22%3Atrue%2C%5C%22cpu_core_num%5C%22%3A32%2C%5C%22device_memory%5C%22%3A8%2C%5C%22downlink%5C%22%3A7.85%2C%5C%22effective_type%5C%22%3A%5C%224g%5C%22%2C%5C%22round_trip_time%5C%22%3A100%7D%22
    • TikTok web-side cookies (obtain and replace the cookies in the configuration file below):
    • Cookie: tt_csrf_token=YmksDB6a-h4cT2fF7JpORI2O9UBMCWjsntIc; ttwid=1%7C0FVb9fFc-sjDG2UdJwdC1AirqYozQ0xfbAS4N72vN2Y%7C1713886256%7C78a9d83445b82b73ca8d4e0cf024ea6cdf1329b7f3866c826b0a69a300ebce46; ak_bmsc=51B1D53481A3A4E4D0CEFF2BCF622DA2~000000000000000000000000000000~YAAQ7uIsF6c4j+SOAQAAANmUCxfRGVXZ4D9xnO97l1yDw0OWyomnVkNY7IUKaggUja0kQzFQ+WG4xaxBcPt0AN0n26KeHXGGKgHYpHPUMUBHGHQGDtE4RLyy7U+LPbSJCqVaSDiPuzxHht0YUIbWogvrFmBfkP4ohcmjkZxWtEI9qQ4Whaobb2CFHGdKNt0zlVNBjJQ3uYRAvUe12zSBynQB18y6QhE8goneRkCEw9VIeft2pFIwNQ8tkWWEjDt6wHNaqeND7eASg5WLzYskWbTt6bPAOhSNRLJ38HZrOB5QNg+xxN5uuCSYmjMXCl8SkvQr91pInmOng+V898FLLBQtefs95whvbpfE0mKwBk5Cz2TkkHcUJa/IoC0CLmNqoEk3AtKxpw/J; tt_chain_token=46Xkv2ukMzyJ2e7XU7y0AQ==; bm_sv=A2E67B998DE8E6A4F1C2C02485467446~YAAQ7uIsF6g4j+SOAQAABdqUCxf1J/K4dYG0k7bbw2m5rFujdlSqMoCKDubu4R602nFvbY6zWC5puJczBv3IXwJJRpQxxR03wDCMVlKTCqjQvgDs8BoCuoNQxfY2fdS+F3bKut2lxXPQ2qctqz4kHBrgspJArHn/zu/IuKCIeSzmV4KcyxW6Zvw3/xMRA0MeHgyuHsTRBS+VrFk8Ju2NbJWWC8uSHbLCM/dhFT7/ktw8RE30r24XpQmhLpVTsUSC~1; tiktok_webapp_theme=light; msToken=ySXERzKCE0QUG0cCg6TWLw3wfEB-6kh6kAfuzhzjcQvmV1jBFloSgIsT9xk-QXFVdI99U1Fqb9mhUpIOldoDkjdZwskB8rvt66MHZaHnvBRZRtOKtTYsWT8osDyQXDVZWdPkvyE598h9; passport_csrf_token=1a47d95ebf68fc3648b0018ee75afc9f; passport_csrf_token_default=1a47d95ebf68fc3648b0018ee75afc9f; perf_feed_cache={%22expireTimestamp%22:1714057200000%2C%22itemIds%22:[%227346425092966206766%22%2C%227353812964207594795%22%2C%227343343741916171563%22]}; msToken=yWwG-ITrCnjJbx5ltBa9FTXdCImOJrl-wtQJSQH3afeEumWZcbo_qcrF6F7-NjYcrG6JVxtJiOU208REZeCSgXEZrrs5_65K741fQ7PSzCGOhz6vUyycq3Xvj4Mu-S0kJ6SqyltHnpJp
  • I turned off the online download function of the demo site. The video someone downloaded was so huge that it crashed the server. You can right-click on the web page parsing results page to save the video...
  • The cookies of the demo site are my own and are not guaranteed to be valid for a long time. They only serve as a demonstration. If you deploy it yourself, please obtain the cookies yourself.
  • here is oneVideo tutorialYou can refer to:https://www.bilibili.com/video/BV1vE421j7NR/

💻Deployment (Method 1 Linux)

💡Tips: It is best to deploy this project to a server in the United States, otherwise strange BUGs may occur.

Recommended for everyone to useDigitaloceanserver, because you can have sex for free.

Use my invitation link to sign up and you can get a $200 credit, and when you spend $25 on it, I can also get a $25 reward.

My invitation link:

https://m.do.co/c/9f72a27dec35

Use script to deploy this project with one click

Start/stop service

  • Use the following commands to control running or stopping the service:
    • sudo systemctl start Douyin_TikTok_Download_API.service
    • sudo systemctl stop Douyin_TikTok_Download_API.service

Turn on/off automatic operation at startup

  • Use the following commands to set the service to run automatically at boot or cancel automatic run at boot:
    • sudo systemctl enable Douyin_TikTok_Download_API.service
    • sudo systemctl disable Douyin_TikTok_Download_API.service

Update project

  • When the project is updated, ensure that the update script is executed in the virtual environment and all dependencies are updated. Enter the project bash directory and run update.sh:
  • cd /www/wwwroot/Douyin_TikTok_Download_API/bash && sudo bash update.sh

💽Deployment (Method 2 Docker)

💡Tip: Docker deployment is the simplest deployment method and is suitable for users who are not familiar with Linux. This method is suitable for ensuring environment consistency, isolation and quick setup. Please use a server that can normally access Douyin or TikTok, otherwise strange BUG may occur.

Preparation

开始之前,请确保您的系统已安装Docker。如果还未安装Docker,可以从Docker official websiteDownload and install.

Step 1: Pull the Docker image

First, pull the latest Douyin_TikTok_Download_API image from Docker Hub.

docker pull evil0ctal/douyin_tiktok_download_api:latest

Can be replaced if neededlatestLabel the specific version you need to deploy.

Step 2: Run the Docker container

After pulling the image, you can start a container from this image. Here are the commands to run the container, including basic configuration:

docker run -d --name douyin_tiktok_api -p 80:80 evil0ctal/douyin_tiktok_download_api

Each part of this command does the following:

  • -d: Run the container in the background (detached mode).
  • --name douyin_tiktok_api : Name the containerdouyin_tiktok_api
  • -p 80:80: Map port 80 on the host to port 80 of the container. Adjust the port number based on your configuration or port availability.
  • evil0ctal/douyin_tiktok_download_api: The name of the Docker image to use.

Step 3: Verify the container is running

Check if your container is running using the following command:

docker ps

This will list all active containers. Finddouyin_tiktok_api to confirm that it is functioning properly.

Step 4: Access the App

Once the container is running, you should be able to passhttp://localhostOr API client access Douyin_TikTok_Download_API. Adjust the URL if a different port is configured or accessed from a remote location.

Optional: Custom Docker commands

For more advanced deployments, you may wish to customize Docker commands to include environment variables, volume mounts for persistent data, or other Docker parameters. Here is an example:

docker run -d --name douyin_tiktok_api -p 80:80 \
  -v /path/to/your/data:/data \
  -e MY_ENV_VAR=my_value \
  evil0ctal/douyin_tiktok_download_api
  • -v /path/to/your/data:/data: Change the/path/to/your/dataDirectory mounted to the container/dataDirectory for persisting or sharing data.
  • -e MY_ENV_VAR=my_value: Set environment variables within the containerMY_ENV_VAR, whose value ismy_value

Configuration file modification

Most of the configuration of the project can be found in the following directories:config.yamlFile modification:

  • /crawlers/douyin/web/config.yaml
  • /crawlers/tiktok/web/config.yaml
  • /crawlers/tiktok/app/config.yaml

Step 5: Stop and remove the container

When you need to stop and remove a container, use the following commands:

# Stop
docker stop douyin_tiktok_api 

# Remove
docker rm douyin_tiktok_api 

📸Screenshot

API speed test (compared to official API)

🔎点击展开截图

Douyin official API:

API of this project:

TikTok official API:

API of this project:


Project interface

🔎点击展开截图

Web main interface:

Web main interface:


📜 Star History

Star History Chart

Apache-2.0 license

Start: 2021/11/06

GitHub:@Evil0ctal