🔥 Xiaohongshu Link Extraction/Content Collection Tool：Extract account-published, favorited, and liked content links; extract search result content links and user links; collect Xiaohongshu content information; extract Xiaohongshu content download addresses; download Xiaohongshu watermark-free content files!
⭐ Due to the author's limited energy, I was unable to update the English document in a timely manner, and the content may have become outdated, partial translation is machine translation, the translation result may be incorrect, Suggest referring to Chinese documentation. If you want to contribute to translation, we warmly welcome you.
- Program Features
- ✅ Collect Xiaohongshu content information
- ✅ Extract Xiaohongshu content download addresses
- ✅ Download Xiaohongshu watermark-free content files
- ✅ Download Xiaohongshu livePhoto files (non-watermark-free)
- ✅ Automatically skip already downloaded content files
- ✅ Content file integrity handling mechanism
- ✅ Customizable text and image content file download format
- ✅ Persistently store content information to files
- ✅ Store content files to a separate folder
- ✅ Background clipboard monitoring for content download
- ✅ Record downloaded content IDs
- ✅ Support command line for downloading content files
- ✅ Read cookies from browser
- ✅ Customizable file name format
- ✅ Support API call functionality
- Script Features
- ✅ Download Xiaohongshu watermark-free content files
- ✅ Extract discovery page content links
- ✅ Extract account-published content links
- ✅ Extract account-favorited content links
- ✅ Extract account-liked content links
- ✅ Extract search result content links
- ✅ Extract search result user links
⭐ The development plan and progress of XHS-Downloader can be found at Projects
🎥 Click the images to watch the demo video
https://www.xiaohongshu.com/explore/WorksIDhttps://www.xiaohongshu.com/discovery/item/WorksIDhttps://xhslink.com/ShareCode
Supports entering multiple content links at once, separated by spaces; the program will automatically extract valid links without additional processing!
⭐ It is recommended to use the Windows Terminal (default terminal for Windows 11) to run the program for the best display effect!
If you only need to download watermark-free content files, it is recommended to choose Program Run; if you have other needs, it is recommended to choose Source Code Run!
It is recommended to set the cookie parameter manually; if this parameter is not set, the program functions may not work properly!
Windows 10 and above users can go to Releases to download the program package, unzip it, open the program folder, and double-click to run main.exe to use.
If you use the program in this way, the default download path for files is: .\_internal\Download; the configuration file path is: .\_internal\settings.json
- Get Image
- Method 1: Build the image using the
Dockerfile - Method 2: Pull the image using the command
docker pull joeanamier/xhs-downloader - Create Container
- TUI Mode:
docker run -it joeanamier/xhs-downloader:2.1 - API Mode:
docker run -it joeanamier/xhs-downloader:2.1 python main.py server
When running the project via Docker, the command line call mode is not supported. The clipboard reading and clipboard monitoring functions are unavailable, but pasting content works fine. Please provide feedback if other features are not functioning properly!
- Install the Python interpreter with a version no lower than
3.12 - Run the command
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txtto install the required modules - Download the latest source code of this project or the source code released in Releases to your local machine
- Run
main.pyto use
The project supports command line mode. If you want to download specific images from a text and image work, you can use this mode to set the image sequence number you want to download!
You can use the command line to read cookies from the browser and write to the configuration file! Note that you need to close the browser to read the data!
Command example: python .\main.py --browser_cookie Chrome --update_settings
The bool type parameters support setting with true, false, 1, 0, yes, no, on or off (case insensitive).
Start: Run the command: python .\main.py server
Stop: Press Ctrl + C to stop the server
Request endpoint:
/xhs/
Request method:
POST
Request format:
JSON
Request parameters:
| Parameter | Type | Description | Default |
|---|---|---|---|
| url | str | Xiaohongshu content link, auto-extraction, does not support multiple links | None |
| download | bool | Whether to download the content file; set to true will take more time |
false |
| index | list[int] | Download specific image files by index, only effective for text and image works; not effective when the download parameter is set to false |
null |
| skip | bool | Whether to skip content with download records; set to true will not return content data with download records |
false |
Code example:
def api_demo():
server = "http://127.0.0.1:8000/xhs/"
data = {
"url": "https://www.xiaohongshu.com/explore/123456789",
"download": True,
"index": [
3,
6,
9,
],
}
response = requests.post(server, json=data)
print(response.json())
If your browser has the Tampermonkey browser extension installed, you can add the user script to experience the project features without needing to download or install anything!
After successfully installing the script, open the Xiaohongshu page, check the script instructions, and follow the prompts to operate.
Note: Using the XHS-Downloader user script to batch extract content links, in combination with the XHS-Downloader program, can achieve batch downloading of watermark-free content files!
If you have other needs, you can perform code calls or modifications based on the comments in main.py!
async def example():
"""通过代码设置参数，适合二次开发"""
# 示例链接
error_link = "https://github.com/JoeanAmier/XHS_Downloader"
demo_link = "https://www.xiaohongshu.com/explore/xxxxxxxxxx"
multiple_links = f"{demo_link} {demo_link} {demo_link}"
# 实例对象
work_path = "D:\\" # 作品数据/文件保存根路径，默认值：项目根路径
folder_name = "Download" # 作品文件储存文件夹名称（自动创建），默认值：Download
name_format = "作品标题 作品描述"
sec_ch_ua = "" # 请求头 Sec-Ch-Ua
sec_ch_ua_platform = "" # 请求头 Sec-Ch-Ua-Platform
user_agent = "" # User-Agent
cookie = "" # 小红书网页版 Cookie，无需登录，必需参数，登录状态对数据采集有影响
proxy = None # 网络代理
timeout = 5 # 请求数据超时限制，单位：秒，默认值：10
chunk = 1024 * 1024 * 10 # 下载文件时，每次从服务器获取的数据块大小，单位：字节
max_retry = 2 # 请求数据失败时，重试的最大次数，单位：秒，默认值：5
record_data = False # 是否保存作品数据至文件
image_format = "WEBP" # 图文作品文件下载格式，支持：PNG、WEBP
folder_mode = False # 是否将每个作品的文件储存至单独的文件夹
async with XHS() as xhs:
pass # 使用默认参数
async with XHS(work_path=work_path,
folder_name=folder_name,
name_format=name_format,
sec_ch_ua=sec_ch_ua,
sec_ch_ua_platform=sec_ch_ua_platform,
user_agent=user_agent,
cookie=cookie,
proxy=proxy,
timeout=timeout,
chunk=chunk,
max_retry=max_retry,
record_data=record_data,
image_format=image_format,
folder_mode=folder_mode,
) as xhs: # 使用自定义参数
download = True # 是否下载作品文件，默认值：False
# 返回作品详细信息，包括下载地址
# 获取数据失败时返回空字典
print(await xhs.extract(error_link, download, ))
print(await xhs.extract(demo_link, download, ))
# 支持传入多个作品链接
print(await xhs.extract(multiple_links, download, ))
The settings.json file in the root directory of the project is automatically generated on the first run and allows customization of some runtime parameters.
If invalid parameter values are set, the program will use the default values!
| Parameter | Type | Description | Default Value |
|---|---|---|---|
| work_path | str | Root path for saving content data/files | Project root path |
| folder_name | str | Name of the folder for storing content files | Download |
| name_format | str | Format for content file names. Separate fields with spaces. Supported fields: collects, comments, shares, likes, tags, ID, title, description, type, publish_time, last_update_time, author_nickname, author_id |
publish_time author_nickname title |
| sec_ch_ua | str | Browser request header Sec-Ch-Ua | Built-in Chrome Sec-Ch-Ua |
| sec_ch_ua_platform | str | Browser request header Sec-Ch-Ua-Platform | Built-in Chrome Sec-Ch-Ua-Platform |
| user_agent | str | Browser User Agent | Built-in Chrome User Agent |
| cookie | str | Xiaohongshu web version cookie, login not required | None |
| proxy | str|dict | Set program proxy | null |
| timeout | int | Request data timeout limit, in seconds | 10 |
| chunk | int | Size of data chunk to fetch from the server each time when downloading files, in bytes | 1048576(1 MB) |
| max_retry | int | Maximum number of retries when requesting data fails | 5 |
| record_data | bool | Whether to save content data to a file, saved in SQLite format |
false |
| image_format | str | Download format for text and image content files, supported formats: PNG, WEBP |
PNG |
| image_download | bool | Switch for downloading text and image content files | true |
| video_download | bool | Switch for downloading video content files | true |
| live_download | bool | Switch for downloading animated image files | false |
| folder_mode | bool | Whether to store each content's files in a separate folder; the folder name matches the file name | false |
| language | str | Set program language. Currently supported: zh_CN, en_GB |
zh_CN |
Additional Notes: The parameters sec_ch_ua, sec_ch_ua_platform, and user_agent examples are provided for reference, and need to be set manually only if the program fails to fetch data!
- Open the browser (optional: start in incognito mode) and visit
https://www.xiaohongshu.com/explore - Log in to your Xiaohongshu account (can be skipped)
- Press
F12to open the developer tools - Select the
Networktab - Check
Preserve log - In the
Filterinput box, entercookie-name:web_session - Select the
Fetch/XHRfilter - Click on any piece of content on the Xiaohongshu page
- In the
Networktab, select any data packet (if no packets appear, repeat step 7) - Copy and paste the entire Cookie into the program or configuration file
XHS-Downloader will store the IDs of downloaded content in a database. When downloading the same content again, XHS-Downloader will automatically skip the file download (even if the content file does not exist). If you want to re-download the content file, please delete the corresponding content ID from the database and then use XHS-Downloader to download the content file again!
If XHS-Downloader has been helpful to you, please consider giving it a Star ⭐. Thank you for your support!
| 微信(WeChat) | 支付宝(Alipay) |
|---|---|
 |
 |
If you are willing, you may consider making a donation to provide additional support for XHS-Downloader!
- Author's WeChat: Downloader_Tools
- Discord Community: Click to Join the Community
✨ Other Open Source Projects by the Author:
- TikTokDownloader（抖音 / TikTok）：https://github.com/JoeanAmier/TikTokDownloader
- KS-Downloader（快手）：https://github.com/JoeanAmier/KS-Downloader
- Users decide on their own how to use this project and bear the risks themselves. The author is not responsible for any losses, liabilities, or risks incurred by users in the use of this project
- The code and functionalities provided by the author of this project are developed based on existing knowledge and technology. The author strives to ensure the correctness and security of the code but does not guarantee that the code is completely error-free or defect-free.
- Users must strictly adhere to the provisions in GNU General Public License v3.0 , and appropriately mention the use of code adhering GNU General Public License v3.0.
- Under no circumstances shall users associate the author of this project, contributors, or other related parties with the user's usage behavior, or demand that they be held responsible for any losses or damages incurred by the user's use of this project.
- Users must independently study relevant laws and regulations when using the code and functionalities of this project and ensure that their usage is legal and compliant. Users are solely responsible for any legal liability and risks resulting from violations of laws and regulations.
- The author of this project will not provide a paid version of the XHS-Downloader project, nor will they offer any commercial services related to the XHS-Downloader project.
- Any secondary development, modification, or compilation of the program based on this project is unrelated to the original author. The original author is not responsible for any consequences related to secondary development or its results. Users should take full responsibility for any situations that may arise from secondary development on their own.