{"openapi":"3.1.0","info":{"title":"TikHub Douyin/TikTok/Xiaohongshu/Lemon8/Bilibili/Sora2/Kuaishou/Pipixia/Weibo/WeChat/Instagram/YouTube/Twitter/Threads/Reddit/Zhihu/Captcha Solver/Temp Mail API","description":"\n----\n\n#### 📋 Release Information/发布信息\n- **🔢 Version/版本**: `V5.3.2`\n- **🕒 Update Time/更新时间**: `2026-03-27`\n- **🖥️ Environment/环境**: `Production`\n- **🔗 Base URL/基础路径**: `https://api.tikhub.io`\n\n#### 🌐 Basic HTTP Setup/基本HTTP设置\n- **📝 HTTP Method/请求方法**: `GET`、`POST`\n- **🔄 Retry on Error/错误重试**: `Max Retry: 3`\n- **⏱️ Timeout/超时**: `>=30s and <=60s`\n- **⚡ Rate Limit/速率限制**: `QPS: 10/Second`\n\n----\n\n📢 **重要提醒：域名访问优化（适用于中国大陆用户）**\n\n由于主域名 `api.tikhub.io` 在中国大陆被长城防火墙拦截，**请中国大陆用户改用新域名进行请求**：\n\n* 🇨🇳 **大陆用户请使用**：`https://api.tikhub.dev`（无需代理，直接可用）\n* 🌍 **非大陆用户继续使用**：`https://api.tikhub.io`\n\n接口路径和参数保持不变，仅需替换域名即可。**请勿跨区使用，会影响访问速度。**\n\n----\n\n#### 🔗 Useful Links / 有用的链接\n\n- 🏡 **Home**: [https://www.tikhub.io](https://www.tikhub.io)\n- 🐙 **GitHub Organization** (代码仓库/Repositories): [https://github.com/TikHub](https://github.com/TikHub)\n- 🛠 **Python SDK V1** (开发套件/SDK): [https://github.com/TikHub/TikHub-API-Python-SDK](https://github.com/TikHub/TikHub-API-Python-SDK)\n- 🛠 **Python SDK V2** (开发套件/SDK): [https://github.com/TikHub/TikHub-API-Python-SDK-V2](https://github.com/TikHub/TikHub-API-Python-SDK-V2)\n- 📥 **Multi-Functional Downloader** (工具/Utilities): [https://github.com/TikHub/TikHub-Multi-Functional-Downloader](https://github.com/TikHub/TikHub-Multi-Functional-Downloader)\n- 🖥️ **API Demo** (示例项目/Demo Project): [https://github.com/TikHub/TikHub-API-Demo](https://github.com/TikHub/TikHub-API-Demo)\n- 📜 **Swagger UI** (接口文档/API Documentation): [https://api.tikhub.io](https://api.tikhub.io)\n- 📚 **Apifox UI** (接口文档/API Documentation): [https://docs.tikhub.io](https://docs.tikhub.io)\n- 🧪 **API Playground** (接口测试/API Testing): [https://app.apifox.com/project/4705614](https://app.apifox.com/project/4705614)\n- 📈 **API Status Monitor** (服务监控/Service Monitoring): [https://monitor.tikhub.io](https://monitor.tikhub.io)\n- 💬 **Discord Server** (客服/Support): [https://discord.gg/aMEAS8Xsvz](https://discord.gg/aMEAS8Xsvz)\n- ✨ **X.com** (更新/Updates): [https://x.com/TikHubio](https://x.com/TikHubio)\n\n----\n\n#### 📝 备注\n- 🌐 TikHub API 是一个多社交媒体数据分析平台，为开发者提供以下数据接口服务，并且还在不断更新中：\n    - 📱 [抖音网页版数据接口](https://api.tikhub.io/#/Douyin-Web-API)\n    - 📱 [抖音App V1数据接口](https://api.tikhub.io/#/Douyin-App-V1-API) - （已弃用并且下架接口文档，请使用新版接口）\n    - 📱 [抖音App V2数据接口](https://api.tikhub.io/#/Douyin-App-V2-API) - （已弃用并且下架接口文档，请使用新版接口）\n    - 📱 [抖音App V3数据接口](https://api.tikhub.io/#/Douyin-App-V3-API)\n    - 🔥 [抖音搜索数据接口](https://api.tikhub.io/#/Douyin-Search-API)\n    - 🔥 [抖音热点榜数据接口](https://api.tikhub.io/#/Douyin-Billboard-API)\n    - ⭐ [抖音星图数据接口](https://api.tikhub.io/#/Douyin-Xingtu-API)\n    - ⭐ [抖音星图V2数据接口](https://api.tikhub.io/#/Douyin-Xingtu-V2-API)\n    - 👨‍🎨 [抖音创作者数据接口](https://api.tikhub.io/#/Douyin-Creator-API)\n    - 👨‍🎨 [抖音创作者 V2数据接口](https://api.tikhub.io/#/Douyin-Creator-V2-API) - （需要用户Cookie，可获取作品流量总览等数据）\n    - 🎵 [TikTok网页版数据接口](https://api.tikhub.io/#/TikTok-Web-API)\n    - 🎵 [TikTok App V2数据接口](https://api.tikhub.io/#/TikTok-App-V2-API) - （已弃用并且下架接口文档，请使用新版接口）\n    - 🎵 [TikTok App V3数据接口](https://api.tikhub.io/#/TikTok-App-V3-API)\n    - 👨‍🎨 [TikTok创作者数据接口 - 电商](https://api.tikhub.io/#/TikTok-Creator-API)\n    - 🎵 [TikTok数据分析接口 - MCN](https://api.tikhub.io/#/TikTok-Analytics-API)\n    - 🎵 [TikTok商城网页版数据接口](https://api.tikhub.io/#/TikTok-Shop-Web-API)\n    - 🎵 [TikTok广告创意中心数据接口 - Ads](https://api.tikhub.io/#/TikTok-Ads-API)\n    - 🍉 [西瓜视频App V2数据接口](https://api.tikhub.io/#/Xigua-App-V2-API)\n    - 📕 [小红书App V2数据接口 ⭐推荐](https://api.tikhub.io/#/Xiaohongshu-App-V2-API)\n    - 📕 [小红书App数据接口](https://api.tikhub.io/#/Xiaohongshu-App-API)\n    - 📕 [小红书网页版 V2数据接口](https://api.tikhub.io/#/Xiaohongshu-Web-V2-API)\n    - 📕 [小红书网页版数据接口](https://api.tikhub.io/#/Xiaohongshu-Web-API)\n    - 🍋 [Lemon8 App数据接口](https://api.tikhub.io/#/Lemon8-App-API)\n    - 📺 [哔哩哔哩网页版数据接口](https://api.tikhub.io/#/Bilibili-Web-API)\n    - 📺 [哔哩哔哩App数据接口](https://api.tikhub.io/#/Bilibili-App-API)\n    - 🎬 [Sora2 接口](https://api.tikhub.io/#/Sora2-API)\n    - ⚡ [快手网页版数据接口](https://api.tikhub.io/#/Kuaishou-Web-API)\n    - ⚡ [快手 App 数据接口](https://api.tikhub.io/#/Kuaishou-App-API)\n    - 🦐 [皮皮虾 App 数据接口](https://api.tikhub.io/#/PiPiXia-App-API)\n    - 🔄 [微博网页版数据接口](https://api.tikhub.io/#/Weibo-Web-API)\n    - 🔄 [微博网页版 V2数据接口](https://api.tikhub.io/#/Weibo-Web-V2-API)\n    - 🔄 [微博APP数据接口](https://api.tikhub.io/#/Weibo-App-API)\n    - 💬 [微信公众号网页版数据接口](https://api.tikhub.io/#/WeChat-Channels-API)\n    - 📱 [微信视频号数据接口](https://api.tikhub.io/#/WeChat-Channels-API)\n    - 📸 [Instagram Web以及APP数据接口](https://api.tikhub.io/#/Instagram-Web-And-APP-API) - （已弃用并且下架接口文档，请使用新版接口）\n    - 📸 [Instagram V1数据接口](https://api.tikhub.io/#/Instagram-V1-API)\n    - 📸 [Instagram V2数据接口](https://api.tikhub.io/#/Instagram-V2-API)\n    - 📹 [YouTube Web数据接口](https://api.tikhub.io/#/YouTube-Web-API)\n    - 📹 [YouTube Web V2数据接口](https://api.tikhub.io/#/YouTube-Web-V2-API)\n    - 🎵 [网易云音乐App数据接口](https://api.tikhub.io/#/NetEase-Cloud-Music-API)\n    - 🐦 [Twitter Web数据接口](https://api.tikhub.io/#/Twitter-Web-API)\n    - 🧵 [Threads Web数据接口](https://api.tikhub.io/#/Threads-Web-API)\n    - 🔴 [Reddit Web数据接口](https://api.tikhub.io/#/Reddit-Web-API)\n    - 🔴 [Reddit APP数据接口](https://api.tikhub.io/#/Reddit-APP-API)\n    - 💼 [LinkedIn Web数据接口](https://api.tikhub.io/#/LinkedIn-Web-API)\n    - ❓ [知乎Web数据接口](https://api.tikhub.io/#/Zhihu-Web-API)\n    - 🤖 [验证码绕过接口](https://api.tikhub.io/#/Captcha-Solver)\n    - ✉️ [临时邮箱接口](https://api.tikhub.io/#/Temp-Mail-API)\n- 📢 请将任何问题或错误报告给[Discord服务器](https://discord.gg/aMEAS8Xsvz)。\n\n#### 👤 用户\n- **🖥️ 官网/用户后台/用户支付**: [TikHub User](https://user.tikhub.io/users/signin)\n\n#### 📢 更新通知\n- **👋 新用户注册**\n  - 请注册并**✅ 验证邮箱**后，才能使用API及购买服务。\n- **💰 支付**\n    - 💸 PayPal 支付：支持 Visa、MasterCard、American Express 等国际信用卡；中国用户可直接使用**任意银联信用/储蓄卡**。付款时**无需注册 PayPal**，请在页面选择「信用卡/借记卡」方式完成支付。\n    - 🪙 Cryptocurrency支付: 支持USDT TRC20 加密货币支付。\n    - 📞 如果以上支付方式无法满足您的需求，请联系我们。\n- **🎁 推荐码**\n    - 您可以将推荐码注册链接发送给朋友。当您和您的朋友都成为付费用户后，双方将各获得2美元的余额（约2000次请求量）。\n    - 🔑 推荐码注册链接在个人主页中查看和生成\n    - ⏱️ 推荐码注册链接有效期为90天\n    - ✅ 使用推荐码的时候要确保您的账户已验证邮箱并且是付费用户\n- **🔑 API Key使用**\n    - 🔐 请在生成API Key后立即保存，因为API Key只会在创建后显示一次。\n    - 🔢 每位用户最多可创建20个API Key。\n- **🆓 API免费试用**\n    - 每个用户注册并且验证邮箱后，可以在用户后台的右上角点击签到按钮，获取免费试用额度，每24小时可以签到一次。\n\n----\n\n#### 🔑 API令牌简介:\n##### 📝 方法一：在请求头中使用API令牌（推荐）\n- **🏷️ 请求头**: `Authorization`\n- **📋 格式**: `Bearer your_token`\n- **📄 示例**: `\"Authorization\": \"Bearer your_token\"`\n- **🖥️ Swagger UI**: 点击页面右上角的`Authorize`按钮或点击要请求的接口旁的 `🔒` 图标，然后直接输入API令牌，无需`Bearer`关键字。\n\n##### 📝 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用）\n- **🍪 Cookie**: `Authorization`\n- **📋 格式**: `Bearer your_token`\n- **📄 示例**: `Authorization=Bearer your_token`\n\n#### 🔑 获取API令牌:\n1. 📝 在TikHub网站注册并登录账户。\n2. 👤 进入用户中心，点击API令牌菜单，创建API令牌。\n3. 📋 复制并在请求头中使用API令牌。\n4. 🔒 保密您的API令牌，仅在请求头中使用。\n\n----\n\n#### 📝 Note\n- 🌐 TikHub API is a multi-social media data analysis platform that provides the following data interface services for developers and is constantly being updated:\n    - 📱 [Douyin Web API](https://api.tikhub.io/#/Douyin-Web-API)\n    - 📱 [Douyin App V1 API](https://api.tikhub.io/#/Douyin-App-V1-API) - (This API version is deprecated and has been removed. Please use the new version of the API.)\n    - 📱 [Douyin App V2 API](https://api.tikhub.io/#/Douyin-App-V2-API) - (This API version is deprecated and has been removed. Please use the new version of the API.)\n    - 📱 [Douyin App V3 API](https://api.tikhub.io/#/Douyin-App-V3-API)\n    - 🔥 [Douyin Search API](https://api.tikhub.io/#/Douyin-Search-API)\n    - 🔥 [Douyin Billboard API](https://api.tikhub.io/#/Douyin-Billboard-API)\n    - ⭐ [Douyin Xingtu API](https://api.tikhub.io/#/Douyin-Xingtu-API)\n    - ⭐ [Douyin Xingtu V2 API](https://api.tikhub.io/#/Douyin-Xingtu-V2-API)\n    - 🎵 [TikTok Web API](https://api.tikhub.io/#/TikTok-Web-API)\n    - 🎵 [TikTok App V2 API](https://api.tikhub.io/#/TikTok-App-V2-API) - (This API version is deprecated and has been removed. Please use the new version of the API.)\n    - 🎵 [TikTok App V3 API](https://api.tikhub.io/#/TikTok-App-V3-API)\n    - 👨‍🎨 [TikTok Creator API - E-commerce](https://api.tikhub.io/#/TikTok-Creator-API)\n    - 🎵 [TikTok Analytics API - MCN](https://api.tikhub.io/#/TikTok-Analytics-API)\n    - 🎵 [TikTok Shop Web API](https://api.tikhub.io/#/TikTok-Shop-Web-API)\n    - 🎵 [TikTok Ads API -Ads](https://api.tikhub.io/#/TikTok-Ads-API)\n    - 🍉 [Xigua App V2 API](https://api.tikhub.io/#/Xigua-App-V2-API)\n    - 📕 [Xiaohongshu App V2 API ⭐Recommended](https://api.tikhub.io/#/Xiaohongshu-App-V2-API)\n    - 📕 [Xiaohongshu App API](https://api.tikhub.io/#/Xiaohongshu-App-API)\n    - 📕 [Xiaohongshu Web V2 API](https://api.tikhub.io/#/Xiaohongshu-Web-V2-API)\n    - 📕 [Xiaohongshu Web API](https://api.tikhub.io/#/Xiaohongshu-Web-API)\n    - 🍋 [Lemon8 App API](https://api.tikhub.io/#/Lemon8-App-API)\n    - 📺 [Bilibili Web API](https://api.tikhub.io/#/Bilibili-Web-API)\n    - 📺 [Bilibili App API](https://api.tikhub.io/#/Bilibili-App-API)\n    - 🎬 [Sora2 API](https://api.tikhub.io/#/Sora2-API)\n    - ⚡ [Kuaishou Web API](https://api.tikhub.io/#/Kuaishou-Web-API)\n    - ⚡ [Kuaishou App API](https://api.tikhub.io/#/Kuaishou-App-API)\n    - 🦐 [PiPiXia App API](https://api.tikhub.io/#/PiPiXia-App-API)\n    - 🔄 [Weibo Web API](https://api.tikhub.io/#/Weibo-Web-API)\n    - 🔄 [Weibo Web V2 API](https://api.tikhub.io/#/Weibo-Web-V2-API)\n    - 🔄 [Weibo APP API](https://api.tikhub.io/#/Weibo-App-API)\n    - 💬 [WeChat MP Web API](https://api.tikhub.io/#/WeChat-Channels-API)\n    - 📱 [WeChat Channels API](https://api.tikhub.io/#/WeChat-Channels-API)\n    - 📸 [Instagram Web & APP API](https://api.tikhub.io/#/Instagram-Web-And-APP-API) - (This API version is deprecated and has been removed. Please use the new version of the API.)\n    - 📸 [Instagram V1 API](https://api.tikhub.io/#/Instagram-V1-API)\n    - 📸 [Instagram V2 API](https://api.tikhub.io/#/Instagram-V2-API)\n    - 📹 [YouTube Web API](https://api.tikhub.io/#/YouTube-Web-API)\n    - 📹 [YouTube Web V2 API](https://api.tikhub.io/#/YouTube-Web-V2-API)\n    - 🎵 [NetEase Cloud Music App API](https://api.tikhub.io/#/NetEase-Cloud-Music-API)\n    - 🐦 [Twitter Web API](https://api.tikhub.io/#/Twitter-Web-API)\n    - 🧵 [Threads Web API](https://api.tikhub.io/#/Threads-Web-API)\n    - 🔴 [Reddit Web API](https://api.tikhub.io/#/Reddit-Web-API)\n    - 🔴 [Reddit APP API](https://api.tikhub.io/#/Reddit-APP-API)\n    - 💼 [LinkedIn Web API](https://api.tikhub.io/#/LinkedIn-Web-API)\n    - ❓ [Zhihu Web API](https://api.tikhub.io/#/Zhihu-Web-API)\n    - 🤖 [Captcha Solver](https://api.tikhub.io/#/Captcha-Solver)\n    - ✉️ [Temp Mail API](https://api.tikhub.io/#/Temp-Mail-API)\n- 📢 Please report any issues or errors to the [Discord server](https://discord.gg/aMEAS8Xsvz).\n\n#### 👤 Users\n- **🖥️ Official Website/User Dashboard**: [TikHub User](https://user.tikhub.io/users/signin)\n\n#### 📢 Update Notice\n- **👋 New User Registration**\n    - Please register and **✅ verify your email** before using the API and purchasing services.\n- **💰 Payment**\n    - 💸 PayPal Payment: We accept Visa, MasterCard, American Express, and other major cards. If you’re in China, simply use any **UnionPay credit** or debit card. **No PayPal account is needed**—just select the “Credit or Debit Card” option at checkout.\n    - 🪙 Cryptocurrency Payment: Supports USDT TRC20 cryptocurrencies.\n    - 📞 If the above payment methods do not meet your needs, please contact us.\n- **🎁 Referral Code**\n    - You can share your referral link with friends. Once both you and your friend become paid users, each of you will receive $2 in credits (approximately 2,000 requests).\n    - 🔑 The referral code registration link can be viewed and generated on the personal homepage.\n    - ⏱️ The referral code registration link is valid for 90 days.\n    - ✅ When using the referral code, make sure your account has verified the email and is a paid user.\n- **🔑 API Key Usage**\n    - 🔐 Please save the API Key immediately after generating it, as the API Key will only be displayed once after creation.\n    - 🔢 Each user can create up to 20 API Keys.\n- **🆓 API Free Trial**\n    - After registering and verifying your email, you can click the Check-in button in the upper right corner of the user dashboard to get a free trial balance, you can sign in once every 24 hours.\n\n----\n\n#### 🔑 API Token Introduction:\n##### 📝 Method 1: Use API Token in the Request Header (Recommended)\n- **🏷️ Header**: `Authorization`\n- **📋 Format**: `Bearer your_token`\n- **📄 Example**: `\"Authorization\": \"Bearer your_token\"`\n- **🖥️ Swagger UI**: Click on the `Authorize` button in the upper right corner of the page or click the `🔒` icon next to the interface you want to request, and then directly enter the API token without the `Bearer` keyword.\n\n##### 📝 Method 2: Use API Token in the Cookie (Not Recommended, Use Only When Method 1 is Unavailable)\n- **🍪 Cookie**: `Authorization`\n- **📋 Format**: `Bearer your_token`\n- **📄 Example**: `Authorization=Bearer your_token`\n\n#### 🔑 Get API Token:\n1. 📝 Register and log in to your account on the TikHub website.\n2. 👤 Go to the user center, click on the API token menu, and create an API token.\n3. 📋 Copy and use the API token in the request header.\n4. 🔒 Keep your API token confidential and use it only in the request header.\n\n----\n\n#### 📚 API List Index/接口列表索引\n- 👤 [TikHub User API | TikHub用户接口](https://api.tikhub.io/#/TikHub-User-API)\n- 📱 [Douyin Web API | 抖音网页接口](https://api.tikhub.io/#/Douyin-Web-API)\n- 📱 [Douyin App V1 API | 抖音App V1接口](https://api.tikhub.io/#/Douyin-App-V1-API)\n- 📱 [Douyin App V2 API | 抖音App V2接口](https://api.tikhub.io/#/Douyin-App-V2-API)\n- 📱 [Douyin App V3 API | 抖音App V3接口](https://api.tikhub.io/#/Douyin-App-V3-API)\n- 🔥 [Douyin Search API | 抖音搜索接口](https://api.tikhub.io/#/Douyin-Search-API)\n- 🔥 [Douyin Billboard API | 抖音热点榜接口](https://api.tikhub.io/#/Douyin-Billboard-API)\n- ⭐ [Douyin Xingtu API | 抖音星图接口](https://api.tikhub.io/#/Douyin-Xingtu-API)\n- ⭐ [Douyin Xingtu V2 API | 抖音星图V2接口](https://api.tikhub.io/#/Douyin-Xingtu-V2-API)\n- 🎵 [TikTok Web API | TikTok网页接口](https://api.tikhub.io/#/TikTok-Web-API)\n- 🎵 [TikTok App V2 API | TikTok App V2接口](https://api.tikhub.io/#/TikTok-App-V2-API)\n- 🎵 [TikTok App V3 API | TikTok App V3接口](https://api.tikhub.io/#/TikTok-App-V3-API)\n- 👨‍🎨 [TikTok Creator API | TikTok创作者接口](https://api.tikhub.io/#/TikTok-Creator-API)\n- 🎵 [TikTok Analytics API | TikTok数据分析接口](https://api.tikhub.io/#/TikTok-Analytics-API)\n- 🎵 [TikTok Ads API | TikTok广告创意中心接口](https://api.tikhub.io/#/TikTok-Ads-API)\n- 🍉 [Xigua App V2 API | 西瓜视频App V2接口](https://api.tikhub.io/#/Xigua-App-V2-API)\n- 📕 [Xiaohongshu App V2 API | 小红书App V2接口 ⭐推荐/Recommended](https://api.tikhub.io/#/Xiaohongshu-App-V2-API)\n- 📕 [Xiaohongshu App API | 小红书App接口](https://api.tikhub.io/#/Xiaohongshu-App-API)\n- 📕 [Xiaohongshu Web V2 API | 小红书WebV2接口](https://api.tikhub.io/#/Xiaohongshu-Web-V2-API)\n- 📕 [Xiaohongshu Web API | 小红书Web接口](https://api.tikhub.io/#/Xiaohongshu-Web-API)\n- 🍋 [Lemon8 App API | Lemon8 App接口](https://api.tikhub.io/#/Lemon8-App-API)\n- 📺 [Bilibili Web API | 哔哩哔哩Web接口](https://api.tikhub.io/#/Bilibili-Web-API)\n- 📺 [Bilibili App API | 哔哩哔哩Web接口](https://api.tikhub.io/#/Bilibili-App-API)\n- 🎬 [Sora2 API | Sora2 接口](https://api.tikhub.io/#/Sora2-API)\n- ⚡ [Kuaishou Web API | 快手网页接口](https://api.tikhub.io/#/Kuaishou-Web-API)\n- ⚡ [Kuaishou App API | 快手App接口](https://api.tikhub.io/#/Kuaishou-App-API)\n- 🦐 [PiPiXia App API | 皮皮虾App接口](https://api.tikhub.io/#/PiPiXia-App-API)\n- 🔄 [Weibo Web API | 微博网页接口](https://api.tikhub.io/#/Weibo-Web-API)\n- 🔄 [Weibo Web V2 API | 微博网页V2接口](https://api.tikhub.io/#/Weibo-Web-V2-API)\n- 🔄 [Weibo APP API | 微博APP接口](https://api.tikhub.io/#/Weibo-App-API)\n- 💬 [WeChat MP Web API | 微信公众号Web接口](https://api.tikhub.io/#/WeChat-Channels-API)\n- 📱 [WeChat Channels API | 微信视频号接口](https://api.tikhub.io/#/WeChat-Channels-API)\n- 📸 [Instagram Web & APP API | Instagram Web和APP接口](https://api.tikhub.io/#/Instagram-Web-And-APP-API)\n- 📸 [Instagram V1 API | Instagram V1接口](https://api.tikhub.io/#/Instagram-V1-API)\n- 📸 [Instagram V2 API | Instagram V2接口](https://api.tikhub.io/#/Instagram-V2-API)\n- 📹 [YouTube Web API | YouTube Web接口](https://api.tikhub.io/#/YouTube-Web-API)\n- 📹 [YouTube Web V2 API | YouTube Web V2接口](https://api.tikhub.io/#/YouTube-Web-V2-API)\n- 🎵 [NetEase Cloud Music API | 网易云音乐App接口](https://api.tikhub.io/#/NetEase-Cloud-Music-API)\n- 🐦 [Twitter Web API | Twitter Web接口](https://api.tikhub.io/#/Twitter-Web-API)\n- 🧵 [Threads Web API | Threads Web接口](https://api.tikhub.io/#/Threads-Web-API)\n- 🔴 [Reddit Web API | Reddit Web接口](https://api.tikhub.io/#/Reddit-Web-API)\n- 🔴 [Reddit APP数据接口 | Reddit APP API](https://api.tikhub.io/#/Reddit-APP-API)\n- 💼 [LinkedIn Web API | LinkedIn Web接口](https://api.tikhub.io/#/LinkedIn-Web-API)\n- ❓ [Zhihu Web API | 知乎Web接口](https://api.tikhub.io/#/Zhihu-Web-API)\n- 🤖 [Captcha Solver | 各种验证码绕过接口](https://api.tikhub.io/#/Captcha-Solver)\n- ✉️ [Temp Mail API | 临时邮箱接口](https://api.tikhub.io/#/Temp-Mail-API)\n","version":"V5.3.2"},"paths":{"/api/v1/health/check":{"get":{"tags":["Health-Check"],"summary":"检查服务器是否正确响应请求 / Check if the server responds to requests correctly","description":"# [中文]\n\n### 用途说明:\n\n- 检查服务器是否正确响应请求。\n\n### 参数说明:\n\n- 无参数。\n\n### 返回结果:\n\n- `status`: 服务器状态，正常为 `ok`。\n\n# [English]\n\n### Purpose:\n\n- Check if the server responds to requests correctly.\n\n### Parameter Description:\n\n- No parameters.\n\n### Return Result:\n\n- `status`: Server status, normal is `ok`.","operationId":"health_check_api_v1_health_check_get","responses":{"200":{"description":"服务器响应成功 / Server responds successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthCheckResponse"},"example":{"status":"ok"}}}}}}},"/api/v1/tikhub/downloader/version":{"get":{"tags":["TikHub-Downloader-API"],"summary":"检查TikHub下载器的版本更新 / Check for TikHub Downloader version updates","description":"# [中文]\n\n### 用途说明:\n\n- 检查TikHub下载器的版本更新。\n\n### 参数说明:\n\n- 无参数。\n\n### 返回结果:\n\n- `latest_version`: 最新版本号。\n- `update_date`: 更新日期。\n- `download_url`: 下载链接。\n- `upload_note`: 更新说明。\n\n# [English]\n\n### Purpose:\n\n- Check for TikHub Downloader version updates.\n\n### Parameter Description:\n\n- No parameters.\n\n### Return Result:\n\n- `latest_version`: Latest version number.\n- `update_date`: Update date.\n- `download_url`: Download link.\n- `upload_note`: Update note.","operationId":"update_check_api_v1_tikhub_downloader_version_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCheckResponse"}}}}}}},"/api/v1/tikhub/downloader/redirect_download":{"get":{"tags":["TikHub-Downloader-API"],"summary":"重定向到最新版本的下载链接 / Redirect to the latest version download link","description":"# [中文]\n\n### 用途说明:\n\n- 该接口用于检测客户端操作系统，并重定向到相应的 GitHub Release 直链，方便用户请求后直接开始下载最新版本的文件。\n\n### 参数说明:\n\n- 无参数。\n\n### 返回结果:\n\n- Windows 用户：重定向到 `.exe` 下载地址。\n- Mac 用户：重定向到 `.zip` 下载地址。\n- 其他用户：重定向到 GitHub Release 页面。\n\n# [English]\n\n### Purpose:\n\n- This endpoint detects the client operating system and redirects to the corresponding GitHub Release direct link, allowing users to start downloading the latest version file immediately.\n\n### Parameter Description:\n\n- No parameters.\n\n### Return Result:\n\n- Windows users: Redirect to `.exe` download URL.\n- Mac users: Redirect to `.zip` download URL.\n- Other users: Redirect to the GitHub Release page.","operationId":"redirect_download_api_v1_tikhub_downloader_redirect_download_get","responses":{"302":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/tikhub/user/get_user_info":{"get":{"tags":["TikHub-User-API"],"summary":"获取TikHub用户信息/Get TikHub user info","description":"# [中文]\n### 用途:\n- 请求头中携带API Key请求此端点可以查询当前账户信息。\n### 参数:\n- 请求头：{'Authorization': 'Bearer API_KEY'}\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Request this endpoint with API Key in the header to query the current account information.\n### Parameters:\n- Headers: {'Authorization': 'Bearer API_KEY'}\n### Return:\n- User information\n\n# [示例/Example]\n```python\nresponse = {\n      \"code\": 200,\n      \"router\": \"/api/v1/tikhub/user/get_user_info\",\n      \"api_key_data\": {\n        \"api_key_name\": \"Develop Test\",\n        \"api_key_scopes\": [\n          \"/api/v1/tikhub/user/\"\n        ],\n        \"created_at\": \"2024-05-22T06:07:12.495520\",\n        \"expires_at\": null,\n        \"api_key_status\": 1\n      },\n      \"user_data\": {\n        \"email\": \"example@example.com\",\n        \"balance\": 100,\n        \"free_credit\": 100,\n        \"email_verified\": true,\n        \"account_disabled\": false,\n        \"is_active\": true\n      }\n    }\n```","operationId":"get_user_info_api_v1_tikhub_user_get_user_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInfoResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tikhub/user/get_user_daily_usage":{"get":{"tags":["TikHub-User-API"],"summary":"获取用户每日使用情况/Get user daily usage","description":"# [中文]\n### 用途:\n- 请求头中携带API Key请求此端点可以查询当前账户每日使用情况。\n### 参数:\n- 请求头：{'Authorization': 'Bearer API Key'}\n### 返回:\n- 用户每日使用情况\n\n# [English]\n### Purpose:\n- Request this endpoint with API Key in the header to query the current account daily usage.\n### Parameters:\n- Headers: {'Authorization': 'Bearer API Key'}\n### Return:\n- User daily usage","operationId":"get_user_daily_usage_api_v1_tikhub_user_get_user_daily_usage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tikhub/user/calculate_price":{"get":{"tags":["TikHub-User-API"],"summary":"计算价格/Calculate price","description":"# [中文]\n### 用途:\n- 根据用户输入的每日请求次数以及端点信息计算最终价格。\n### 参数:\n- endpoint: 请求的端点，用于查询端点的原始请求单价\n- request_per_day: 每日请求次数，用于计算价格，将自动根据阶梯式计费的折扣百分比计算最终价格\n### 计算公式:\n- 总成本 = ∑ (阶梯内请求次数 * 阶梯折后单价)\n- 其中，阶梯折后单价 = 基础价格 * (1 - 折扣)\n### 详细计算步骤:\n1. **初始化总成本**：\n   总成本=0\n2. **遍历每个阶梯**：\n   * 对于每个阶梯，计算该阶梯内的请求次数。\n   * 计算该阶梯内的折后单价。\n   * 计算该阶梯内的总费用，并累加到总成本中。\n   * 更新剩余的请求次数。\n### 数学表示:\n> 设有 𝑛 个阶梯，每个阶梯的参数为：\n* min_rpd𝑖: 第 𝑖 个阶梯的最小请求次数\n* max_rpd𝑖: 第 𝑖 个阶梯的最大请求次数\n* discount𝑖: 第 𝑖 个阶梯的折扣（百分比形式）\n* base_price：基础价格\n* request_per_day：每日请求次数\n> 那么，总成本的计算公式如下：\n- 总成本 = Σ𝑖=1𝑛（阶梯𝑖中的请求数量 * 阶梯𝑖中的折扣单价）\n- 其中，阶梯折扣单价 𝑖 = base_price * (1 - 折扣𝑖/100)\n- 该阶梯中的请求数 𝑖 = min(request_per_day - 累计付费请求数, max_rpd𝑖 - min_rpd𝑖)\n### 示例\n> 假设有以下定价阶梯：\n* 第 1 阶梯：0 ≤ rpd < 1000，折扣 0%\n* 第 2 阶梯：1000 ≤ rpd < 5000，折扣 10%\n* 第 3 阶梯：5000 ≤ rpd < 10000，折扣 20%\n* 第 4 阶梯：10000 ≤ rpd < 20000，折扣 30%\n* 第 5 阶梯：20000 ≤ rpd < 30000，折扣 40%\n* 第 6 阶梯：30000 ≤ rpd，折扣 50%\n> 假设基础价格为 0.001 USD，每日请求次数为 12000，则计算过程如下：\n1. **第 1 阶梯**（0 ≤ rpd < 1000）：\n   * 阶梯内请求次数=1000−0=1000\n   * 阶梯折后单价=0.001×(1−0/100)=0.001\n   * 总成本=1000×0.001=1\n2. **第 2 阶梯**（1000 ≤ rpd < 5000）：\n   * 阶梯内请求次数=5000−1000=4000\n   * 阶梯折后单价=0.001×(1−10/100)=0.0009\n   * 总成本=4000×0.0009=3.6\n3. **第 3 阶梯**（5000 ≤ rpd < 10000）：\n   * 阶梯内请求次数=10000−5000=5000\n   * 阶梯折后单价=0.001×(1−20/100)=0.0008\n   * 总成本=5000×0.0008=4\n4. **第 4 阶梯**（10000 ≤ rpd < 20000）：\n   * 阶梯内请求次数=12000−10000=2000\n   * 阶梯折后单价=0.001×(1−30/100)=0.0007\n   * 总成本=2000×0.0007=1.4\n5. **累加总成本**：\n   * 总成本=1+3.6+4+1.4=10\n### 返回:\n- 端点uri\n- 每日请求次数\n- 端点原始请求单价\n- 总价格\n- 货币单位\n- 阶梯式计费的折扣百分比信息\n\n# [English]\n### Purpose:\n- Calculate the final price based on the user's input of the number of daily requests and endpoint information.\n- Price calculation formula: Price = Number of daily requests * (Original request unit price of the endpoint * (1 - discount percentage of tiered billing))\n### Parameters:\n- endpoint: Requested endpoint, used to query the original request unit price of the endpoint\n- request_per_day: Number of daily requests, used to calculate the price, the final price will be calculated automatically based on the discount percentage of the tiered billing\n### Calculation formula:\n- Total cost = ∑ (Number of requests in the tier * Discounted unit price in the tier)\n- Where, Discounted unit price in the tier = Base price * (1 - Discount)\n### Detailed calculation steps:\n1. **Initialize the total cost**:\n     Total cost = 0\n2. **Traverse each tier**:\n        * For each tier, calculate the number of requests in the tier.\n        * Calculate the discounted unit price in the tier.\n        * Calculate the total cost in the tier and add it to the total cost.\n        * Update the remaining number of requests.\n### Mathematical representation:\nSuppose there are 𝑛 tiers, and the parameters of each tier are:\n* min_rpd𝑖: The minimum number of requests in the 𝑖-th tier\n* max_rpd𝑖: The maximum number of requests in the 𝑖-th tier\n* discount𝑖: The discount of the 𝑖-th tier (in percentage form)\n* base_price: Base price\n* request_per_day: Number of daily requests\n> Then, the formula for calculating the total cost is as follows:\n- Total cost = ∑𝑖=1𝑛(Number of requests in the tier 𝑖 * Discounted unit price in the tier 𝑖)\n- Where, Discounted unit price in the tier 𝑖 = base_price * (1 - discount𝑖/100)\n- Number of requests in the tier 𝑖 = min(request_per_day - accumulated number of paid requests, max_rpd𝑖 - min_rpd𝑖)\n### Example\nSuppose there are the following pricing tiers:\n* Tier 1: 0 ≤ rpd < 1000, discount 0%\n* Tier 2: 1000 ≤ rpd < 5000, discount 10%\n* Tier 3: 5000 ≤ rpd < 10000, discount 20%\n* Tier 4: 10000 ≤ rpd < 20000, discount 30%\n* Tier 5: 20000 ≤ rpd < 30000, discount 40%\n* Tier 6: 30000 ≤ rpd, discount 50%\n> Suppose the base price is 0.001 USD and the number of daily requests is 12000, the calculation process is as follows:\n1. **Tier 1** (0 ≤ rpd < 1000):\n     - Number of requests in the tier 1 = 1000 - 0 = 1000\n     - Discounted unit price in the tier 1 = 0.001 * (1 - 0/100) = 0.001\n     - Total cost 1 = 1000 * 0.001 = 1\n2. **Tier 2** (1000 ≤ rpd < 5000):\n    - Number of requests in the tier 2 = 5000 - 1000 = 4000\n    - Discounted unit price in the tier 2 = 0.001 * (1 - 10/100) = 0.0009\n    - Total cost 2 = 4000 * 0.0009 = 3.6\n3. **Tier 3** (5000 ≤ rpd < 10000):\n    - Number of requests in the tier 3 = 10000 - 5000 = 5000\n    - Discounted unit price in the tier 3 = 0.001 * (1 - 20/100) = 0.0008\n    - Total cost 3 = 5000 * 0.0008 = 4\n4. **Tier 4** (10000 ≤ rpd < 20000):\n    - Number of requests in the tier 4 = 12000 - 10000 = 2000\n    - Discounted unit price in the tier 4 = 0.001 * (1 - 30/100) = 0.0007\n    - Total cost 4 = 2000 * 0.0007 = 1.4\n5. **Accumulated total cost**:\n    - Total cost = 1 + 3.6 + 4 + 1.4 = 10\n### Return:\n- Endpoint uri\n- Number of daily requests\n- Original request unit price of the endpoint\n- Total price\n- Currency unit\n- Discount percentage information of tiered billing","operationId":"calculate_price_api_v1_tikhub_user_calculate_price_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"endpoint","in":"query","required":true,"schema":{"type":"string","description":"请求的端点/Requested endpoint","title":"Endpoint"},"description":"请求的端点/Requested endpoint","example":"/api/v1/douyin/app/v1/fetch_one_video"},{"name":"request_per_day","in":"query","required":false,"schema":{"type":"integer","description":"每日请求次数/Request per day","default":1,"title":"Request Per Day"},"description":"每日请求次数/Request per day","example":100000}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tikhub/user/get_tiered_discount_info":{"get":{"tags":["TikHub-User-API"],"summary":"获取阶梯式折扣百分比信息/Get tiered discount percentage information","description":"# [中文]\n### 用途:\n- 获取阶梯式折扣百分比信息\n### 返回:\n- 阶梯式折扣百分比信息\n\n# [English]\n### Purpose:\n- Get tiered discount percentage information\n### Return:\n- Tiered discount percentage information","operationId":"get_tiered_discount_info_api_v1_tikhub_user_get_tiered_discount_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/tikhub/user/get_endpoint_info":{"get":{"tags":["TikHub-User-API"],"summary":"获取一个端点的信息/Get information of an endpoint","description":"# [中文]\n### 用途:\n- 获取一个端点的信息\n### 参数:\n- endpoint: 请求的端点\n### 返回:\n- 端点信息\n\n# [English]\n### Purpose:\n- Get information of an endpoint\n### Parameters:\n- endpoint: Requested endpoint\n### Return:\n- Endpoint information","operationId":"get_endpoint_info_api_v1_tikhub_user_get_endpoint_info_get","parameters":[{"name":"endpoint","in":"query","required":true,"schema":{"type":"string","description":"请求的端点/Requested endpoint","title":"Endpoint"},"description":"请求的端点/Requested endpoint","example":"/api/v1/douyin/app/v1/fetch_one_video"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tikhub/user/get_all_endpoints_info":{"get":{"tags":["TikHub-User-API"],"summary":"获取所有端点信息/Get all endpoints information","description":"# [中文]\n### 用途:\n- 获取所有端点信息\n### 返回:\n- 所有端点信息\n\n# [English]\n### Purpose:\n- Get all endpoints information\n### Return:\n- All endpoints information","operationId":"get_all_endpoints_info_api_v1_tikhub_user_get_all_endpoints_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/tiktok/web/fetch_post_detail":{"get":{"tags":["TikTok-Web-API"],"summary":"获取单个作品数据/Get single video data","description":"# [中文]\n### 用途:\n- 获取单个作品数据\n### 参数:\n- itemId: 作品id\n### 返回:\n- 作品数据\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get single video data\n### Parameters:\n- itemId: Video id\n### Return:\n- Video data\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nitemId = \"7339393672959757570\"","operationId":"fetch_post_detail_api_v1_tiktok_web_fetch_post_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"itemId","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Itemid"},"description":"作品id/Video id","example":"7339393672959757570"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_post_detail_v2":{"get":{"tags":["TikTok-Web-API"],"summary":"获取单个作品数据 V2/Get single video data V2","description":"# [中文]\n### 用途:\n- 获取单个作品数据\n### 参数:\n- itemId: 作品id\n### 返回:\n- 作品数据\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get single video data\n### Parameters:\n- itemId: Video id\n### Return:\n- Video data\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nitemId = \"7339393672959757570\"","operationId":"fetch_post_detail_v2_api_v1_tiktok_web_fetch_post_detail_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"itemId","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Itemid"},"description":"作品id/Video id","example":"7339393672959757570"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_explore_post":{"get":{"tags":["TikTok-Web-API"],"summary":"获取探索作品数据/Get explore video data","description":"# [中文]\n### 用途:\n- 获取探索作品数据\n### 参数:\n- categoryType: 作品分类\n    - 100: 动画与漫画\n    - 101: 表演\n    - 102: 美容护理\n    - 103: 游戏\n    - 104: 喜剧\n    - 105: 日常生活\n    - 106: 家庭\n    - 107: 情感关系\n    - 108: 戏剧\n    - 109: 穿搭\n    - 110: 对口型\n    - 111: 美食\n    - 112: 运动\n    - 113: 动物\n    - 114: 社会\n    - 115: 汽车\n    - 116: 教育\n    - 117: 健身和健康\n    - 118: 科技\n    - 119: 唱歌跳舞\n    - 120: 全部\n- count: 每页数量\n### 返回:\n- 作品数据\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get explore video data\n### Parameters:\n- categoryType: Video category\n    - 100: Animation and comics\n    - 101: Performance\n    - 102: Beauty care\n    - 103: Game\n    - 104: Comedy\n    - 105: Daily life\n    - 106: Family\n    - 107: Emotional relationship\n    - 108: Drama\n    - 109: Dress up\n    - 110: Dubbing\n    - 111: Food\n    - 112: Sports\n    - 113: Animals\n    - 114: Society\n    - 115: Car\n    - 116: Education\n    - 117: Fitness and health\n    - 118: Technology\n    - 119: Singing and dancing\n    - 120: All\n- count: Number per page\n### Return:\n- Video data\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\ncategoryType = \"120\"\ncount = 16","operationId":"fetch_explore_post_api_v1_tiktok_web_fetch_explore_post_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"categoryType","in":"query","required":false,"schema":{"type":"string","description":"作品分类/Video category","default":"120","title":"Categorytype"},"description":"作品分类/Video category"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":16,"title":"Count"},"description":"每页数量/Number per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_trending_post":{"get":{"tags":["TikTok-Web-API"],"summary":"获取每日热门内容作品数据/Get daily trending video data","description":"# [中文]\n### 用途:\n- 获取每日热门内容作品数据\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get daily trending video data\n### Return:\n- Video data\n\n# [示例/Example]","operationId":"fetch_trending_post_api_v1_tiktok_web_fetch_trending_post_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"deprecated":true,"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/fetch_trending_searchwords":{"get":{"tags":["TikTok-Web-API"],"summary":"获取每日趋势搜索关键词/Get daily trending search words","description":"# [中文]\n### 用途:\n- 获取每日趋势搜索关键词\n### 返回:\n- 趋势搜索关键词\n\n# [English]\n### Purpose:\n- Get daily trending search words\n### Return:\n- Trending search words\n\n# [示例/Example]","operationId":"fetch_trending_searchwords_api_v1_tiktok_web_fetch_trending_searchwords_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/fetch_user_profile":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的个人信息/Get user profile","description":"# [中文]\n### 用途:\n- 获取用户的个人信息\n### 参数:\n- secUid: 用户secUid\n- uniqueId: 用户uniqueId\n- secUid和uniqueId至少提供一个, 优先使用uniqueId, 也就是用户主页的链接中的用户名。\n### 返回:\n- 用户的个人信息\n\n# [English]\n### Purpose:\n- Get user profile\n### Parameters:\n- secUid: User secUid\n- uniqueId: User uniqueId\n- At least one of secUid and uniqueId is provided, and uniqueId is preferred, that is, the username in the user's homepage link.\n### Return:\n- User profile\n\n# [示例/Example]\nsecUid = \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\"\nuniqueId = \"tiktok\"","operationId":"fetch_user_profile_api_v1_tiktok_web_fetch_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uniqueId","in":"query","required":false,"schema":{"type":"string","description":"用户uniqueId/User uniqueId","default":"","title":"Uniqueid"},"description":"用户uniqueId/User uniqueId","example":"tiktok"},{"name":"secUid","in":"query","required":false,"schema":{"type":"string","description":"用户secUid/User secUid","default":"","title":"Secuid"},"description":"用户secUid/User secUid"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_user_post":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的作品列表/Get user posts","description":"# [中文]\n### 用途:\n- 获取用户的作品列表\n### 参数:\n- secUid: 用户secUid\n- cursor: 翻页游标\n- count: 每页数量，默认为20，不可变更。\n- coverFormat: 封面格式，默认为2，可选值为1或2。\n- post_item_list_request_type: 排序方式\n    - 0：默认排序\n    - 1：热门排序\n    - 2：最旧排序\n### 返回:\n- 用户的作品列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get user posts\n### Parameters:\n- secUid: User secUid\n- cursor: Page cursor\n- count: Number per page, default is 20, cannot be changed.\n- coverFormat: Cover format, default is 2, optional values are 1 or 2.\n- post_item_list_request_type: Sort type\n    - 0: Default sort\n    - 1: Hot sort\n    - 2: Oldest sort\n### Return:\n- User posts\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nsecUid = \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\"\ncursor = 0\npost_item_list_request_type = 0\ncount = 20\ncoverFormat = 2","operationId":"fetch_user_post_api_v1_tiktok_web_fetch_user_post_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"secUid","in":"query","required":true,"schema":{"type":"string","description":"用户secUid/User secUid","title":"Secuid"},"description":"用户secUid/User secUid","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor","example":0},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page","example":20},{"name":"coverFormat","in":"query","required":false,"schema":{"type":"integer","description":"封面格式/Cover format","default":2,"title":"Coverformat"},"description":"封面格式/Cover format","example":2},{"name":"post_item_list_request_type","in":"query","required":false,"schema":{"type":"integer","description":"排序方式/Sort type","default":0,"title":"Post Item List Request Type"},"description":"排序方式/Sort type","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_user_repost":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的转发作品列表/Get user reposts","description":"# [中文]\n### 用途:\n- 获取用户的转发作品列表\n### 参数:\n- secUid: 用户secUid\n- cursor: 翻页游标\n- count: 每页数量，默认为20，不可变更。\n- coverFormat: 封面格式，默认为2，可选值为1或2。\n### 返回:\n- 用户的转发作品列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get user reposts\n### Parameters:\n- secUid: User secUid\n- cursor: Page cursor\n- count: Number per page, default is 20, cannot be changed.\n- coverFormat: Cover format, default is 2, optional values are 1 or 2.\n### Return:\n- User reposts\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nsecUid = \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\"\ncursor = 0\ncount = 20\ncoverFormat = 2","operationId":"fetch_user_repost_api_v1_tiktok_web_fetch_user_repost_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"secUid","in":"query","required":true,"schema":{"type":"string","description":"用户secUid/User secUid","title":"Secuid"},"description":"用户secUid/User secUid","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor","example":0},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page","example":20},{"name":"coverFormat","in":"query","required":false,"schema":{"type":"integer","description":"封面格式/Cover format","default":2,"title":"Coverformat"},"description":"封面格式/Cover format","example":2}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_user_like":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的点赞列表/Get user likes","description":"# [中文]\n### 用途:\n- 获取用户的点赞列表\n- 注意: 该接口需要用户点赞列表为公开状态\n### 参数:\n- secUid: 用户secUid\n- cursor: 翻页游标\n- count: 每页数量，默认为20，不可变更。\n- coverFormat: 封面格式\n- post_item_list_request_type: 排序方式\n    - 0：默认排序\n    - 1：热门排序\n    - 2：最旧排序\n### 返回:\n- 用户的点赞列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get user likes\n- Note: This interface requires that the user's like list be public\n### Parameters:\n- secUid: User secUid\n- cursor: Page cursor\n- count: Number per page, default is 20, cannot be changed.\n- coverFormat: Cover format\n- post_item_list_request_type: Sort type\n    - 0: Default sort\n    - 1: Hot sort\n    - 2: Oldest sort\n### Return:\n- User likes\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nsecUid = \"MS4wLjABAAAAq1iRXNduFZpY301UkVpJ1eQT60_NiWS9QQSeNqmNQEDJp0pOF8cpleNEdiJx5_IU\"\ncursor = 0\ncount = 20\ncoverFormat = 2","operationId":"fetch_user_like_api_v1_tiktok_web_fetch_user_like_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"secUid","in":"query","required":true,"schema":{"type":"string","description":"用户secUid/User secUid","title":"Secuid"},"description":"用户secUid/User secUid","example":"MS4wLjABAAAAq1iRXNduFZpY301UkVpJ1eQT60_NiWS9QQSeNqmNQEDJp0pOF8cpleNEdiJx5_IU"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"coverFormat","in":"query","required":false,"schema":{"type":"integer","description":"封面格式/Cover format","default":2,"title":"Coverformat"},"description":"封面格式/Cover format"},{"name":"post_item_list_request_type","in":"query","required":false,"schema":{"type":"integer","description":"排序方式/Sort type","default":0,"title":"Post Item List Request Type"},"description":"排序方式/Sort type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_user_collect":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的收藏列表/Get user favorites","description":"# [中文]\n### 用途:\n- 获取用户的收藏列表\n- 注意: 该接口目前只能获取自己的收藏列表，需要提供自己账号的cookie。\n### 参数:\n- cookie: 用户cookie\n- secUid: 用户secUid\n- cursor: 翻页游标\n- count: 每页数量\n- coverFormat: 封面格式\n### 返回:\n- 用户的收藏列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get user favorites\n- Note: This interface can currently only get your own favorites list, you need to provide your account cookie.\n### Parameters:\n- cookie: User cookie\n- secUid: User secUid\n- cursor: Page cursor\n- count: Number per page\n- coverFormat: Cover format\n### Return:\n- User favorites\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\ncookie = \"Your_Cookie\"\nsecUid = \"Your_SecUid\"\ncursor = 0\ncount = 30\ncoverFormat = 2","operationId":"fetch_user_collect_api_v1_tiktok_web_fetch_user_collect_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cookie","in":"query","required":true,"schema":{"type":"string","description":"用户cookie/User cookie","title":"Cookie"},"description":"用户cookie/User cookie","example":"Your_Cookie"},{"name":"secUid","in":"query","required":true,"schema":{"type":"string","description":"用户secUid/User secUid","title":"Secuid"},"description":"用户secUid/User secUid","example":"Your_SecUid"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":30,"title":"Count"},"description":"每页数量/Number per page"},{"name":"coverFormat","in":"query","required":false,"schema":{"type":"integer","description":"封面格式/Cover format","default":2,"title":"Coverformat"},"description":"封面格式/Cover format"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_user_play_list":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的播放列表/Get user play list","description":"# [中文]\n### 用途:\n- 获取用户的播放列表\n### 参数:\n- secUid: 用户secUid\n- cursor: 翻页游标\n- count: 每页数量\n### 返回:\n- 用户的播放列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get user play list\n### Parameters:\n- secUid: User secUid\n- cursor: Page cursor\n- count: Number per page\n### Return:\n- User play list\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Eample]\nsecUid = \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\"\ncursor = 0\ncount = 30","operationId":"fetch_user_play_list_api_v1_tiktok_web_fetch_user_play_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"secUid","in":"query","required":true,"schema":{"type":"string","description":"用户secUid/User secUid","title":"Secuid"},"description":"用户secUid/User secUid","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":30,"title":"Count"},"description":"每页数量/Number per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_user_mix":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的合辑列表/Get user mix list","description":"# [中文]\n### 用途:\n- 获取用户的合辑列表\n### 参数:\n- mixId: 合辑id\n- cursor: 翻页游标\n- count: 每页数量\n### 返回:\n- 用户的合辑列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get user mix list\n### Parameters:\n- mixId: Mix id\n- cursor: Page cursor\n- count: Number per page\n### Return:\n- User mix list\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Eample]\nmixId = \"7101538765474106158\"\ncursor = 0\ncount = 30","operationId":"fetch_user_mix_api_v1_tiktok_web_fetch_user_mix_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"mixId","in":"query","required":true,"schema":{"type":"string","description":"合辑id/Mix id","title":"Mixid"},"description":"合辑id/Mix id","example":"7101538765474106158"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":30,"title":"Count"},"description":"每页数量/Number per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_post_comment":{"get":{"tags":["TikTok-Web-API"],"summary":"获取作品的评论列表/Get video comments","description":"# [中文]\n### 用途:\n- 获取作品的评论列表\n### 参数:\n- aweme_id: 作品id\n- cursor: 翻页游标\n- count: 每页数量\n- current_region: 当前地区，默认为空。\n### 返回:\n- 作品的评论列表\n\n# [English]\n### Purpose:\n- Get video comments\n### Parameters:\n- aweme_id: Video id\n- cursor: Page cursor\n- count: Number per page\n- current_region: Current region, default is empty.\n### Return:\n- Video comments\n\n# [示例/Eample]\naweme_id = \"7304809083817774382\"\ncursor = 0\ncount = 20\ncurrent_region = \"\"","operationId":"fetch_post_comment_api_v1_tiktok_web_fetch_post_comment_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7304809083817774382"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"current_region","in":"query","required":false,"schema":{"type":"string","description":"当前地区/Current region","default":"","title":"Current Region"},"description":"当前地区/Current region"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_post_comment_reply":{"get":{"tags":["TikTok-Web-API"],"summary":"获取作品的评论回复列表/Get video comment replies","description":"# [中文]\n### 用途:\n- 获取作品的评论回复列表\n### 参数:\n- item_id: 作品id\n- comment_id: 评论id\n- cursor: 翻页游标\n- count: 每页数量\n- current_region: 当前地区，默认为空。\n### 返回:\n- 作品的评论回复列表\n\n# [English]\n### Purpose:\n- Get video comment replies\n### Parameters:\n- item_id: Video id\n- comment_id: Comment id\n- cursor: Page cursor\n- count: Number per page\n- current_region: Current region, default is empty.\n### Return:\n- Video comment replies\n\n# [示例/Eample]\nitem_id = \"7304809083817774382\"\ncomment_id = \"7304877760886588191\"\ncursor = 0\ncount = 20\ncurrent_region = \"\"","operationId":"fetch_post_comment_reply_api_v1_tiktok_web_fetch_post_comment_reply_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7304809083817774382"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论id/Comment id","title":"Comment Id"},"description":"评论id/Comment id","example":"7304877760886588191"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"current_region","in":"query","required":false,"schema":{"type":"string","description":"当前地区/Current region","default":"","title":"Current Region"},"description":"当前地区/Current region"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_user_fans":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的粉丝列表/Get user followers","description":"# [中文]\n### 用途:\n- 获取用户的粉丝列表\n### 参数:\n- secUid: 用户secUid\n- count: 每页数量\n- maxCursor: 最大游标\n- minCursor: 最小游标\n### 返回:\n- 用户的粉丝列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get user followers\n### Parameters:\n- secUid: User secUid\n- count: Number per page\n- maxCursor: Max cursor\n- minCursor: Min cursor\n### Return:\n- User followers\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nsecUid = \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\"\ncount = 30\nmaxCursor = 0\nminCursor = 0","operationId":"fetch_user_fans_api_v1_tiktok_web_fetch_user_fans_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"secUid","in":"query","required":true,"schema":{"type":"string","description":"用户secUid/User secUid","title":"Secuid"},"description":"用户secUid/User secUid","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":30,"title":"Count"},"description":"每页数量/Number per page"},{"name":"maxCursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Max cursor","default":0,"title":"Maxcursor"},"description":"最大游标/Max cursor"},{"name":"minCursor","in":"query","required":false,"schema":{"type":"integer","description":"最小游标/Min cursor","default":0,"title":"Mincursor"},"description":"最小游标/Min cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_user_follow":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的关注列表/Get user followings","description":"# [中文]\n### 用途:\n- 获取用户的关注列表\n### 参数:\n- secUid: 用户secUid\n- count: 每页数量\n- maxCursor: 最大游标\n- minCursor: 最小游标\n### 返回:\n- 用户的关注列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get user followings\n### Parameters:\n- secUid: User secUid\n- count: Number per page\n- maxCursor: Max cursor\n- minCursor: Min cursor\n### Return:\n- User followings\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nsecUid = \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\"\ncount = 30\nmaxCursor = 0\nminCursor = 0","operationId":"fetch_user_follow_api_v1_tiktok_web_fetch_user_follow_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"secUid","in":"query","required":true,"schema":{"type":"string","description":"用户secUid/User secUid","title":"Secuid"},"description":"用户secUid/User secUid","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":30,"title":"Count"},"description":"每页数量/Number per page"},{"name":"maxCursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Max cursor","default":0,"title":"Maxcursor"},"description":"最大游标/Max cursor"},{"name":"minCursor","in":"query","required":false,"schema":{"type":"integer","description":"最小游标/Min cursor","default":0,"title":"Mincursor"},"description":"最小游标/Min cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_user_live_detail":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户的直播详情/Get user live details","description":"# [中文]\n### 用途:\n- 获取用户的直播详情\n### 参数:\n- uniqueId: 用户uniqueId\n### 返回:\n- 用户的直播详情\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get user live details\n### Parameters:\n- uniqueId: User uniqueId\n### Return:\n- User live details\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nuniqueId = \"tiktok\"","operationId":"fetch_user_live_detail_api_v1_tiktok_web_fetch_user_live_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uniqueId","in":"query","required":true,"schema":{"type":"string","description":"用户uniqueId/User uniqueId","title":"Uniqueid"},"description":"用户uniqueId/User uniqueId","example":"tiktok"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_general_search":{"get":{"tags":["TikTok-Web-API"],"summary":"获取综合搜索列表/Get general search list","description":"# [中文]\n### 用途:\n- 获取综合搜索列表\n### 参数:\n- keyword: 搜索关键词\n- offset: 翻页游标，第一次请求时为0，第二次请求时从上一次请求的返回响应中获取，一般这个值的关键字为offset或者cursor。\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- cookie: 用户cookie(如果你需要使用自己的账号搜索，或者遇到接口报错，可以自行提供cookie，默认不需要提供)\n### 返回:\n- 综合搜索列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get general search list\n### Parameters:\n- keyword: Search keyword\n- offset: Page cursor, 0 for the first request, need to provide for the second paging, generally the keyword of this value is offset or cursor.\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)\n### Return:\n- General search list\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nkeyword = \"TikTok\"\noffset = 0\nsearch_id = \"\"","operationId":"fetch_general_search_api_v1_tiktok_web_fetch_general_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"TikTok"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Offset"},"description":"翻页游标/Page cursor"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户cookie(按需提供)/User cookie(if needed)","title":"Cookie"},"description":"用户cookie(按需提供)/User cookie(if needed)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_search_keyword_suggest":{"get":{"tags":["TikTok-Web-API"],"summary":"搜索关键字推荐/Search keyword suggest","description":"# [中文]\n### 用途:\n- 搜索关键字推荐\n### 参数:\n- keyword: 搜索关键词\n### 返回:\n- 关键字推荐列表\n\n# [English]\n### Purpose:\n- Search keyword suggest\n### Parameters:\n- keyword: Search keyword\n### Return:\n- Keyword suggest list\n\n# [示例/Example]\nkeyword = \"TikTok\"","operationId":"fetch_search_keyword_suggest_api_v1_tiktok_web_fetch_search_keyword_suggest_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"TikTok"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_search_user":{"get":{"tags":["TikTok-Web-API"],"summary":"搜索用户/Search user","description":"# [中文]\n### 用途:\n- 搜索用户\n### 参数:\n- keyword: 搜索关键词\n- cursor: 翻页游标，第一次请求时为0，第二次请求时从上一次请求的返回响应中获取，一般这个值的关键字为offset或者cursor。\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- cookie: 用户cookie(如果你需要使用自己的账号搜索，或者遇到接口报错，可以自行提供cookie，默认不需要提供)\n### 返回:\n- 用户列表\n### 备注:\n- 如果接口响应的 `data` 字段中的 `status_code` 不为0，说明搜索请求未成功，此时请检查响应里的异常，有可能你在搜索 TikTok 不允许的关键词，或者搜索了敏感内容，请更换关键词重试。\n\n# [English]\n### Purpose:\n- Search user\n### Parameters:\n- keyword: Search keyword\n- cursor: Page cursor, 0 for the first request, need to provide for the second paging, generally the keyword of this value is offset or cursor.\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)\n### Return:\n- User list\n### Note:\n- If the `status_code` in the `data` field of the interface response is not 0, it means that the search request was not successful. Please check the exceptions in the response. You may be searching for keywords that TikTok does not allow, or searching for sensitive content. Please change the keywords and try again.\n\n# [示例/Example]\nkeyword = \"TikTok\"\ncursor = 0\nsearch_id = \"\"","operationId":"fetch_search_user_api_v1_tiktok_web_fetch_search_user_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"TikTok"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户cookie(按需提供)/User cookie(if needed)","title":"Cookie"},"description":"用户cookie(按需提供)/User cookie(if needed)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_search_video":{"get":{"tags":["TikTok-Web-API"],"summary":"搜索视频/Search video","description":"# [中文]\n### 用途:\n- 搜索视频\n### 参数:\n- keyword: 搜索关键词\n- count: 每页数量，建议保持默认值20。\n- offset: 翻页游标，第一次请求时为0，第二次请求时从上一次请求的返回响应中获取。\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- cookie: 用户cookie(如果你需要使用自己的账号搜索，或者遇到接口报错，可以自行提供cookie，默认不需要提供)\n### 返回:\n- 视频列表\n\n# [English]\n### Purpose:\n- Search video\n### Parameters:\n- keyword: Search keyword\n- count: Number per page, it is recommended to keep the default value 20.\n- offset: Page offset, 0 for the first request, need to provide for the second paging.\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)\n### Return:\n- Video list\n\n# [示例/Example]\nkeyword = \"TikTok\"\ncount = 20\noffset = 0\nsearch_id = \"\"","operationId":"fetch_search_video_api_v1_tiktok_web_fetch_search_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"TikTok"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Offset"},"description":"翻页游标/Page cursor"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户cookie(按需提供)/User cookie(if needed)","title":"Cookie"},"description":"用户cookie(按需提供)/User cookie(if needed)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_search_live":{"get":{"tags":["TikTok-Web-API"],"summary":"搜索直播/Search live","description":"# [中文]\n### 用途:\n- 搜索直播\n### 参数:\n- keyword: 搜索关键词\n- count: 每页数量\n- offset: 翻页游标，第一次请求时为0，第二次请求时从上一次请求的返回响应中获取。\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- cookie: 用户cookie(如果你需要使用自己的账号搜索，或者遇到接口报错，可以自行提供cookie，默认不需要提供)\n### 返回:\n- 直播列表\n\n# [English]\n### Purpose:\n- Search live\n### Parameters:\n- keyword: Search keyword\n- count: Number per page\n- offset: Page offset, 0 for the first request, need to provide for the second paging.\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)\n### Return:\n- Live list\n\n# [示例/Example]\nkeyword = \"TikTok\"\ncount = 20\noffset = 0\nsearch_id = \"\"","operationId":"fetch_search_live_api_v1_tiktok_web_fetch_search_live_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"TikTok"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Offset"},"description":"翻页游标/Page cursor"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户cookie(按需提供)/User cookie(if needed)","title":"Cookie"},"description":"用户cookie(按需提供)/User cookie(if needed)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_search_photo":{"get":{"tags":["TikTok-Web-API"],"summary":"搜索照片/Search photo","description":"# [中文]\n### 用途:\n- 搜索照片\n### 参数:\n- keyword: 搜索关键词\n- count: 每页数量，建议保持默认值20。\n- offset: 翻页游标，第一次请求时为0，第二次请求时从上一次请求的返回响应中获取，一般这个值的关键字为offset或者cursor。\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- cookie: 用户cookie(如果你需要使用自己的账号搜索，或者遇到接口报错，可以自行提供cookie，默认不需要提供)\n### 返回:\n- 视频列表\n\n# [English]\n### Purpose:\n- Search photo\n### Parameters:\n- keyword: Search keyword\n- count: Number per page, it is recommended to keep the default value 20.\n- offset: Page cursor, 0 for the first request, need to provide for the second paging, generally the keyword of this value is offset or cursor.\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"20240828035554C02011379EBB6A00E00B\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n- offset: Page cursor\n- cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)\n### Return:\n- Video list\n\n# [示例/Example]\nkeyword = \"TikTok\"\ncount = 20\noffset = 0\nsearch_id = \"\"","operationId":"fetch_search_photo_api_v1_tiktok_web_fetch_search_photo_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"TikTok"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page offset","default":0,"title":"Offset"},"description":"翻页游标/Page offset"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户cookie(按需提供)/User cookie(if needed)","title":"Cookie"},"description":"用户cookie(按需提供)/User cookie(if needed)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_tag_detail":{"get":{"tags":["TikTok-Web-API"],"summary":"Tag详情/Tag Detail","description":"# [中文]\n### 用途:\n- Tag详情\n### 参数:\n- tag_name: Tag名称\n### 返回:\n- Tag详情\n\n# [English]\n### Purpose:\n- Tag Detail\n### Parameters:\n- tag_name: Tag name\n### Return:\n- Tag Detail\n\n# [示例/Example]\ntag_name = \"tiktok\"","operationId":"fetch_tag_detail_api_v1_tiktok_web_fetch_tag_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"tag_name","in":"query","required":true,"schema":{"type":"string","description":"Tag名称/Tag name","title":"Tag Name"},"description":"Tag名称/Tag name","example":"tiktok"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_tag_post":{"get":{"tags":["TikTok-Web-API"],"summary":"Tag作品/Tag Post","description":"# [中文]\n### 用途:\n- Tag作品\n### 参数:\n- challengeID: Tag ID\n- count: 每页数量\n- cursor: 翻页游标\n### 返回:\n- Tag作品\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Tag Post\n### Parameters:\n- challengeID: Tag ID\n- count: Number per page\n- cursor: Page cursor\n### Return:\n- Tag Post\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nchallengeID = \"7551\"\ncount = 30\ncursor = 0","operationId":"fetch_tag_post_api_v1_tiktok_web_fetch_tag_post_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"challengeID","in":"query","required":true,"schema":{"type":"string","description":"Tag ID","title":"Challengeid"},"description":"Tag ID","example":"7551"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":30,"title":"Count"},"description":"每页数量/Number per page"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"翻页游标/Page cursor","default":0,"title":"Cursor"},"description":"翻页游标/Page cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_home_feed":{"post":{"tags":["TikTok-Web-API"],"summary":"首页推荐作品/Home Feed","description":"# [中文]\n### 用途:\n- 首页推荐作品\n### 参数:\n- count: 每页数量\n- cookie: 用户自己的cookie，可选参数，用于接口返回数据的个性化推荐。\n### 返回:\n- 首页推荐作品\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Home Feed\n### Parameters:\n- count: Number per page\n- cookie: User's own cookie, optional parameter, used for personalized recommendations of interface return data.\n### Return:\n- Home Feed\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\ncount = 15\nCookie = \"Your_Cookie\"","operationId":"fetch_home_feed_api_v1_tiktok_web_fetch_home_feed_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_home_feed_api_v1_tiktok_web_fetch_home_feed_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/generate_real_msToken":{"get":{"tags":["TikTok-Web-API"],"summary":"生成真实msToken/Generate real msToken","description":"# [中文]\n### 用途:\n- 生成真实msToken\n### 参数:\n- random_strData: 是否使用随机化的浏览器指纹数据（推荐开启以提高反爬虫能力）\n- browser_type: 指定浏览器类型，可选值:\n    - chrome_windows: Chrome + Windows\n    - chrome_mac: Chrome + macOS\n    - firefox_windows: Firefox + Windows\n    - firefox_mac: Firefox + macOS\n    - 不传则随机选择\n### 返回:\n- 真实msToken\n\n# [English]\n### Purpose:\n- Generate real msToken\n### Parameters:\n- random_strData: Whether to use randomized browser fingerprint data (recommended for better anti-bot)\n- browser_type: Specify browser type, options:\n    - chrome_windows: Chrome + Windows\n    - chrome_mac: Chrome + macOS\n    - firefox_windows: Firefox + Windows\n    - firefox_mac: Firefox + macOS\n    - Leave empty for random selection\n### Return:\n- Real msToken","operationId":"generate_real_msToken_api_v1_tiktok_web_generate_real_msToken_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"random_strData","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Random Strdata"}},{"name":"browser_type","in":"query","required":false,"schema":{"type":"string","title":"Browser Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/encrypt_strData":{"get":{"tags":["TikTok-Web-API"],"summary":"加密strData/Encrypt strData","description":"# [中文]\n### 用途:\n- 加密strData指纹数据，用于生成msToken请求\n### 参数:\n- data: 原始指纹数据字符串（请先将JSON格式然后转换成字符串进行请求）\n### 返回:\n- 加密后的strData\n\n# [English]\n### Purpose:\n- Encrypt strData fingerprint data for msToken request\n### Parameters:\n- data: Raw fingerprint data string (please convert JSON format to string before requesting)\n### Return:\n- Encrypted strData","operationId":"encrypt_strData_api_v1_tiktok_web_encrypt_strData_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"data","in":"query","required":true,"schema":{"type":"string","description":"原始指纹数据字符串（JSON格式或字典字符串）/Raw fingerprint data string (JSON format or dict string)","title":"Data"},"description":"原始指纹数据字符串（JSON格式或字典字符串）/Raw fingerprint data string (JSON format or dict string)","example":"{\"behavior\":{\"beResize\":[],\"beMotion\":[{\"ts\":1701069187299,\"x\":null,\"y\":null,\"z\":null},{\"ts\":1701069202902,\"x\":null,\"y\":null,\"z\":null}],\"bePaste\":[],\"beMouse\":[],\"beKeyboard\":[],\"beScroll\":[],\"beTouch\":[],\"beWheel\":[],\"windowState\":[{\"ts\":1701069186257,\"v\":1},{\"ts\":1701069186257,\"v\":1},{\"ts\":1701069186388,\"v\":2},{\"ts\":1701069186388,\"v\":2},{\"ts\":1701069186402,\"v\":1},{\"ts\":1701069186402,\"v\":1},{\"ts\":1701069200309,\"v\":2},{\"ts\":1701069200309,\"v\":2},{\"ts\":1701069201865,\"v\":1},{\"ts\":1701069201865,\"v\":1}],\"isTrusted\":1},\"wID\":{\"sdkVersion\":\"4.4.6\",\"scmVersion\":\"1.0.0.96\",\"msgType\":2,\"timestamp\":\"1701069221819\",\"aid\":368462,\"aidList\":[1988,368462],\"privacyMode\":516},\"custom\":{},\"window\":{\"location\":\"https://www.tiktok.com/@funnykittensttk/video/7293517029737352454?is_from_webapp=1&web_id=7260049563725497899\"},\"msgMeta\":{\"msgType\":2,\"msgSrcProp\":2,\"msgProtocol\":1,\"aid\":368462,\"aidList\":[1988,368462]}}"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/decrypt_strData":{"get":{"tags":["TikTok-Web-API"],"summary":"解密strData/Decrypt strData","description":"# [中文]\n### 用途:\n- 解密strData指纹数据，用于分析msToken请求中的指纹信息\n### 参数:\n- encrypted_data: 加密后的strData字符串，从浏览器自行抓包获取\n### 返回:\n- 解密后的原始指纹数据，包含浏览器指纹信息和环境信息等。\n\n# [English]\n### Purpose:\n- Decrypt strData fingerprint data to analyze fingerprint info in msToken request\n### Parameters:\n- encrypted_data: Encrypted strData string, obtained from browser packet capture\n### Return:\n- Decrypted raw fingerprint data, including browser fingerprint info and environment info, etc.","operationId":"decrypt_strData_api_v1_tiktok_web_decrypt_strData_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"encrypted_data","in":"query","required":true,"schema":{"type":"string","description":"加密后的strData字符串/Encrypted strData string","title":"Encrypted Data"},"description":"加密后的strData字符串/Encrypted strData string","example":"3BvqYbNXLLOcZehvxZVbjpAu7vq82RoWmFSJHLFwzDwJIZevE0AeilQfP55LridxmdGGjknoksqIsLqlMHMif0IFK/Br7JWqxOHnYuMwVCnttFc0Y4MFvdVWM5FECiEulJC0Dc+eeVsNSrFnAc9K7fazqdglyJgGLSfXIJmgyCvvQ4pg0u5HBVVugLSWs242X42fjoWymaUCLZJQo6vi6WLyuV7l5IC3Mg+lelr5xBQD6Q7hBIFEw8zzxJ1n2DyA4xLbOHTQdKvEtsK7XzyWwjpRnojPTbBl69Zosnuru+lOBIl+tFu/+hCQ1m0jYZwTP4rVE75L3Du6+KZ5v/9TyFYjq7y3y9bGLP4d7yQueJbF90G1yrZ6htElrZ2vqZKDrIqBVbmOZr/nph12k2JKrITtN0R/pMsp0sJ4gesQnXxcD/pLOFAINHk7umgbe6LzJ7+TLUdGuO4M7xiEg/jCqhjgJX1izZ4NPoBDp35zRxj6Y6OrcstlTN/cv5sz663+Nco/mEwhGq2VwrL4gAIAPycndIsb48dPdtngmLqNDNN0ZyVRjgqVIDXXrxigXCkR9CH89Dlrrb7QQqWVgRXz9/k5ihEM43BR3sd3mMU/XgFLN1Aoxf6GzzdxP2QPBI75/ZoHoAmu54v8gTmA3ntCGlEF0zgaFGTdpkGdb+oZgyQM4pw1aAyxmFINXkpD3IKKoGev9kD9gTFnhiQMGCMemhZS7ZYdbuGu0Cb+lQKaL/QTt80FMyGmW8kzVy9xW/ja9BcdEJYRoaufuFRkBFG5ay8x4WHLR6hEapXqQial/cREbLL4sQytpjtmnndFqvT7xN5DhgsLY2Z7451MJhD6NJXKNrMafGZSbItzQWY="}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/generate_fingerprint":{"get":{"tags":["TikTok-Web-API"],"summary":"生成浏览器指纹/Generate browser fingerprint","description":"# [中文]\n### 用途:\n- 生成随机浏览器指纹数据，可用于自定义msToken请求\n### 参数:\n- browser_type: 指定浏览器类型，可选值:\n    - chrome_windows: Chrome + Windows\n    - chrome_mac: Chrome + macOS\n    - firefox_windows: Firefox + Windows\n    - firefox_mac: Firefox + macOS\n    - 不传则随机选择\n### 返回:\n- 浏览器指纹数据\n\n# [English]\n### Purpose:\n- Generate random browser fingerprint data for custom msToken request\n### Parameters:\n- browser_type: Specify browser type, options:\n    - chrome_windows: Chrome + Windows\n    - chrome_mac: Chrome + macOS\n    - firefox_windows: Firefox + Windows\n    - firefox_mac: Firefox + macOS\n    - Leave empty for random selection\n### Return:\n- Browser fingerprint data","operationId":"generate_fingerprint_api_v1_tiktok_web_generate_fingerprint_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"browser_type","in":"query","required":false,"schema":{"type":"string","title":"Browser Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/generate_webid":{"get":{"tags":["TikTok-Web-API"],"summary":"生成web_id/Generate web_id","description":"# [中文]\n### 用途:\n- 生成 TikTok web_id （Web接口请求参数中的device_id）\n### 参数:\n- cookie: 自定义 cookie（需包含 odin_tt），如不传则使用随机生成的游客Cookie值\n- user_agent: 用户代理字符串\n- url: 请求来源 URL\n- referer: 来源页面\n- user_unique_id: 用户唯一 ID（可选）\n- app_id: 应用 ID，默认 1988，代表 TikTok Web 应用\n### 返回:\n- web_id: 生成的 web_id\n- e: 错误码 (0 表示成功)\n- ssid: 会话 ID\n\n# [English]\n### Purpose:\n- Generate TikTok web_id (device_id in Web API request parameters)\n### Parameters:\n- cookie: Custom cookie (must contain odin_tt), uses default if not provided\n- user_agent: User agent string\n- url: Request source URL\n- referer: Referrer page\n- user_unique_id: User unique ID (optional)\n- app_id: Application ID, default 1988, represents TikTok Web app\n### Return:\n- web_id: Generated web_id\n- e: Error code (0 means success)\n- ssid: Session ID","operationId":"generate_webid_api_v1_tiktok_web_generate_webid_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cookie","in":"query","required":false,"schema":{"type":"string","title":"Cookie"}},{"name":"user_agent","in":"query","required":false,"schema":{"type":"string","default":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:145.0) Gecko/20100101 Firefox/145.0","title":"User Agent"}},{"name":"url","in":"query","required":false,"schema":{"type":"string","default":"https://www.tiktok.com/explore","title":"Url"}},{"name":"referer","in":"query","required":false,"schema":{"type":"string","default":"","title":"Referer"}},{"name":"user_unique_id","in":"query","required":false,"schema":{"type":"string","default":"","title":"User Unique Id"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"integer","default":1988,"title":"App Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/generate_ttwid":{"get":{"tags":["TikTok-Web-API"],"summary":"生成ttwid/Generate ttwid","description":"# [中文]\n### 用途:\n- 生成ttwid\n### 参数:\n- 无\n### 返回:\n- ttwid\n\n# [English]\n### Purpose:\n- Generate ttwid\n### Parameters:\n- None\n### Return:\n- ttwid","operationId":"generate_ttwid_api_v1_tiktok_web_generate_ttwid_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_agent","in":"query","required":false,"schema":{"type":"string","default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:125.0) Gecko/20100101 Firefox/125.0","title":"User Agent"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/generate_xbogus":{"post":{"tags":["TikTok-Web-API"],"summary":"生成 XBogus/Generate XBogus","description":"# [中文]\n### 用途:\n- 生成xbogus\n### 参数:\n- url: 未签名的API URL\n- user_agent: 用户浏览器User-Agent\n### 返回:\n- xbogus\n\n# [English]\n### Purpose:\n- Generate xbogus\n### Parameters:\n- url: Unsigned API URL\n- user_agent: User browser User-Agent\n### Return:\n- xbogus\n\n# [示例/Example]\n\n```json\n{\n    \"url\": \"https://www.tiktok.com/aweme/v1/web/aweme/detail/?aweme_id=7148736076176215311&device_platform=webapp&aid=6383&channel=channel_pc_web&pc_client_type=1&version_code=170400&version_name=17.4.0&cookie_enabled=true&screen_width=1920&screen_height=1080&browser_language=zh-CN&browser_platform=Win32&browser_name=Edge&browser_version=117.0.2045.47&browser_online=true&engine_name=Blink&engine_version=117.0.0.0&os_name=Windows&os_version=10&cpu_core_num=128&device_memory=10240&platform=PC&downlink=10&effective_type=4g&round_trip_time=100\",\n    \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36\"\n}","operationId":"generate_xbogus_api_v1_tiktok_web_generate_xbogus_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XBogusModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/generate_xgnarly":{"post":{"tags":["TikTok-Web-API"],"summary":"生成 XGnarly /Generate XGnarly","description":"# [中文]\n### 用途:\n- 生成 XGnarly 加密，用于 TikTok Web API 请求\n- 此接口使用最新版本（V5.2.0，截至2026年3月）的签名服务，不可自定义 User-Agent，会自动生成一个常见浏览器的 User-Agent\n- 此接口为完美还原算法，无视除验证码外的一切风控\n### 参数:\n- url (str): 不携带签名（X-Bogus 或 X-Gnarly）并且包含域名的请求URL，不需要进行URL编码\n- body (str): 请求的API参数，适用于POST请求，如果是GET请求则不需要提供\n### 返回:\n- X-Gnarly 加密字符串 + 随机浏览器的 User-Agent\n\n# [English]\n### Purpose:\n- Generate XGnarly encryption, used for TikTok Web API requests\n- This interface uses the latest version (V5.2.0, as of March 2026) signing service, User-Agent cannot be customized, a common browser User-Agent will be automatically generated\n- This interface perfectly restores the algorithm, ignores all risk controls except for verification codes\n### Parameters:\n- url (str): The requested API URL without signature (X-Bogus or X-Gnarly) and including the domain name, no need to URL encode\n- body (str): The API parameters of the request, applicable for POST requests, not required for GET requests\n### Return:\n- X-Gnarly encryption string + User-Agent of a random browser\n\n# [示例/Example]\n\n```json\n{\n    \"url\": \"https://www.tiktok.com/api/search/user/full/?WebIdLastTime=1756087650&aid=1988&app_language=zh-Hans&app_name=tiktok_web&browser_language=zh-CN&browser_name=Mozilla&browser_online=true&browser_platform=MacIntel&browser_version=5.0%20%28Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F139.0.0.0%20Safari%2F537.36&channel=tiktok_web&cookie_enabled=true&cursor=10&data_collection_enabled=false&device_id=7542339104672111234&device_platform=web_pc&focus_state=true&from_page=search&history_len=3&is_fullscreen=true&is_page_visible=true&keyword=musk&odinId=7542338997269211234&os=mac&priority_region&referer&region=US&screen_height=967&screen_width=1496&search_id&tz_name=America%2FLos_Angeles&user_is_login=false&web_search_code=%7B%22tiktok%22%3A%7B%22client_params_x%22%3A%7B%22search_engine%22%3A%7B%22ies_mt_user_live_video_card_use_libra%22%3A1%2C%22mt_search_general_user_live_card%22%3A1%7D%7D%2C%22search_server%22%3A%7B%7D%7D%7D&webcast_language=zh-Hans\",\n    \"body\": \"\"\n}","operationId":"generate_xgnarly_api_v1_tiktok_web_generate_xgnarly_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XGnarlyAndXBogusModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/generate_xgnarly_and_xbogus":{"post":{"tags":["TikTok-Web-API"],"summary":"生成 XGnarly 和 XBogus /Generate XGnarly and XBogus","description":"# [中文]\n### 用途:\n- 生成 XGnarly 和 XBogus 加密，用于 TikTok Web API 请求\n- 用这个接口可以生成最新版本的加密参数 X-Bogus 和 X-Gnarly，不可自定义 User-Agent，会自动生成一个常见浏览器的 User-Agent\n- 此接口为完美还原算法，无视除验证码外的一切风控，可以用于爬取商品，价格：0.005 美金/次\n- 本接口生成的 X-Bogus 和 X-Gnarly 均为最新版本（V5.2.0，截至2026年3月）\n### 参数:\n- url (str): 不携带签名（X-Bogus 或 X-Gnarly）并且包含域名的请求URL，不需要进行URL编码\n- body (str): 请求的API参数，适用于POST请求，如果是GET请求则不需要提供\n### 返回:\n- 最新版本的 X-Gnarly 加密 + 最新版本的 X-Bogus 加密 + 随机浏览器的 User-Agent\n\n# [English]\n### Purpose:\n- Generate XGnarly and XBogus encryption, used for TikTok Web API requests\n- This interface can generate the latest version of encryption parameters X-Bogus and X-Gnarly, User-Agent cannot be customized, a common browser User-Agent will be automatically generated\n- This interface perfectly restores the algorithm, ignores all risk controls except for verification codes, and can be used to crawl products, price: $0.005/time\n- The X-Bogus and X-Gnarly generated by this interface are the latest versions (V5.2.0, as of March 2026)\n### Parameters:\n- url (str): The requested API URL without signature (X-Bogus or X-Gnarly) and including the domain name, no need to URL encode\n- body (str): The API parameters of the request, applicable for POST requests, not required for GET requests\n### Return:\n- The latest version of X-Gnarly encryption + the latest version of X-Bogus encryption + User-Agent of a random browser\n\n# [示例/Example]\n\n```json\n{\n    \"url\": \"https://www.tiktok.com/api/search/user/full/?WebIdLastTime=1756087650&aid=1988&app_language=zh-Hans&app_name=tiktok_web&browser_language=zh-CN&browser_name=Mozilla&browser_online=true&browser_platform=MacIntel&browser_version=5.0%20%28Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F139.0.0.0%20Safari%2F537.36&channel=tiktok_web&cookie_enabled=true&cursor=10&data_collection_enabled=false&device_id=7542339104672111234&device_platform=web_pc&focus_state=true&from_page=search&history_len=3&is_fullscreen=true&is_page_visible=true&keyword=musk&odinId=7542338997269211234&os=mac&priority_region&referer&region=US&screen_height=967&screen_width=1496&search_id&tz_name=America%2FLos_Angeles&user_is_login=false&web_search_code=%7B%22tiktok%22%3A%7B%22client_params_x%22%3A%7B%22search_engine%22%3A%7B%22ies_mt_user_live_video_card_use_libra%22%3A1%2C%22mt_search_general_user_live_card%22%3A1%7D%7D%2C%22search_server%22%3A%7B%7D%7D%7D&webcast_language=zh-Hans\",\n    \"body\": \"\"\n}","operationId":"generate_xgnarly_and_xbogus_api_v1_tiktok_web_generate_xgnarly_and_xbogus_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XGnarlyAndXBogusModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/generate_x_mssdk_info":{"post":{"tags":["TikTok-Web-API"],"summary":"生成 X-Mssdk-Info /Generate X-Mssdk-Info","description":"# [中文]\n### 用途:\n- 生成 X-Mssdk-Info 和 X-Mssdk-RC，用于 TikTok Web 设备注册、登录等场景\n### 参数:\n- user_agent (str, 可选): 用户代理字符串，目前不支持自定义，默认为固定的值\n### 返回:\n- X-Mssdk-Info: 生成的签名信息\n- X-Mssdk-RC: 生成的 RC 值\n- user_agent: 使用的用户代理字符串\n- version: 签名使用的 webmssdk 版本\n\n# [English]\n### Purpose:\n- Generate X-Mssdk-Info and X-Mssdk-RC, used for TikTok Web device registration, login, and other scenarios\n### Parameters:\n- user_agent (str, optional): User-Agent string, currently not supported for customization, defaults to a fixed value\n### Return:\n- X-Mssdk-Info: Generated signing information\n- X-Mssdk-RC: Generated RC value\n- user_agent: The User-Agent string used\n- version: The webmssdk version used for signing\n\n# [示例/Example]\n\n```json\n{\n    \"user_agent\": null\n}\n```","operationId":"generate_x_mssdk_info_api_v1_tiktok_web_generate_x_mssdk_info_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XMssdkInfoModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/get_user_id":{"get":{"tags":["TikTok-Web-API"],"summary":"提取用户user_id/Extract user user_id","description":"# [中文]\n### 用途:\n- 提取用户user_id\n### 参数:\n- url: 用户主页链接\n### 返回:\n- 用户id\n\n# [English]\n### Purpose:\n- Extract list user id\n### Parameters:\n- url: User homepage link\n### Return:\n- User id\n\n# [示例/Example]\nurl = \"https://www.tiktok.com/@tiktok\"","operationId":"get_user_id_api_v1_tiktok_web_get_user_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"用户主页链接/User homepage link","title":"Url"},"description":"用户主页链接/User homepage link","example":"https://www.tiktok.com/@tiktok"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/get_sec_user_id":{"get":{"tags":["TikTok-Web-API"],"summary":"提取用户sec_user_id/Extract user sec_user_id","description":"# [中文]\n### 用途:\n- 提取列表用户id\n### 参数:\n- url: 用户主页链接\n### 返回:\n- 用户id\n\n# [English]\n### Purpose:\n- Extract list user id\n### Parameters:\n- url: User homepage link\n### Return:\n- User id\n\n# [示例/Example]\nurl = \"https://www.tiktok.com/@tiktok\"","operationId":"get_sec_user_id_api_v1_tiktok_web_get_sec_user_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"用户主页链接/User homepage link","title":"Url"},"description":"用户主页链接/User homepage link","example":"https://www.tiktok.com/@tiktok"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/get_all_sec_user_id":{"post":{"tags":["TikTok-Web-API"],"summary":"提取列表用户sec_user_id/Extract list user sec_user_id","description":"# [中文]\n### 用途:\n- 提取列表用户id\n### 参数:\n- url: 用户主页链接（最多支持10个链接）、\n### 返回:\n- 如果链接成功获取到sec_user_id，则返回sec_user_id，否则返回原始的输入链接，后续可以手动校验链接无法获取sec_user_id的原因。\n\n# [English]\n### Purpose:\n- Extract list user id\n### Parameters:\n- url: User homepage link (Support up to 10 links)\n### Return:\n- If the sec_user_id is successfully obtained, the sec_user_id is returned, otherwise the original input link is returned, and the reason why the sec_user_id cannot be obtained can be manually verified later.\n\n# [示例/Example]\nurl = [\"https://www.tiktok.com/@tiktok\"]","operationId":"get_all_sec_user_id_api_v1_tiktok_web_get_all_sec_user_id_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Url","description":"用户主页链接/User homepage link"},"example":["https://www.tiktok.com/@tiktok"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/get_aweme_id":{"get":{"tags":["TikTok-Web-API"],"summary":"提取单个作品id/Extract single video id","description":"# [中文]\n### 用途:\n- 提取单个作品id\n### 参数:\n- url: 作品链接\n### 返回:\n- 作品id\n\n# [English]\n### Purpose:\n- Extract single video id\n### Parameters:\n- url: Video link\n### Return:\n- Video id\n\n# [示例/Example]\nurl = \"https://www.tiktok.com/@owlcitymusic/video/7218694761253735723\"","operationId":"get_aweme_id_api_v1_tiktok_web_get_aweme_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"作品链接/Video link","title":"Url"},"description":"作品链接/Video link","example":"https://www.tiktok.com/@owlcitymusic/video/7218694761253735723"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/get_all_aweme_id":{"post":{"tags":["TikTok-Web-API"],"summary":"提取列表作品id/Extract list video id","description":"# [中文]\n### 用途:\n- 提取列表作品id\n### 参数:\n- url: 作品链接 (最多支持20个链接)\n### 返回:\n- 作品id\n\n# [English]\n### Purpose:\n- Extract list video id\n### Parameters:\n- url: Video link (Support up to 20 links)\n### Return:\n- Video id\n\n# [示例/Example]\nurl = [\"https://www.tiktok.com/@owlcitymusic/video/7218694761253735723\"]","operationId":"get_all_aweme_id_api_v1_tiktok_web_get_all_aweme_id_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Url","description":"作品链接/Video link"},"example":["https://www.tiktok.com/@owlcitymusic/video/7218694761253735723"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/get_unique_id":{"get":{"tags":["TikTok-Web-API"],"summary":"获取用户unique_id/Get user unique_id","description":"# [中文]\n### 用途:\n- 获取用户unique_id\n### 参数:\n- url: 用户主页链接\n### 返回:\n- unique_id\n\n# [English]\n### Purpose:\n- Get user unique_id\n### Parameters:\n- url: User homepage link\n### Return:\n- unique_id\n\n# [示例/Example]\nurl = \"https://www.tiktok.com/@tiktok\"","operationId":"get_unique_id_api_v1_tiktok_web_get_unique_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"用户主页链接/User homepage link","title":"Url"},"description":"用户主页链接/User homepage link","example":"https://www.tiktok.com/@tiktok"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/get_all_unique_id":{"post":{"tags":["TikTok-Web-API"],"summary":"获取列表unique_id/Get list unique_id","description":"# [中文]\n### 用途:\n- 获取列表unique_id\n### 参数:\n- url: 用户主页链接 (最多支持20个链接)\n### 返回:\n- unique_id\n\n# [English]\n### Purpose:\n- Get list unique_id\n### Parameters:\n- url: User homepage link (Support up to 20 links)\n### Return:\n- unique_id\n\n# [示例/Example]\nurl = [\"https://www.tiktok.com/@tiktok\"]","operationId":"get_all_unique_id_api_v1_tiktok_web_get_all_unique_id_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Url","description":"用户主页链接/User homepage link"},"example":["https://www.tiktok.com/@tiktok"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/tiktok_live_room":{"get":{"tags":["TikTok-Web-API"],"summary":"提取直播间弹幕/Extract live room danmaku","description":"# [中文]\n### 用途:\n- 提取直播间弹幕\n- 该接口已不再提供线上服务，需要自行购买源代码后在本地部署使用，购买源代码请在Discord服务器联系管理员，Discord邀请链接：https://discord.gg/aMEAS8Xsvz\n#### 价格:\n- 每10条数据消耗0.001$，支持阶梯式计费折扣。\n### 参数:\n- live_room_url: 直播间链接\n- danmaku_type: 消息类型\n    - WebcastChatMessage: 聊天消息\n    - WebcastMemberMessage: 成员消息\n    - WebcastRoomUserSeqMessage: 用户序列消息\n    - WebcastGiftMessage: 礼物消息\n    - WebcastSocialMessage: 社交消息\n    - WebcastLikeMessage: 点赞消息\n    - WebcastLinkMicFanTicketMethod: 连麦粉丝票方法\n    - WebcastLinkMicMethod: 连麦方法\n### 返回:\n- 弹幕数据的WebSocket连接信息，需要使用WebSocket连接获取弹幕数据，此接口不返回弹幕数据。\n\n# [English]\n### Purpose:\n- Extract live room danmaku\n- This interface is no longer available online, you need to purchase the source code and deploy it locally for use. To purchase the source code, please contact the administrator in the Discord server. Discord invite link: https://discord.gg/aMEAS8Xsvz\n#### Price:\n- 0.001$ per 10 data, support tiered billing discount.\n### Parameters:\n- live_room_url: Live room link\n- danmaku_type: Message type\n    - WebcastChatMessage: Chat message\n    - WebcastMemberMessage: Member message\n    - WebcastRoomUserSeqMessage: User sequence message\n    - WebcastGiftMessage: Gift message\n    - WebcastSocialMessage: Social message\n    - WebcastLikeMessage: Like message\n    - WebcastLinkMicFanTicketMethod: Link Mic Fan Ticket Method\n    - WebcastLinkMicMethod: Link Mic Method\n### Return:\n- WebSocket connection information of the danmaku data, you need to use WebSocket connection to get the danmaku data, this interface does not return the danmaku data.","operationId":"tiktok_live_room_api_v1_tiktok_web_tiktok_live_room_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"live_room_url","in":"query","required":true,"schema":{"type":"string","description":"直播间链接/Live room link","title":"Live Room Url"},"description":"直播间链接/Live room link","example":"https://www.tiktok.com/@mpl.id.official/live"},{"name":"danmaku_type","in":"query","required":true,"schema":{"type":"string","description":"消息类型/Message type","title":"Danmaku Type"},"description":"消息类型/Message type","example":"WebcastChatMessage"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_live_im_fetch":{"get":{"tags":["TikTok-Web-API"],"summary":"TikTok直播间弹幕参数获取/tiktok live room danmaku parameters","description":"# [中文]\n### 用途:\n- TikTok直播间弹幕参数获取\n### 参数:\n- room_id: 直播间号\n- user_unique_id: 用户唯一ID\n\n### 返回:\n- 弹幕参数数据\n\n# [English]\n### Purpose:\n- TikTok live room danmaku parameters\n### Parameters:\n- room_id: Live room id\n- user_unique_id: User unique ID\n\n### Return:\n- Danmaku parameter data","operationId":"fetch_live_im_fetch_api_v1_tiktok_web_fetch_live_im_fetch_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间号/Live room id","title":"Room Id"},"description":"直播间号/Live room id","example":"7382517534467115826"},{"name":"user_unique_id","in":"query","required":true,"schema":{"type":"string","description":"用户唯一ID/User unique ID","title":"User Unique Id"},"description":"用户唯一ID/User unique ID","example":"7382524529011246630"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/get_live_room_id":{"get":{"tags":["TikTok-Web-API"],"summary":"根据直播间链接提取直播间ID/Extract live room ID from live room link","description":"# [中文]\n### 用途:\n- 根据直播间链接提取直播间Room ID\n- 支持短链接，如：https://vt.tiktok.com/ZSjuyJnWQ/\n- 支持长链接，如：https://www.tiktok.com/@maksukaracun/live\n### 参数:\n- live_room_url: 直播间链接\n### 返回:\n- 直播间Room ID\n\n# [English]\n### Purpose:\n- Extract live room Room ID from live room link\n- Support short links, such as: https://vt.tiktok.com/ZSjuyJnWQ/\n- Support long links, such as: https://www.tiktok.com/@maksukaracun/live\n### Parameters:\n- live_room_url: Live room link\n### Return:\n- Live room Room ID\n\n# [示例/Example]\nlive_room_url = \"https://www.tiktok.com/@maksukaracun/live\"","operationId":"get_live_room_id_api_v1_tiktok_web_get_live_room_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"live_room_url","in":"query","required":true,"schema":{"type":"string","description":"直播间链接/Live room link","title":"Live Room Url"},"description":"直播间链接/Live room link","example":"https://www.tiktok.com/@maksukaracun/live"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_check_live_alive":{"get":{"tags":["TikTok-Web-API"],"summary":"直播间开播状态检测/Live room start status check","description":"# [中文]\n### 用途:\n- 直播间开播状态检测\n- 如果当前直播间不存在或已下播，则返回空。\n### 参数:\n- room_id: 直播间ID\n### 返回:\n- 直播间开播状态\n\n# [English]\n### Purpose:\n- Live room start status check\n- If the current live room does not exist or has ended, it will return empty.\n### Parameters:\n- room_id: Live room ID\n### Return:\n- Live room start status\n\n# [示例/Example]\nroom_id = \"7381444193462078214\"","operationId":"fetch_check_live_alive_api_v1_tiktok_web_fetch_check_live_alive_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间ID/Live room ID","title":"Room Id"},"description":"直播间ID/Live room ID","example":"7381444193462078214"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_batch_check_live_alive":{"get":{"tags":["TikTok-Web-API"],"summary":"批量直播间开播状态检测/Batch live room start status check","description":"# [中文]\n### 用途:\n- 批量直播间开播状态检测\n- 最多支持50个直播间同时查询\n- 如果某个直播间不存在或已下播，则对应位置返回空或null。\n### 参数:\n- room_ids: 直播间ID列表，用英文逗号分隔，如：7530611486784277278,7530633767468288782\n### 返回:\n- 批量直播间开播状态列表\n### 价格:\n- 定价0.025$，请尽量达到50个直播间查询，避免浪费API调用次数。\n### 说明:\n- 同一个room_id不会重复返回开播状态。\n\n# [English]\n### Purpose:\n- Batch live room start status check\n- Support up to 50 live rooms query at once\n- If a live room does not exist or has ended, the corresponding position will return empty or null.\n### Parameters:\n- room_ids: Live room ID list separated by commas, e.g.: 7530611486784277278,7530633767468288782\n### Return:\n- Batch live room start status list\n### Price:\n- Charged by the number of live rooms queried, 0.025$ per live room, please try to query 50 live rooms to avoid wasting API call counts.\n### Note:\n- The same room_id will not return the start status repeatedly.\n\n# [示例/Example]\nroom_ids = \"7530611486784277278,7530633767468288782,7530636465034775310,7530604930088848142\"","operationId":"fetch_batch_check_live_alive_api_v1_tiktok_web_fetch_batch_check_live_alive_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_ids","in":"query","required":true,"schema":{"type":"string","description":"直播间ID列表，用英文逗号分隔，最多支持50个/Live room ID list separated by commas, up to 50 IDs","title":"Room Ids"},"description":"直播间ID列表，用英文逗号分隔，最多支持50个/Live room ID list separated by commas, up to 50 IDs","example":"7530611486784277278,7530633767468288782,7530636465034775310,7530604930088848142"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_tiktok_live_data":{"get":{"tags":["TikTok-Web-API"],"summary":"通过直播链接获取直播间信息/Get live room information via live link","description":"# [中文]\n### 用途:\n- 通过直播链接获取直播间信息\n- 此接口可获取离线直播间信息\n### 参数:\n- live_room_url: 直播间链接\n### 返回:\n- 直播间信息\n\n# [English]\n### Purpose:\n- Get live room information via live link\n- This interface can get offline live room information\n### Parameters:\n- live_room_url: Live room link\n### Return:\n- Live room information\n\n# [示例/Example]\nlive_room_url = \"https://www.tiktok.com/@.caseoh_daily/live\"","operationId":"fetch_tiktok_live_data_api_v1_tiktok_web_fetch_tiktok_live_data_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"live_room_url","in":"query","required":true,"schema":{"type":"string","description":"直播间链接/Live room link","title":"Live Room Url"},"description":"直播间链接/Live room link","example":"https://www.tiktok.com/@.caseoh_daily/live"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_live_recommend":{"get":{"tags":["TikTok-Web-API"],"summary":"获取直播间首页推荐列表/Get live room homepage recommendation list","description":"# [中文]\n### 用途:\n- 获取直播间首页推荐列表\n### 参数:\n- related_live_tag: 相关直播标签\n### 返回:\n- 直播间首页推荐列表\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get live room homepage recommendation list\n### Parameters:\n- related_live_tag: Related live tag\n### Return:\n- Live room homepage recommendation list\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nrelated_live_tag = \"VALORANT\"","operationId":"fetch_live_recommend_api_v1_tiktok_web_fetch_live_recommend_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"related_live_tag","in":"query","required":true,"schema":{"type":"string","description":"相关直播标签/Related live tag","title":"Related Live Tag"},"description":"相关直播标签/Related live tag","example":"VALORANT"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_live_gift_list":{"get":{"tags":["TikTok-Web-API"],"summary":"获取直播间礼物列表/Get live room gift list","description":"# [中文]\n### 用途:\n- 获取直播间礼物列表\n- room_id为可选参数，不传则获取通用礼物列表（2025年08月15日统计是256种礼物）\n### 参数:\n- room_id: 直播间ID（可选）\n### 返回:\n- 直播间礼物列表数据\n### 备注:\n- 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问，否则会返回HTTP403错误。\n- 在访问视频CDN链接时，请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。\n- **如果访问视频CDN链接时返回HTTP 403错误**:\n  1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)\n  2. 在请求该链接时，务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`，其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值\n  3. 示例请求头: `Cookie: tt_chain_token=xxx`\n- 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接，请使用 TikTok APP V3 目录下的接口。\n\n# [English]\n### Purpose:\n- Get live room gift list\n- room_id is optional parameter, if not provided, will get general gift list (as of August 15, 2025, there are 256 types of gifts)\n### Parameters:\n- room_id: Live room ID (optional)\n### Return:\n- Live room gift list data\n### Note:\n- All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.\n- When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.\n- **If you receive HTTP 403 error when accessing video CDN links**:\n  1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)\n  2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API\n  3. Example request header: `Cookie: tt_chain_token=xxx`\n- If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.\n\n# [示例/Example]\nroom_id = \"7381444193462078214\"  # 可选/Optional","operationId":"fetch_live_gift_list_api_v1_tiktok_web_fetch_live_gift_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":false,"schema":{"type":"string","description":"直播间ID，可选参数/Live room ID, optional parameter","default":"","title":"Room Id"},"description":"直播间ID，可选参数/Live room ID, optional parameter","example":"7381444193462078214"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_sso_login_qrcode":{"get":{"tags":["TikTok-Web-API"],"summary":"获取SSO登录二维码/Get SSO login QR code","description":"# [中文]\n### 用途:\n- 获取SSO登录二维码\n### 参数:\n- device_id: 设备ID\n- region: 地区\n- proxy: 代理\n### 返回:\n- SSO登录二维码\n### 说明:\n- 该接口返回的二维码需要使用手机扫描登录，登录成功后会返回登录信息。\n- 不传入设备ID将由后端自动生成设备ID。\n- 如果需要使用代理，请传入代理地址，否则传入None。\n- 单次二维码有效期为一分钟。\n\n# [English]\n### Purpose:\n- Get SSO login QR code\n### Parameters:\n- device_id: Device ID\n- region: Region\n- proxy: Proxy\n### Return:\n- SSO login QR code\n### Description:\n- The QR code returned by this interface needs to be scanned by the mobile phone for login, and the login information will be returned after successful login.\n- If the device ID is not passed in, the device ID will be automatically generated by the backend.\n- If you need to use a proxy, please pass in the proxy address, otherwise pass in None\n- The validity period of a single QR code is one minute.\n\n# [示例/Example]\ndevice_id = \"7481276116461831688\"\nregion = \"US\"\nproxy = \"None\"","operationId":"fetch_sso_login_qrcode_api_v1_tiktok_web_fetch_sso_login_qrcode_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"device_id","in":"query","required":true,"schema":{"type":"string","description":"设备ID/Device ID","title":"Device Id"},"description":"设备ID/Device ID","example":"7481276116461831688"},{"name":"region","in":"query","required":true,"schema":{"type":"string","description":"地区/Region","title":"Region"},"description":"地区/Region","example":"US"},{"name":"proxy","in":"query","required":true,"schema":{"type":"string","description":"代理/Proxy","title":"Proxy"},"description":"代理/Proxy","example":"None"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_sso_login_status":{"get":{"tags":["TikTok-Web-API"],"summary":"获取SSO登录状态/Get SSO login status","description":"# [中文]\n### 用途:\n- 获取SSO登录状态\n### 参数:\n- token: 登录令牌\n- device_id: 设备ID\n- verifyFp: verifyFp\n- region: 地区\n- proxy: 代理\n### 返回:\n- SSO登录状态\n### 说明:\n- 该接口返回的登录状态需要轮询，建议2秒轮询一次。\n- 请使用/fetch_sso_login_qrcode接口获取的值进行传入。\n- 如果需要使用代理，请传入代理地址，否则传入None。\n- 扫码状态：\n    - new: 未扫码\n    - expired: 二维码过期（需要重新请求/fetch_sso_login_qrcode）\n    - scanned: 已扫码\n    - confirmed: 已确认登录（需要请求/fetch_sso_login_auth认证）\n\n# [English]\n### Purpose:\n- Get SSO login status\n### Parameters:\n- token: Login token\n- device_id: Device ID\n- verifyFp: verifyFp\n- region: Region\n- proxy: Proxy\n### Return:\n- SSO login status\n### Description:\n- The login status returned by this interface needs to be polled, and it is recommended to poll once every 2 seconds.\n- Please use the value obtained by the /fetch_sso_login_qrcode interface for input.\n- If you need to use a proxy, please pass in the proxy address, otherwise pass in None.\n- Scan status:\n    - new: Not scanned\n    - expired: QR code expired (need to request /fetch_sso_login_qrcode again)\n    - scanned: Scanned\n    - confirmed: Confirmed login (need to request /fetch_sso_login_auth for authentication\n\n# [示例/Example]\ntoken = \"jiHRabSoJdwNrsvJvlRKj4hecTstR2xsn2NmtmKMN8o=_useast5\"\ndevice_id = \"7481276116461831688\"\nverifyFp = \"verify_m8909xlr_d7UEdRqf_mA73_4So4_B0RT_L1gFyzsKr7IL\"\nregion = \"US\"\nproxy = \"None\"","operationId":"fetch_sso_login_status_api_v1_tiktok_web_fetch_sso_login_status_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string","description":"登录令牌/Login token","title":"Token"},"description":"登录令牌/Login token","example":"jiHRabSoJdwNrsvJvlRKj4hecTstR2xsn2NmtmKMN8o=_useast5"},{"name":"device_id","in":"query","required":true,"schema":{"type":"string","description":"设备ID/Device ID","title":"Device Id"},"description":"设备ID/Device ID","example":"7481276116461831688"},{"name":"verifyFp","in":"query","required":true,"schema":{"type":"string","description":"verifyFp","title":"Verifyfp"},"description":"verifyFp","example":"verify_m8909xlr_d7UEdRqf_mA73_4So4_B0RT_L1gFyzsKr7IL"},{"name":"region","in":"query","required":true,"schema":{"type":"string","description":"地区/Region","title":"Region"},"description":"地区/Region","example":"US"},{"name":"proxy","in":"query","required":true,"schema":{"type":"string","description":"代理/Proxy","title":"Proxy"},"description":"代理/Proxy","example":"None"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_sso_login_auth":{"get":{"tags":["TikTok-Web-API"],"summary":"认证SSO登录/Authenticate SSO login","description":"# [中文]\n### 用途:\n- 认证SSO登录\n### 参数:\n- device_id: 设备ID\n- verifyFp: verifyFp\n- region: 地区\n- proxy: 代理\n### 返回:\n- SSO登录认证信息\n### 说明:\n- 认证需要保持参数一致，否则会认证失败。\n\n# [English]\n### Purpose:\n- Authenticate SSO login\n### Parameters:\n- token: Login token\n- device_id: Device ID\n- verifyFp: verifyFp\n- region: Region\n- proxy: Proxy\n### Return:\n- SSO login authentication information\n### Description:\n- Please use the value obtained by the /fetch_sso_login_status interface for input.\n- If you need to use a proxy, please pass in the proxy address, otherwise pass in None.\n\n# [示例/Example]\ndevice_id = \"7481276116461831688\"\nverifyFp = \"verify_m8909xlr_d7UEdRqf_mA73_4So4_B0RT_L1gFyzsKr7IL\"\nregion = \"US\"\nproxy = \"None\"","operationId":"fetch_sso_login_auth_api_v1_tiktok_web_fetch_sso_login_auth_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"device_id","in":"query","required":true,"schema":{"type":"string","description":"设备ID/Device ID","title":"Device Id"},"description":"设备ID/Device ID","example":"7481276116461831688"},{"name":"verifyFp","in":"query","required":true,"schema":{"type":"string","description":"verifyFp","title":"Verifyfp"},"description":"verifyFp","example":"verify_m8909xlr_d7UEdRqf_mA73_4So4_B0RT_L1gFyzsKr7IL"},{"name":"region","in":"query","required":true,"schema":{"type":"string","description":"地区/Region","title":"Region"},"description":"地区/Region","example":"US"},{"name":"proxy","in":"query","required":true,"schema":{"type":"string","description":"代理/Proxy","title":"Proxy"},"description":"代理/Proxy","example":"None"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/generate_hashed_id":{"get":{"tags":["TikTok-Web-API"],"summary":"生成哈希ID/Generate hashed ID","description":"# [中文]\n### 用途:\n- 生成TikTok Web的哈希ID\n### 参数:\n- email: 邮箱地址\n### 返回:\n- 生成的哈希ID字符串\n\n# [English]\n### Purpose:\n- Generate hashed ID for TikTok Web\n### Parameters:\n- email: Email address\n### Return:\n- Generated hashed ID string\n\n# [示例/Example]\nemail = \"test@example.com\"","operationId":"generate_hashed_id_api_v1_tiktok_web_generate_hashed_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"email","in":"query","required":true,"schema":{"type":"string","description":"邮箱地址/Email address","title":"Email"},"description":"邮箱地址/Email address","example":"test@example.com"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/fetch_gift_name_by_id":{"post":{"tags":["TikTok-Web-API"],"summary":"根据Gift ID查询礼物名称/Get gift name by gift ID","description":"根据TikTok的Gift ID查询对应的礼物名称 | Get gift name by TikTok gift ID","operationId":"fetch_gift_name_by_id_api_v1_tiktok_web_fetch_gift_name_by_id_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GiftQuery","description":"礼物查询参数 | Gift query parameters"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/fetch_gift_names_by_ids":{"post":{"tags":["TikTok-Web-API"],"summary":"批量查询Gift ID对应的礼物名称($0.025/次,建议50个)/Batch get gift names by gift IDs ($0.025/call, suggest 50)","description":"批量查询多个TikTok Gift ID对应的礼物名称。计费：$0.025每次调用。建议每次查询50个ID以获得最佳性价比，超过50个时自动处理前50个 | Batch get gift names by multiple TikTok gift IDs. Pricing: $0.025 per call. Recommend querying 50 IDs at once for best value, auto-process first 50 IDs if more than 50","operationId":"fetch_gift_names_by_ids_api_v1_tiktok_web_fetch_gift_names_by_ids_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchGiftQuery","description":"批量礼物查询参数。建议每次提交50个ID以获得最佳性价比($0.025/次) | Batch gift query parameters. Recommend 50 IDs per request for best value ($0.025/call)"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/web/fetch_tiktok_web_guest_cookie":{"get":{"tags":["TikTok-Web-API"],"summary":"获取游客 Cookie/Get the guest Cookie","description":"# [中文]\n### 用途:\n- 获取 TikTok Web的游客Cookie\n- 可以用于爬取 TikTok Web 的数据，如用户作品、合辑作品等。\n- 可以固定身份避免部分接口重复数据。\n- 请注意：游客Cookie无法爬取所有数据，有一定的限制。\n- 可以配合开源项目使用此接口实现TikTok Web的数据爬取。\n### 参数:\n- user_agent: 用户浏览器代理\n### 返回:\n- 游客Cookie\n\n# [English]\n### Purpose:\n- Get the guest Cookie of TikTok Web\n- Can be used to crawl data of TikTok Web, such as user videos, mix videos, etc.\n- Can fix identity to avoid duplicate data for some interfaces.\n- Please note: Guest Cookie cannot crawl all data, there are certain restrictions.\n- Can be used with open source projects to implement data crawling of TikTok Web using this interface.\n### Parameters:\n- user_agent: User browser agent\n### Return:\n- Guest Cookie\n\n# [示例/Example]\nuser_agent = \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36\"\n\n# [响应/Response]:\n```json\n{\n    \"User-Agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36\",\n    \"Cookie\": \"ttwid=1%7Ck5lqyYxAq2wSmaEculMCk31ur4lkvy3DVwn6Phf45GQ%7C1759321284%7C6bac9a25e1f6b512aecad91a37167ad753b47f2306ffe0d70695001d6b4dd793;tt_csrf_token=tueWm0Fw-jL4Ie3Iu2z755XYPzAphhgJmHDA;tt_chain_token=drrbnMAs2A13tME+L6XbsA==\",\n    \"Referer\": \"https://www.tiktok.com/explore\"\n}\n```","operationId":"fetch_tiktok_web_guest_cookie_api_v1_tiktok_web_fetch_tiktok_web_guest_cookie_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_agent","in":"query","required":true,"schema":{"type":"string","description":"用户浏览器代理/User browser agent","title":"User Agent"},"description":"用户浏览器代理/User browser agent","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/web/device_register":{"get":{"tags":["TikTok-Web-API"],"summary":"设备注册/Register device for TikTok Web","description":"# [中文]\n### 用途:\n- 设备注册，为TikTok Web生成设备ID和游客Cookie\n### 参数:\n- 无\n### 返回:\n- 设备注册信息，包括设备ID和游客Cookie\n\n# [English]\n### Purpose:\n- Register device to generate device ID and guest Cookie for TikTok Web\n### Parameters:\n- None\n### Return:\n- Device registration information, including device ID and guest Cookie\n# [响应/Response]:\n```json\n{\n    \"deviceId\": \"7556227929396708877\",\n    \"cookie\": \"tt_chain_token=wBqjjz5I8m1bt96uxA1s8A==\",\n    \"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36\"\n}\n```","operationId":"device_register_api_v1_tiktok_web_device_register_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/app/v3/fetch_one_video":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取单个作品数据/Get single video data","description":"# [中文]\n### 用途:\n- 获取单个作品数据\n### 参数:\n- aweme_id: 作品id\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data\n### Parameters:\n- aweme_id: Video id\n### Return:\n- Video data\n\n# [示例/Example]\naweme_id = \"7350810998023949599\"","operationId":"fetch_one_video_api_v1_tiktok_app_v3_fetch_one_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7350810998023949599"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_one_video_v2":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取单个作品数据 V2/Get single video data V2","description":"# [中文]\n### 用途:\n- 获取单个作品数据 V2\n### 参数:\n- aweme_id: 作品id\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data V2\n### Parameters:\n- aweme_id: Video id\n### Return:\n- Video data\n\n# [示例/Example]\naweme_id = \"7350810998023949599\"","operationId":"fetch_one_video_v2_api_v1_tiktok_app_v3_fetch_one_video_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7350810998023949599"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_one_video_v3":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取单个作品数据 V3(支持国家参数)/Get single video data V3 (support country parameter)","description":"# [中文]\n### 用途:\n- 获取单个作品数据 V3\n### 参数:\n- aweme_id: 作品id\n- region: 国家代码，默认US，支持ISO 3166-1 alpha-2国家代码，例如：US、GB、FR、DE、IN、JP等。\n- 备注：某些视频可能在特定国家/地区不可用，设置region参数可以尝试获取该国家/地区的视频数据。\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data V3\n### Parameters:\n- aweme_id: Video id\n- region: Country code, default is US, supports ISO 3166-1 alpha-2 country codes, such as: US, GB, FR, DE, IN, JP, etc.\n- Note: Some videos may not be available in certain countries/regions, setting the region parameter can try to get the video data for that country/region.\n### Return:\n- Video data\n\n# [示例/Example]\naweme_id = \"7350810998023949599\"\nregion = \"US\"","operationId":"fetch_one_video_v3_api_v1_tiktok_app_v3_fetch_one_video_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7350810998023949599"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Region"},"description":"国家代码/Country code","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_multi_video":{"post":{"tags":["TikTok-App-V3-API"],"summary":"批量获取视频信息/Batch Get Video Information","description":"# [中文]\n### 用途:\n- 批量获取视频信息，支持图文、视频等，一次性最多支持10个视频，此接口收费固定价格为0.001$ * 10 = 0.01$一次。\n- 如果本接口报错，请使用 fetch_multi_video_v3 接口。\n### 参数:\n- aweme_ids: 作品id列表，最多支持10个作品id。\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Batch Get Video Information, support photo, video, etc., up to 10 videos at a time, this interface charges a fixed price of 0.001$ * 10 = 0.01$ each time.\n- If this interface reports an error, please use the fetch_multi_video_v3 interface.\n### Parameters:\n- aweme_ids: List of video ids, up to 10 video ids are supported.\n### Return:\n- Video data\n\n# [示例/Example]\naweme_ids = [\n        \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\",\n        \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\",\n    ]","operationId":"fetch_multi_video_api_v1_tiktok_app_v3_fetch_multi_video_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Aweme Ids","description":"作品id列表/Video id list"},"example":["7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/app/v3/fetch_multi_video_v2":{"post":{"tags":["TikTok-App-V3-API"],"summary":"批量获取视频信息 V2/Batch Get Video Information V2","description":"# [中文]\n### 用途:\n- 批量获取视频信息，支持图文、视频等，一次性最多支持25个视频，此接口收费固定价格为0.001$ * 25 = 0.025$一次。\n- 注意：此接口为V2版本，支持更多功能和更高效的数据获取，一秒可以获取25个视频数据。\n- 如果本接口报错，请使用 fetch_multi_video_v3 接口。\n### 参数:\n- aweme_ids: 作品id列表，最多支持25个作品id。\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Batch Get Video Information, support photo, video, etc., up to 25 videos at a time, this interface charges a fixed price of 0.001$ * 25 = 0.025$ each time.\n- Note: This interface is the V2 version, which supports more features and more efficient data retrieval, can retrieve 25 video data per second.\n- If this interface reports an error, please use the fetch_multi_video_v3 interface.\n### Parameters:\n- aweme_ids: List of video ids, up to 25 video ids are supported.\n### Return:\n- Video data\n\n# [示例/Example]\naweme_ids = [\n        \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\",\n        \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\", \"7339393672959757570\",\n    ]","operationId":"fetch_multi_video_v2_api_v1_tiktok_app_v3_fetch_multi_video_v2_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Aweme Ids","description":"作品id列表/Video id list"},"example":["7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570","7339393672959757570"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/app/v3/fetch_one_video_by_share_url_v2":{"get":{"tags":["TikTok-App-V3-API"],"summary":"根据分享链接获取单个作品数据/Get single video data by sharing link","description":"# [中文]\n### 用途:\n- 根据分享链接获取单个作品数据 V2，数据结构会有些不一样，会返回region字段。\n### 参数:\n- share_url: 分享链接\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data by sharing link V2, the data structure will be a bit different, and the region field will be returned.\n### Parameters:\n- share_url: Share link\n### Return:\n- Video data\n\n# [示例/Example]\nshare_url = \"https://www.tiktok.com/t/ZTFNEj8Hk/\"","operationId":"fetch_one_video_by_share_url_v2_api_v1_tiktok_app_v3_fetch_one_video_by_share_url_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_url","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Url"},"description":"分享链接/Share link","example":"https://www.tiktok.com/t/ZTFNEj8Hk/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_one_video_by_share_url":{"get":{"tags":["TikTok-App-V3-API"],"summary":"根据分享链接获取单个作品数据/Get single video data by sharing link","description":"# [中文]\n### 用途:\n- 根据分享链接获取单个作品数据\n### 参数:\n- share_url: 分享链接\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data by sharing link\n### Parameters:\n- share_url: Share link\n### Return:\n- Video data\n\n# [示例/Example]\nshare_url = \"https://www.tiktok.com/t/ZTFNEj8Hk/\"","operationId":"fetch_one_video_by_share_url_api_v1_tiktok_app_v3_fetch_one_video_by_share_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_url","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Url"},"description":"分享链接/Share link","example":"https://www.tiktok.com/t/ZTFNEj8Hk/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/get_user_id_and_sec_user_id_by_username":{"get":{"tags":["TikTok-App-V3-API"],"summary":"使用用户名获取用户 user_id 和 sec_user_id/Get user_id and sec_user_id by Username","description":"# [中文]\n### 用途:\n- 使用用户名获取用户 user_id 和 sec_user_id\n### 参数:\n- username: 用户名\n### 返回:\n- 用户 user_id 和 sec_user_id\n\n# [English]\n### Purpose:\n- Get user_id and sec_user_id by Username\n### Parameters:\n- username: Username\n### Return:\n- User user_id and sec_user_id\n\n# [示例/Example]\nusername = \"tiktok\"","operationId":"get_user_id_and_sec_user_id_by_username_api_v1_tiktok_app_v3_get_user_id_and_sec_user_id_by_username_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"tiktok"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/handler_user_profile":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定用户的信息/Get information of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户的信息\n### 参数:\n- sec_user_id: 用户sec_user_id，优先使用sec_user_id获取用户信息。\n- user_id: 用户uid，可选参数，纯数字，如果使用请保持sec_user_id以及unique_id为空。\n- unique_id: 用户unique_id，可选参数，如果sec_user_id为空，则使用unique_id获取用户信息，unique_id也是用户的用户名，如果使用请保持sec_user_id以及user_id为空。\n- 以上参数必须至少填写一个，优先级为sec_user_id > user_id > unique_id，优先级越高速度越快。\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get information of specified user\n### Parameters:\n- sec_user_id: User sec_user_id\n- user_id: User uid, optional parameter, pure number, if used, please keep sec_user_id and unique_id empty.\n- unique_id: User unique_id, optional parameter, if sec_user_id is empty, use unique_id to get user information, unique_id is also the user's username, if used, please keep sec_user_id and user_id empty.\n- At least one of the above parameters must be filled in, the priority is sec_user_id > user_id > unique_id, the higher the priority, the faster the speed.\n### Return:\n- User information\n\n# [示例/Example]\nuser_id = \"107955\"\nsec_user_id = \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\"\nunique_id = \"tiktok\"","operationId":"handler_user_profile_api_v1_tiktok_app_v3_handler_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户uid （可选，纯数字）/User uid (optional, pure number)","default":"","title":"User Id"},"description":"用户uid （可选，纯数字）/User uid (optional, pure number)","example":""},{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","default":"","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"},{"name":"unique_id","in":"query","required":false,"schema":{"type":"string","description":"用户unique_id （用户名）/User unique_id (username)","default":"","title":"Unique Id"},"description":"用户unique_id （用户名）/User unique_id (username)","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_webcast_user_info":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定 Webcast 用户的信息/Get information of specified Webcast user","description":"# [中文]\n### 用途:\n- 获取指定用户的信息\n### 参数:\n- sec_user_id: 用户sec_user_id，优先使用sec_user_id获取用户信息。\n- user_id: 用户uid，可选参数，纯数字，如果使用请保持sec_user_id以及unique_id为空。\n- 以上参数必须至少填写一个，优先级为sec_user_id > user_id，优先级越高速度越快。\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get information of specified user\n### Parameters:\n- sec_user_id: User sec_user_id\n- user_id: User uid, optional parameter, pure number, if used, please keep sec_user_id and unique_id empty.\n- At least one of the above parameters must be filled in, the priority is sec_user_id > user_id, the higher the priority, the faster the speed.\n### Return:\n- User information\n\n# [示例/Example]\nuser_id = \"107955\"\nsec_user_id = \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\"","operationId":"fetch_webcast_user_info_api_v1_tiktok_app_v3_fetch_webcast_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户uid （可选，纯数字）/User uid (optional, pure number)","default":"","title":"User Id"},"description":"用户uid （可选，纯数字）/User uid (optional, pure number)","example":""},{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","default":"","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_country_by_username":{"get":{"tags":["TikTok-App-V3-API"],"summary":"通过用户名获取用户账号国家地区/Get user account country by username","description":"# [中文]\n### 用途:\n- 通过用户名获取用户账号国家地区\n### 参数:\n- username: 用户名，可以从用户主页链接中获取，例如：https://www.tiktok.com/@tiktok，用户名即为tiktok。\n### 返回:\n- 用户账号国家地区\n\n# [English]\n### Purpose:\n- Get user account country by username\n### Parameters:\n- username: Username, which can be obtained from the user's homepage link, for example: https://www.tiktok.com/@tiktok, the username is tiktok.\n### Return:\n- User account country\n\n# [示例/Example]\nusername = \"tiktok\"\n\n# 响应示例/Response Example\n```json\n{'username': 'tiktok', 'username_modify_time': 1760985494, 'user_id': '107955', 'sec_user_id': 'MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM', 'country': 'US', 'api_version': 'v1'}\n```","operationId":"fetch_user_country_by_username_api_v1_tiktok_app_v3_fetch_user_country_by_username_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"tiktok"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_similar_user_recommendations":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取类似用户推荐/Similar User Recommendations","description":"# [中文]\n### 用途:\n- 获取类似用户推荐\n### 参数:\n- sec_uid: 用户sec_uid\n- page_token: 分页标记，第一次请求时不需要传递，后续请求时传递上一次响应中的next_page_token值。\n### 返回:\n- 类似用户推荐\n\n# [English]\n### Purpose:\n- Similar User Recommendations\n### Parameters:\n- sec_uid: User sec_uid\n- page_token: Page token, not required for the first request, for subsequent requests, pass the next_page_token value from the previous response.\n### Return:\n- Similar User Recommendations\n\n# [示例/Example]\nsec_uid = \"MS4wLjABAAAA2_YTgxz3kLb2XoyC3xOXnosim3gdiqMtFHnjRvckabZJFQ40XBOVttDCiB5cwa3b\"\npage_token = \"\"","operationId":"fetch_similar_user_recommendations_api_v1_tiktok_app_v3_fetch_similar_user_recommendations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_uid/User sec_uid","title":"Sec Uid"},"description":"用户sec_uid/User sec_uid","example":"MS4wLjABAAAA2_YTgxz3kLb2XoyC3xOXnosim3gdiqMtFHnjRvckabZJFQ40XBOVttDCiB5cwa3b"},{"name":"page_token","in":"query","required":false,"schema":{"type":"string","description":"分页标记/Page token","default":"","title":"Page Token"},"description":"分页标记/Page token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_repost_videos":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取用户转发的作品数据/Get user repost video data","description":"# [中文]\n### 用途:\n- 获取用户转发的作品数据\n### 参数:\n- user_id: 用户id，可以通过 handler_user_profile 端点获取，响应中的关键字为uid。\n- offset: 偏移量\n- count: 数量\n### 返回:\n- 用户转发作品数据\n\n# [English]\n### Purpose:\n- Get user repost video data\n### Parameters:\n- user_id: User id, which can be obtained through the handler_user_profile endpoint, with the keyword uid in the response.\n- offset: Offset\n- count: Number\n### Return:\n- User repost video data\n\n# [示例/Example]\nuser_id = 107955\noffset = 0\ncount = 21","operationId":"fetch_user_repost_videos_api_v1_tiktok_app_v3_fetch_user_repost_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"integer","description":"用户id/User id","title":"User Id"},"description":"用户id/User id","example":107955},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":21,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_post_videos":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取用户主页作品数据 V1/Get user homepage video data V1","description":"# [中文]\n### 用途:\n- 获取用户主页作品数据\n### 参数:\n- sec_user_id: 用户sec_user_id，优先使用sec_user_id获取用户作品数据，如果sec_user_id为空，则使用unique_id获取用户作品数据。\n- max_cursor: 最大游标，用于翻页，第一页为0，第二页为第一次响应中的max_cursor值。\n- count: 最大数量，建议保持默认值20。\n- sort_type: 排序类型，0-最新，1-热门\n- unique_id: 用户unique_id，可选参数，如果sec_user_id为空，则使用unique_id获取用户作品数据，unique_id也是用户的用户名。\n- 关于用户ID的参数，优先级为sec_user_id > unique_id，优先级越高速度越快，并且建议只使用sec_user_id获取用户数据。\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user homepage video data\n### Parameters:\n- sec_user_id: User sec_user_id, use sec_user_id to get user video data first, if sec_user_id is empty, use unique_id to get user video data.\n- max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response.\n- count: Maximum count number\n- sort_type: Sort type, 0-Latest, 1-Hot\n- unique_id: User unique_id, optional parameter, if sec_user_id is empty, use unique_id to get user video data, unique_id is also the user's username.\n- About the parameters of user ID, the priority is sec_user_id > unique_id, the higher the priority, the faster the speed, and it is recommended to use only sec_user_id to get user data.\n### Return:\n- User video data\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAA5u9HhzjGAj-leViCcvZD6b4-qyqHHgr9lVJmcPMzcBUX_Q2NpBeCgz8Uh6KugkfS\"\nmax_cursor = 0\ncounts = 20\nsort_type = 0\nunique_id = \"tiktok\"","operationId":"fetch_user_post_videos_api_v1_tiktok_app_v3_fetch_user_post_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","default":"","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"},{"name":"unique_id","in":"query","required":false,"schema":{"type":"string","description":"用户unique_id/User unique_id","default":"","title":"Unique Id"},"description":"用户unique_id/User unique_id","example":""},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Maximum cursor","default":0,"title":"Max Cursor"},"description":"最大游标/Maximum cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型/Sort type","default":0,"title":"Sort Type"},"description":"排序类型/Sort type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_post_videos_v2":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取用户主页作品数据 V2/Get user homepage video data V2","description":"# [中文]\n### 用途:\n- 获取用户主页作品数据\n### 参数:\n- sec_user_id: 用户sec_user_id，优先使用sec_user_id获取用户作品数据，如果sec_user_id为空，则使用unique_id获取用户作品数据。\n- max_cursor: 最大游标，用于翻页，第一页为0，第二页为第一次响应中的max_cursor值。\n- count: 最大数量，建议保持默认值20。\n- sort_type: 排序类型，0-最新，1-热门\n- unique_id: 用户unique_id，可选参数，如果sec_user_id为空，则使用unique_id获取用户作品数据，unique_id也是用户的用户名。\n- 关于用户ID的参数，优先级为sec_user_id > unique_id，优先级越高速度越快，并且建议只使用sec_user_id获取用户数据。\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user homepage video data\n### Parameters:\n- sec_user_id: User sec_user_id, use sec_user_id to get user video data first, if sec_user_id is empty, use unique_id to get user video data.\n- max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response.\n- count: Maximum count number\n- sort_type: Sort type, 0-Latest, 1-Hot\n- unique_id: User unique_id, optional parameter, if sec_user_id is empty, use unique_id to get user video data, unique_id is also the user's username.\n- About the parameters of user ID, the priority is sec_user_id > unique_id, the higher the priority, the faster the speed, and it is recommended to use only sec_user_id to get user data.\n### Return:\n- User video data\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAA5u9HhzjGAj-leViCcvZD6b4-qyqHHgr9lVJmcPMzcBUX_Q2NpBeCgz8Uh6KugkfS\"\nmax_cursor = 0\ncounts = 20\nsort_type = 0\nunique_id = \"tiktok\"","operationId":"fetch_user_post_videos_api_v1_tiktok_app_v3_fetch_user_post_videos_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","default":"","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"},{"name":"unique_id","in":"query","required":false,"schema":{"type":"string","description":"用户unique_id/User unique_id","default":"","title":"Unique Id"},"description":"用户unique_id/User unique_id","example":""},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Maximum cursor","default":0,"title":"Max Cursor"},"description":"最大游标/Maximum cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型/Sort type","default":0,"title":"Sort Type"},"description":"排序类型/Sort type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_post_videos_v3":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取用户主页作品数据 V3（精简数据-更快速）/Get user homepage video data V3 (simplified data - faster)","description":"# [中文]\n### 用途:\n- 获取用户主页作品数据\n### 参数:\n- sec_user_id: 用户sec_user_id，优先使用sec_user_id获取用户作品数据，如果sec_user_id为空，则使用unique_id获取用户作品数据。\n- max_cursor: 最大游标，用于翻页，第一页为0，第二页为第一次响应中的max_cursor值。\n- count: 最大数量，建议保持默认值20。\n- sort_type: 排序类型，0-最新，1-热门\n- unique_id: 用户unique_id，可选参数，如果sec_user_id为空，则使用unique_id获取用户作品数据，unique_id也是用户的用户名。\n- 关于用户ID的参数，优先级为sec_user_id > unique_id，优先级越高速度越快，并且建议只使用sec_user_id获取用户数据。\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user homepage video data\n### Parameters:\n- sec_user_id: User sec_user_id, use sec_user_id to get user video data first, if sec_user_id is empty, use unique_id to get user video data.\n- max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response.\n- count: Maximum count number\n- sort_type: Sort type, 0-Latest, 1-Hot\n- unique_id: User unique_id, optional parameter, if sec_user_id is empty, use unique_id to get user video data, unique_id is also the user's username.\n- About the parameters of user ID, the priority is sec_user_id > unique_id, the higher the priority, the faster the speed, and it is recommended to use only sec_user_id to get user data.\n### Return:\n- User video data\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAA5u9HhzjGAj-leViCcvZD6b4-qyqHHgr9lVJmcPMzcBUX_Q2NpBeCgz8Uh6KugkfS\"\nmax_cursor = 0\ncounts = 20\nsort_type = 0\nunique_id = \"tiktok\"","operationId":"fetch_user_post_videos_v3_api_v1_tiktok_app_v3_fetch_user_post_videos_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","default":"","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"},{"name":"unique_id","in":"query","required":false,"schema":{"type":"string","description":"用户unique_id/User unique_id","default":"","title":"Unique Id"},"description":"用户unique_id/User unique_id","example":""},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Maximum cursor","default":0,"title":"Max Cursor"},"description":"最大游标/Maximum cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型/Sort type","default":0,"title":"Sort Type"},"description":"排序类型/Sort type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_like_videos":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取用户喜欢作品数据/Get user like video data","description":"# [中文]\n### 用途:\n- 获取用户喜欢作品数据\n### 参数:\n- sec_user_id: 用户sec_user_id\n- max_cursor: 最大游标，用于翻页，第一页为0，第二页为第一次响应中的max_cursor值。\n- count: 最大数量\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user like video data\n### Parameters:\n- sec_user_id: User sec_user_id\n- max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response.\n- count: Maximum count number\n### Return:\n- User video data\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAA-RkTGCGXLuLKRM5Xcuuwm7Mclg51I2ECO1RqOA7mJHuXFz99nztdi077Z2XmYHZV\"\nmax_cursor = 0\ncounts = 20","operationId":"fetch_user_like_videos_api_v1_tiktok_app_v3_fetch_user_like_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":true,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAA-RkTGCGXLuLKRM5Xcuuwm7Mclg51I2ECO1RqOA7mJHuXFz99nztdi077Z2XmYHZV"},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Maximum cursor","default":0,"title":"Max Cursor"},"description":"最大游标/Maximum cursor"},{"name":"counts","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Counts"},"description":"每页数量/Number per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_video_comments":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取单个视频评论数据/Get single video comments data","description":"# [中文]\n### 用途:\n- 获取单个视频评论数据\n### 参数:\n- aweme_id: 作品id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量\n### 返回:\n- 评论数据\n\n# [English]\n### Purpose:\n- Get single video comments data\n### Parameters:\n- aweme_id: Video id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number\n### Return:\n- Comments data\n\n# [示例/Example]\naweme_id = \"7326156045968067873\"\ncursor = 0\ncount = 20","operationId":"fetch_video_comments_api_v1_tiktok_app_v3_fetch_video_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7326156045968067873"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_video_comment_replies":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定视频的评论回复数据/Get comment replies data of specified video","description":"# [中文]\n### 用途:\n- 获取指定视频的评论回复数据\n### 参数:\n- item_id: 作品id\n- comment_id: 评论id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量\n### 返回:\n- 评论回复数据\n\n# [English]\n### Purpose:\n- Get comment replies data of specified video\n### Parameters:\n- item_id: Video id\n- comment_id: Comment id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number\n### Return:\n- Comment replies data\n\n# [示例/Example]\naweme_id = \"7326156045968067873\"\ncomment_id = \"7327061675382260482\"\ncursor = 0\ncount = 20","operationId":"fetch_video_comments_reply_api_v1_tiktok_app_v3_fetch_video_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7326156045968067873"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论id/Comment id","title":"Comment Id"},"description":"评论id/Comment id","example":"7327061675382260482"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_general_search_result":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定关键词的综合搜索结果/Get comprehensive search results of specified keywords","description":"# [中文]\n### 用途:\n- 获取指定关键词的综合搜索结果\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量\n- sort_type: 0-相关度，1-最多点赞\n- publish_time: 0-不限制，1-最近一天，7-最近一周，30-最近一个月，90-最近三个月，180-最近半年\n### 返回:\n- 综合搜索结果\n\n# [English]\n### Purpose:\n- Get comprehensive search results of specified keywords\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number\n- sort_type: 0-Relatedness, 1-Most likes\n- publish_time: 0-Unlimited, 1-Last day, 7-Last week, 30-Last month, 90-Last three months, 180-Last half year\n### Return:\n- Comprehensive search results\n\n# [示例/Example]\nkeyword = \"中华娘\"\noffset = 0\ncount = 20\nsort_type = 0\npublish_time = 0","operationId":"fetch_general_search_result_api_v1_tiktok_app_v3_fetch_general_search_result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset","example":0},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number","example":20},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型/Sort type","default":0,"title":"Sort Type"},"description":"排序类型/Sort type","example":0},{"name":"publish_time","in":"query","required":false,"schema":{"type":"integer","description":"发布时间/Publish time","default":0,"title":"Publish Time"},"description":"发布时间/Publish time","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_video_search_result":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定关键词的视频搜索结果/Get video search results of specified keywords","description":"# [中文]\n### 用途:\n- 获取指定关键词的视频搜索结果\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量\n- sort_type: 0-相关度，1-最多点赞\n- publish_time: 0-不限制，1-最近一天，7-最近一周，30-最近一个月，90-最近三个月，180-最近半年\n- region: 地区，默认为US-美国，可选值请参考TikTok地区代码或ISO 3166-1 alpha-2国家代码。\n### 返回:\n- 视频搜索结果\n\n# [English]\n### Purpose:\n- Get video search results of specified keywords\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number\n- sort_type: 0-Relatedness, 1-Most likes\n- publish_time: 0-Unlimited, 1-Last day, 7-Last week, 30-Last month, 90-Last three months, 180-Last half year\n- region: Region, default is US-America, for optional values please refer to TikTok region codes or ISO 3166-1 alpha-2 country codes.\n### Return:\n- Video search results\n\n# [示例/Example]\nkeyword = \"中华娘\"\noffset = 0\ncount = 20\nsort_type = 0\npublish_time = 0\nregion = \"US\"","operationId":"fetch_video_search_result_api_v1_tiktok_app_v3_fetch_video_search_result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset","example":0},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number","example":20},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型/Sort type","default":0,"title":"Sort Type"},"description":"排序类型/Sort type","example":0},{"name":"publish_time","in":"query","required":false,"schema":{"type":"integer","description":"发布时间/Publish time","default":0,"title":"Publish Time"},"description":"发布时间/Publish time","example":0},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区/Region","default":"US","title":"Region"},"description":"地区/Region","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_search_result":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定关键词的用户搜索结果/Get user search results of specified keywords","description":"# [中文]\n### 用途:\n- 获取指定关键词的用户搜索结果\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量\n- user_search_follower_count（根据粉丝数排序）:\n    - 空-不限制，\n    - ZERO_TO_ONE_K = 0-1K，\n    - ONE_K_TO_TEN_K-1K = 1K-10K，\n    - TEN_K_TO_ONE_H_K = 10K-100K，\n    - ONE_H_K_PLUS = 100K以上\n- user_search_profile_type（根据账号类型排序）:\n    - 空-不限制，\n    - VERIFIED = 认证用户\n- user_search_other_pref（根据其他偏好排序）:\n    - USERNAME = 根据用户名相关性\n### 返回:\n- 用户搜索结果\n\n# [English]\n### Purpose:\n- Get user search results of specified keywords\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number\n- user_search_follower_count（Sort by number of followers）:\n    - Empty-Unlimited,\n    - ZERO_TO_ONE_K = 0-1K,\n    - ONE_K_TO_TEN_K-1K = 1K-10K,\n    - TEN_K_TO_ONE_H_K = 10K-100K,\n    - ONE_H_K_PLUS = 100K and above\n- user_search_profile_type（Sort by account type）:\n    - Empty-Unlimited,\n    - VERIFIED = Verified user\n- user_search_other_pref（Sort by other preferences）:\n    - USERNAME = Sort by username relevance\n### Return:\n- User search results\n\n# [示例/Example]\nkeyword = \"Cat\"\noffset = 0\ncount = 20\nuser_search_follower_count = \"\"\nuser_search_profile_type = \"\"\nuser_search_other_pref = \"\"","operationId":"fetch_user_search_result_api_v1_tiktok_app_v3_fetch_user_search_result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"Cat"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset","example":0},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number","example":20},{"name":"user_search_follower_count","in":"query","required":false,"schema":{"type":"string","description":"根据粉丝数排序/Sort by number of followers","default":"","title":"User Search Follower Count"},"description":"根据粉丝数排序/Sort by number of followers","example":""},{"name":"user_search_profile_type","in":"query","required":false,"schema":{"type":"string","description":"根据账号类型排序/Sort by account type","default":"","title":"User Search Profile Type"},"description":"根据账号类型排序/Sort by account type","example":""},{"name":"user_search_other_pref","in":"query","required":false,"schema":{"type":"string","description":"根据其他偏好排序/Sort by other preferences","default":"","title":"User Search Other Pref"},"description":"根据其他偏好排序/Sort by other preferences","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_music_search_result":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定关键词的音乐搜索结果/Get music search results of specified keywords","description":"# [中文]\n### 用途:\n- 获取指定关键词的音乐搜索结果\n### 参数:\n- keyword: 关键词\n- offset: 偏移量，从0开始，第二页从响应中获取cursor的值作为offset继续请求。\n- count: 数量，不要超过20\n- filter_by: 过滤类型，0-全部，1-标题，2-作者，默认为0-全部\n- sort_type: 排序类型，0-相关度，1-最多使用，2-最新，3-时长最短，4-时长最长，默认为0-相关度\n- region: 地区，默认为US-美国，可选值请参考TikTok地区代码或ISO 3166-1 alpha-2国家代码。\n### 返回:\n- 音乐搜索结果\n\n# [English]\n### Purpose:\n- Get music search results of specified keywords\n### Parameters:\n- keyword: Keyword\n- offset: Offset, starting from 0, the second page gets the cursor value from the response as the offset to continue the request.\n- count: Number, do not exceed 20\n- filter_by: Filter type, 0-All, 1-Title, 2-Author, default is 0-All\n- sort_type: Sort type, 0-Relatedness, 1-Most used, 2-Latest, 3-Shortest duration, 4-Longest duration, default is 0-Relatedness\n- region: Region, default is US-America, for optional values please refer to TikTok region codes or ISO 3166-1 alpha-2 country codes.\n### Return:\n- Music search results\n\n# [示例/Example]\nkeyword = \"Cat\"\noffset = 0\ncount = 20\nfilter_by = 0\nsort_type = 0\nregion = \"US\"","operationId":"fetch_music_search_result_api_v1_tiktok_app_v3_fetch_music_search_result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"Cat"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset","example":0},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number","example":20},{"name":"filter_by","in":"query","required":false,"schema":{"type":"integer","description":"过滤类型/Filter type","default":0,"title":"Filter By"},"description":"过滤类型/Filter type","example":0},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型/Sort type","default":0,"title":"Sort Type"},"description":"排序类型/Sort type","example":0},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区/Region","default":"US","title":"Region"},"description":"地区/Region","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_hashtag_search_result":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定关键词的话题搜索结果/Get hashtag search results of specified keywords","description":"# [中文]\n### 用途:\n- 获取指定关键词的话题搜索结果\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量\n### 返回:\n- 话题搜索结果\n\n# [English]\n### Purpose:\n- Get hashtag search results of specified keywords\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number\n### Return:\n- Hashtag search results\n\n# [示例/Example]\nkeyword = \"Cat\"\noffset = 0\ncount = 20","operationId":"fetch_hashtag_search_result_api_v1_tiktok_app_v3_fetch_hashtag_search_result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"Cat"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_live_search_result":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定关键词的直播搜索结果/Get live search results of specified keywords","description":"# [中文]\n### 用途:\n- 获取指定关键词的直播搜索结果\n### 参数:\n- keyword: 关键词\n- offset: 偏移量，从0开始，第二页从响应中获取cursor的值作为offset继续请求。\n- count: 数量，不要超过20\n- region: 地区，默认为US-美国，可选值请参考TikTok地区代码或ISO 3166-1 alpha-2国家代码。\n### 返回:\n- 直播搜索结果\n\n# [English]\n### Purpose:\n- Get live search results of specified keywords\n### Parameters:\n- keyword: Keyword\n- offset: Offset, starting from 0, the second page gets the cursor value from the response as the offset to continue the request.\n- count: Number, do not exceed 20\n- region: Region, default is US-America, for optional values please refer to TikTok region codes or ISO 3166-1 alpha-2 country codes.\n### Return:\n- Live search results\n\n# [示例/Example]\nkeyword = \"Cat\"\noffset = 0\ncount = 20\nregion = \"US\"","operationId":"fetch_live_search_result_api_v1_tiktok_app_v3_fetch_live_search_result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"Cat"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset","example":0},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number","example":20},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区/Region","default":"US","title":"Region"},"description":"地区/Region","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_location_search":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取地点搜索结果/Get location search results","description":"# [中文]\n### 用途:\n- 获取地点搜索结果\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量\n### 返回:\n- 地点搜索结果\n\n# [English]\n### Purpose:\n- Get location search results\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number\n### Return:\n- Location search results\n\n# [示例/Example]\nkeyword = \"Shanghai\"\noffset = 0\ncount = 20","operationId":"fetch_location_search_api_v1_tiktok_app_v3_fetch_location_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"Shanghai"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_music_detail":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定音乐的详情数据/Get details of specified music","description":"# [中文]\n### 用途:\n- 获取指定音乐的详情数据\n### 参数:\n- music_id: 音乐id\n### 返回:\n- 音乐详情数据\n\n# [English]\n### Purpose:\n- Get details of specified music\n### Parameters:\n- music_id: Music id\n### Return:\n- Music details data\n\n# [示例/Example]\nmusic_id = \"6943027371519772674\"","operationId":"fetch_music_detail_api_v1_tiktok_app_v3_fetch_music_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"music_id","in":"query","required":true,"schema":{"type":"string","description":"音乐id/Music id","title":"Music Id"},"description":"音乐id/Music id","example":"6943027371519772674"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_music_video_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定音乐的视频列表数据/Get video list of specified music","description":"# [中文]\n### 用途:\n- 获取指定音乐的视频列表数据\n### 参数:\n- music_id: 音乐id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量\n### 返回:\n- 音乐视频列表数据\n\n# [English]\n### Purpose:\n- Get video list of specified music\n### Parameters:\n- music_id: Music id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number\n### Return:\n- Music video list data\n\n# [示例/Example]\nmusic_id = \"6943027371519772674\"\ncursor = 0\ncount = 10","operationId":"fetch_music_video_list_api_v1_tiktok_app_v3_fetch_music_video_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"music_id","in":"query","required":true,"schema":{"type":"string","description":"音乐id/Music id","title":"Music Id"},"description":"音乐id/Music id","example":"6943027371519772674"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":10,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_hashtag_detail":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定话题的详情数据/Get details of specified hashtag","description":"# [中文]\n### 用途:\n- 获取指定话题的详情数据\n### 参数:\n- ch_id: 话题id\n### 返回:\n- 话题详情数据\n\n# [English]\n### Purpose:\n- Get details of specified hashtag\n### Parameters:\n- ch_id: Hashtag id\n### Return:\n- Hashtag details data\n\n# [示例/Example]\nch_id = \"7551\"","operationId":"fetch_hashtag_detail_api_v1_tiktok_app_v3_fetch_hashtag_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ch_id","in":"query","required":true,"schema":{"type":"string","description":"话题id/Hashtag id","title":"Ch Id"},"description":"话题id/Hashtag id","example":"7551"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_hashtag_video_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定话题的作品数据/Get video list of specified hashtag","description":"# [中文]\n### 用途:\n- 获取指定话题的作品数据\n### 参数:\n- ch_id: 话题id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量\n### 返回:\n- 话题作品数据\n\n# [English]\n### Purpose:\n- Get video list of specified hashtag\n### Parameters:\n- ch_id: Hashtag id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number\n### Return:\n- Hashtag video list data\n\n# [示例/Example]\nch_id = \"7551\"\ncursor = 0\nsort_type = 0\ncount = 10","operationId":"fetch_hashtag_video_list_api_v1_tiktok_app_v3_fetch_hashtag_video_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ch_id","in":"query","required":true,"schema":{"type":"string","description":"话题id/Hashtag id","title":"Ch Id"},"description":"话题id/Hashtag id","example":"7551"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":10,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_follower_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定用户的粉丝列表数据/Get follower list of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户的粉丝列表数据\n### 参数:\n- user_id: 用户ID，这是一个纯数字版本的用户ID (与sec_user_id二选一/One of user_id and sec_user_id)\n- sec_user_id: 用户sec_user_id，这是一个混合字母和数字的版本ID (与user_id二选一/One of user_id and sec_user_id)\n- count: 数量，不要超过20，保持固定。\n- min_time: 最小时间，用于翻页，第一次请求使用默认值0，后续请求使用上一次请求返回的min_time值。\n- page_token: 翻页token，第一次请求使用默认值\"\"，后续请求使用上一次请求返回的page_token值。\n### 返回:\n- 粉丝列表数据\n\n# [English]\n### Purpose:\n- Get follower list of specified user\n### Parameters:\n- user_id: User ID, this is a pure numeric version of the user ID (one of user_id and sec_user_id)\n- sec_user_id: User sec_user_id, this is a mixed letter and number version ID (one of user_id and sec_user_id)\n- count: Number, do not exceed 20, keep it fixed.\n- min_time: Minimum time for paging, use default value 0 for the first request, and use the min_time value returned by the last request for subsequent requests.\n- page_token: Page token, use default value \"\" for the first request, and use the page_token value returned by the last request for subsequent requests.\n### Return:\n- Follower list data\n\n# [示例/Example]\nuser_id = \"7486586574684881927\"\nsec_user_id = \"MS4wLjABAAAA0lKrE0cVLLZCnVil-n-YEZlOoik9oeO3zOYQ08dqOEOw2pRSXWJdcSFw7lZeZcSP\"\ncount = 20\nmin_time = 0\npage_token = \"\"","operationId":"fetch_user_follower_list_api_v1_tiktok_app_v3_fetch_user_follower_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID (与sec_user_id二选一/One of user_id and sec_user_id)","default":"","title":"User Id"},"description":"用户ID/User ID (与sec_user_id二选一/One of user_id and sec_user_id)","example":"7486586574684881927"},{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id (与user_id二选一/One of user_id and sec_user_id)","default":"","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id (与user_id二选一/One of user_id and sec_user_id)","example":"MS4wLjABAAAA0lKrE0cVLLZCnVil-n-YEZlOoik9oeO3zOYQ08dqOEOw2pRSXWJdcSFw7lZeZcSP"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number","example":20},{"name":"min_time","in":"query","required":false,"schema":{"type":"integer","description":"最小时间，用于翻页/Minimum time for paging","default":0,"title":"Min Time"},"description":"最小时间，用于翻页/Minimum time for paging","example":0},{"name":"page_token","in":"query","required":false,"schema":{"type":"string","description":"翻页token/Page token","default":"","title":"Page Token"},"description":"翻页token/Page token","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_following_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定用户的关注列表数据/Get following list of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户的关注列表数据\n### 参数:\n- user_id: 用户ID，这是一个纯数字版本的用户ID (与sec_user_id二选一/One of user_id and sec_user_id)\n- sec_user_id: 用户sec_user_id，这是一个混合字母和数字的版本ID (与user_id二选一/One of user_id and sec_user_id)\n- count: 数量，不要超过20，保持固定。\n- min_time: 最小时间，用于翻页，第一次请求使用默认值0，后续请求使用上一次请求返回的min_time值。\n- page_token: 翻页token，第一次请求使用默认值\"\"，后续请求使用上一次请求返回的page_token值。\n### 返回:\n- 关注列表数据\n\n# [English]\n### Purpose:\n- Get following list of specified user\n### Parameters:\n- user_id: User ID, this is a pure numeric version of the user ID (one of user_id and sec_user_id)\n- sec_user_id: User sec_user_id, this is a mixed letter and number version ID (one of user_id and sec_user_id)\n- count: Number, do not exceed 20, keep it fixed.\n- min_time: Minimum time for paging, use default value 0 for the first request, and use the min_time value returned by the last request for subsequent requests.\n- page_token: Page token, use default value \"\" for the first request, and use the page_token value returned by the last request for subsequent requests.\n### Return:\n- Following list data\n\n# [示例/Example]\nuser_id = \"7486586574684881927\"\nsec_user_id = \"MS4wLjABAAAA0lKrE0cVLLZCnVil-n-YEZlOoik9oeO3zOYQ08dqOEOw2pRSXWJdcSFw7lZeZcSP\"\ncount = 20\nmin_time = 0\npage_token = \"\"","operationId":"fetch_user_following_list_api_v1_tiktok_app_v3_fetch_user_following_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID (与sec_user_id二选一/One of user_id and sec_user_id)","default":"","title":"User Id"},"description":"用户ID/User ID (与sec_user_id二选一/One of user_id and sec_user_id)","example":"7486586574684881927"},{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id (与user_id二选一/One of user_id and sec_user_id)","default":"","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id (与user_id二选一/One of user_id and sec_user_id)","example":"MS4wLjABAAAA0lKrE0cVLLZCnVil-n-YEZlOoik9oeO3zOYQ08dqOEOw2pRSXWJdcSFw7lZeZcSP"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number","example":20},{"name":"min_time","in":"query","required":false,"schema":{"type":"integer","description":"最小时间，用于翻页/Minimum time for paging","default":0,"title":"Min Time"},"description":"最小时间，用于翻页/Minimum time for paging","example":0},{"name":"page_token","in":"query","required":false,"schema":{"type":"string","description":"翻页token/Page token","default":"","title":"Page Token"},"description":"翻页token/Page token","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_creator_search_insights":{"get":{"tags":["TikTok-App-V3-API"],"summary":"创作者搜索洞察/Creator Search Insights","description":"# [中文]\n### 用途:\n- 获取创作者搜索洞察数据，用于了解热门搜索趋势和创作灵感\n### 参数:\n- offset: 分页偏移量，默认0\n- limit: 每页数量，默认20\n- tab: 标签页类型，可选值:\n    - all: 全部\n    - content_gap: 内容差距\n    - follower_searched: 粉丝常搜\n    - life_style: 生活方式\n    - topics: 话题\n    - challenges: 挑战\n    - sounds: 声音\n    - hashtags: 标签\n- language_filters: 语言过滤器，多个用逗号分隔，可选值: id, de, en, es, fr, pt, vi, tr, ar, th, ja, ko\n- category_filters: 分类过滤器，多个用逗号分隔，可选值: Gaming, Fashion, Tourism, Science, Food, Sports\n- creator_source: 创作者来源，默认 \"general_search\"\n- force_refresh: 是否强制刷新，默认 False\n### 返回:\n- 创作者搜索洞察数据\n\n# [English]\n### Purpose:\n- Get creator search insights data, used to understand trending search topics and creative inspiration\n### Parameters:\n- offset: Pagination offset, default 0\n- limit: Number per page, default 20\n- tab: Tab type, options:\n    - all: All\n    - content_gap: Content gap\n    - follower_searched: Follower searched\n    - life_style: Life style\n    - topics: Topics\n    - challenges: Challenges\n    - sounds: Sounds\n    - hashtags: Hashtags\n- language_filters: Language filters, separated by comma, options: id, de, en, es, fr, pt, vi, tr, ar, th, ja, ko\n- category_filters: Category filters, separated by comma, options: Gaming, Fashion, Tourism, Science, Food, Sports\n- creator_source: Creator source, default \"general_search\"\n- force_refresh: Force refresh, default False\n### Return:\n- Creator search insights data\n\n# [示例/Example]\noffset = 0\nlimit = 20\ntab = \"all\"\nlanguage_filters = \"en\"\ncategory_filters = \"Gaming\"","operationId":"fetch_creator_search_insights_api_v1_tiktok_app_v3_fetch_creator_search_insights_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"分页偏移量/Pagination offset","default":0,"title":"Offset"},"description":"分页偏移量/Pagination offset","example":0},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Limit"},"description":"每页数量/Number per page","example":20},{"name":"tab","in":"query","required":false,"schema":{"type":"string","description":"标签页类型/Tab type (all/content_gap/follower_searched/life_style/topics/challenges/sounds/hashtags)","default":"all","title":"Tab"},"description":"标签页类型/Tab type (all/content_gap/follower_searched/life_style/topics/challenges/sounds/hashtags)","example":"all"},{"name":"language_filters","in":"query","required":false,"schema":{"type":"string","description":"语言过滤器，多个用逗号分隔/Language filters (id/de/en/es/fr/pt/vi/tr/ar/th/ja/ko)","default":"en","title":"Language Filters"},"description":"语言过滤器，多个用逗号分隔/Language filters (id/de/en/es/fr/pt/vi/tr/ar/th/ja/ko)","example":"en"},{"name":"category_filters","in":"query","required":false,"schema":{"type":"string","description":"分类过滤器，多个用逗号分隔/Category filters (Gaming/Fashion/Tourism/Science/Food/Sports)","default":"","title":"Category Filters"},"description":"分类过滤器，多个用逗号分隔/Category filters (Gaming/Fashion/Tourism/Science/Food/Sports)","example":""},{"name":"creator_source","in":"query","required":false,"schema":{"type":"string","description":"创作者来源/Creator source","default":"general_search","title":"Creator Source"},"description":"创作者来源/Creator source","example":"general_search"},{"name":"force_refresh","in":"query","required":false,"schema":{"type":"boolean","description":"是否强制刷新/Force refresh","default":false,"title":"Force Refresh"},"description":"是否强制刷新/Force refresh","example":false}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_creator_search_insights_detail":{"get":{"tags":["TikTok-App-V3-API"],"summary":"创作者搜索洞察详情/Creator Search Insights Detail","description":"# [中文]\n### 用途:\n- 获取创作者搜索洞察详情数据，用于查询特定搜索词条的搜索统计数据\n### 参数:\n- query_id_str: 搜索词条ID，从 fetch_creator_search_insights 接口返回的数据中获取\n- time_range: 时间范围，可选值:\n    - past_7_days: 过去7天\n    - past_30_days: 过去30天（默认）\n    - past_60_days: 过去60天\n    - past_6_months: 过去6个月\n    - custom: 自定义时间（需配合 start_date 和 end_date 使用，不能超过6个月）\n- start_date: 开始时间戳（秒），仅当 time_range=custom 时生效\n- end_date: 结束时间戳（秒），仅当 time_range=custom 时生效\n- dimension_list: 维度列表，多个用逗号分隔，可选值: gender（性别）, age（年龄）, country（国家）\n### 返回:\n- 搜索洞察详情数据，包含搜索趋势、用户画像等\n\n# [English]\n### Purpose:\n- Get creator search insights detail data, used to query search statistics for specific query\n### Parameters:\n- query_id_str: Query ID, obtained from fetch_creator_search_insights response\n- time_range: Time range, options:\n    - past_7_days: Past 7 days\n    - past_30_days: Past 30 days (default)\n    - past_60_days: Past 60 days\n    - past_6_months: Past 6 months\n    - custom: Custom range (requires start_date and end_date, cannot exceed 6 months)\n- start_date: Start timestamp (seconds), only for custom range\n- end_date: End timestamp (seconds), only for custom range\n- dimension_list: Dimension list, separated by comma, options: gender, age, country\n### Return:\n- Search insights detail data, including search trends, user demographics, etc.\n\n# [示例/Example]\nquery_id_str = \"122991006\"\ntime_range = \"past_30_days\"\ndimension_list = \"gender,age,country\"","operationId":"fetch_creator_search_insights_detail_api_v1_tiktok_app_v3_fetch_creator_search_insights_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query_id_str","in":"query","required":true,"schema":{"type":"string","description":"搜索词条ID，从 fetch_creator_search_insights 接口获取/Query ID from fetch_creator_search_insights","title":"Query Id Str"},"description":"搜索词条ID，从 fetch_creator_search_insights 接口获取/Query ID from fetch_creator_search_insights","example":"122991006"},{"name":"time_range","in":"query","required":false,"schema":{"type":"string","description":"时间范围/Time range (past_7_days/past_30_days/past_60_days/past_6_months/custom)","default":"past_30_days","title":"Time Range"},"description":"时间范围/Time range (past_7_days/past_30_days/past_60_days/past_6_months/custom)","example":"past_30_days"},{"name":"start_date","in":"query","required":false,"schema":{"type":"integer","description":"开始时间戳（秒），仅当 time_range=custom 时生效/Start timestamp (seconds), only for custom range","title":"Start Date"},"description":"开始时间戳（秒），仅当 time_range=custom 时生效/Start timestamp (seconds), only for custom range"},{"name":"end_date","in":"query","required":false,"schema":{"type":"integer","description":"结束时间戳（秒），仅当 time_range=custom 时生效/End timestamp (seconds), only for custom range","title":"End Date"},"description":"结束时间戳（秒），仅当 time_range=custom 时生效/End timestamp (seconds), only for custom range"},{"name":"dimension_list","in":"query","required":false,"schema":{"type":"string","description":"维度列表，多个用逗号分隔/Dimension list (gender/age/country)","default":"gender,age,country","title":"Dimension List"},"description":"维度列表，多个用逗号分隔/Dimension list (gender/age/country)","example":"gender,age,country"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_creator_search_insights_trend":{"get":{"tags":["TikTok-App-V3-API"],"summary":"创作者搜索洞察趋势/Creator Search Insights Trend","description":"# [中文]\n### 用途:\n- 获取创作者搜索洞察趋势数据，包含地区和时间维度的搜索热度\n### 参数:\n- query_id_str: 搜索词条ID，从 fetch_creator_search_insights 接口返回的数据中获取\n- from_tab_path: 来源标签路径，默认 \"TRENDING,TOPICS\"\n- query_analysis_required: 是否需要查询分析，默认 True\n### 返回:\n- 搜索趋势数据，包含地区热度、时间趋势等\n\n# [English]\n### Purpose:\n- Get creator search insights trend data, including search popularity by region and time\n### Parameters:\n- query_id_str: Query ID, obtained from fetch_creator_search_insights response\n- from_tab_path: From tab path, default \"TRENDING,TOPICS\"\n- query_analysis_required: Whether query analysis is required, default True\n### Return:\n- Search trend data, including regional popularity, time trends, etc.\n\n# [示例/Example]\nquery_id_str = \"7555720035176562699\"\nfrom_tab_path = \"TRENDING,TOPICS\"","operationId":"fetch_creator_search_insights_trend_api_v1_tiktok_app_v3_fetch_creator_search_insights_trend_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query_id_str","in":"query","required":true,"schema":{"type":"string","description":"搜索词条ID，从 fetch_creator_search_insights 接口获取/Query ID from fetch_creator_search_insights","title":"Query Id Str"},"description":"搜索词条ID，从 fetch_creator_search_insights 接口获取/Query ID from fetch_creator_search_insights","example":"7555720035176562699"},{"name":"from_tab_path","in":"query","required":false,"schema":{"type":"string","description":"来源标签路径/From tab path","default":"TRENDING,TOPICS","title":"From Tab Path"},"description":"来源标签路径/From tab path","example":"TRENDING,TOPICS"},{"name":"query_analysis_required","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要查询分析/Whether query analysis is required","default":true,"title":"Query Analysis Required"},"description":"是否需要查询分析/Whether query analysis is required","example":true}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_creator_search_insights_videos":{"get":{"tags":["TikTok-App-V3-API"],"summary":"创作者搜索洞察相关视频/Creator Search Insights Videos","description":"# [中文]\n### 用途:\n- 获取创作者搜索洞察相关视频，查询该搜索词条下比较火的相关视频\n### 参数:\n- keyword: 搜索关键词，从 fetch_creator_search_insights 或 fetch_creator_search_insights_trend 接口获取\n- offset: 分页偏移量，默认0\n- count: 每页数量，默认20\n### 返回:\n- 相关热门视频列表\n\n# [English]\n### Purpose:\n- Get creator search insights related videos, query popular related videos for the search term\n### Parameters:\n- keyword: Search keyword, obtained from fetch_creator_search_insights or fetch_creator_search_insights_trend\n- offset: Pagination offset, default 0\n- count: Number per page, default 20\n### Return:\n- Related popular videos list\n\n# [示例/Example]\nkeyword = \"headshots 2 2 3\"\noffset = 0\ncount = 20","operationId":"fetch_creator_search_insights_videos_api_v1_tiktok_app_v3_fetch_creator_search_insights_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"headshots 2 2 3"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"分页偏移量/Pagination offset","default":0,"title":"Offset"},"description":"分页偏移量/Pagination offset","example":0},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page","example":20}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_music_chart_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"音乐排行榜/Music Chart List","description":"# [中文]\n### 用途:\n- 获取TikTok音乐排行榜数据\n### 参数:\n- scene: 排行榜类型\n    - 0: Top 50 (热门前50)\n    - 1: Viral 50 (病毒式传播前50)\n- cursor: 分页游标，默认0\n- count: 每页数量，默认50，最大50\n### 返回:\n- 音乐排行榜数据，包含歌曲信息、排名变化等\n\n# [English]\n### Purpose:\n- Get TikTok music chart list data\n### Parameters:\n- scene: Chart type\n    - 0: Top 50 (Popular top 50)\n    - 1: Viral 50 (Viral top 50)\n- cursor: Pagination cursor, default 0\n- count: Number per page, default 50, max 50\n### Return:\n- Music chart data, including song info, ranking changes, etc.\n\n# [示例/Example]\nscene = 0  # Top 50\ncursor = 0\ncount = 50","operationId":"fetch_music_chart_list_api_v1_tiktok_app_v3_fetch_music_chart_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"scene","in":"query","required":false,"schema":{"type":"integer","description":"排行榜类型/Chart type (0: Top 50, 1: Viral 50)","default":0,"title":"Scene"},"description":"排行榜类型/Chart type (0: Top 50, 1: Viral 50)","example":0},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"分页游标/Pagination cursor","default":0,"title":"Cursor"},"description":"分页游标/Pagination cursor","example":0},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page (max 50)","default":50,"title":"Count"},"description":"每页数量/Number per page (max 50)","example":50}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/search_follower_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"搜索粉丝列表/Search follower list","description":"# [中文]\n### 用途:\n- 搜索指定用户的粉丝列表，可以用于查找某个用户的粉丝中是否有特定昵称的用户。\n### 参数:\n- user_id: 用户ID，这是一个纯数字版本的用户ID，可以先通过获取用户信息接口获取。\n- keyword: 搜索关键词，用户的昵称中包含该关键词即可匹配\n### 返回:\n- 搜索结果列表\n\n# [English]\n### Purpose:\n- Search follower list of specified user, can be used to find whether there is a user with a specific nickname in the followers of a certain user.\n### Parameters:\n- user_id: User ID, this is a pure numeric version of the user ID, which can be obtained through the get user info API.\n- keyword: Search keyword, the user's nickname contains the keyword to match.\n### Return:\n- Search result list\n\n# [示例/Example]\nuser_id = \"7540849481009988663\"\nkeyword = \"a\"","operationId":"search_follower_list_api_v1_tiktok_app_v3_search_follower_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"7540849481009988663"},{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"a"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/search_following_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"搜索关注列表/Search following list","description":"# [中文]\n### 用途:\n- 搜索指定用户的关注列表，可以用于查找某个用户的关注中是否有特定昵称的用户。\n### 参数:\n- user_id: 用户ID，这是一个纯数字版本的用户ID，可以先通过获取用户信息接口获取。\n- keyword: 搜索关键词，用户的昵称中包含该关键词即可匹配。\n### 返回:\n- 搜索结果列表\n\n# [English]\n### Purpose:\n- Search following list of specified user, can be used to find whether there is a user with a specific nickname in the following of a certain user.\n### Parameters:\n- user_id: User ID, this is a pure numeric version of the user ID, which can be obtained through the get user info API.\n- keyword: Search keyword, the user's nickname contains the keyword to match.\n### Return:\n- Search result list\n\n# [示例/Example]\nuser_id = \"7540849481009988663\"\nkeyword = \"a\"","operationId":"search_following_list_api_v1_tiktok_app_v3_search_following_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"7540849481009988663"},{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"a"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_live_room_info":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取指定直播间的数据/Get data of specified live room","description":"# [中文]\n### 用途:\n- 获取指定直播间的数据\n### 参数:\n- room_id: 直播间id\n### 返回:\n- 直播间数据\n\n# [English]\n### Purpose:\n- Get data of specified live room\n### Parameters:\n- room_id: Live room id\n### Return:\n- Live room data\n\n# [示例/Example]\nroom_id = \"7385461256746060575\"","operationId":"fetch_live_room_info_api_v1_tiktok_app_v3_fetch_live_room_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间id/Live room id","title":"Room Id"},"description":"直播间id/Live room id","example":"7358603858249009962"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_live_ranking_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取直播间排行榜数据/Get live room ranking list","description":"# [中文]\n### 用途:\n- 获取直播间内观众的排行榜数据\n### 参数:\n- room_id: 直播间id\n- anchor_id: 主播id\n### 返回:\n- 排行榜数据\n\n# [English]\n### Purpose:\n- Get ranking list of audience in live room\n### Parameters:\n- room_id: Live room id\n- anchor_id: Anchor id\n### Return:\n- Ranking list data\n\n# [示例/Example]\nroom_id = \"7358603858249009962\"\nanchor_id = \"7222941468722758702\"","operationId":"fetch_live_ranking_list_api_v1_tiktok_app_v3_fetch_live_ranking_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间id/Live room id","title":"Room Id"},"description":"直播间id/Live room id","example":"7358603858249009962"},{"name":"anchor_id","in":"query","required":true,"schema":{"type":"string","description":"主播id/Anchor id","title":"Anchor Id"},"description":"主播id/Anchor id","example":"7222941468722758702"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/check_live_room_online":{"get":{"tags":["TikTok-App-V3-API"],"summary":"检测直播间是否在线/Check if live room is online","description":"# [中文]\n### 用途:\n- 检测直播间是否在线\n- 直播间的Room ID可以通过直播间链接从`/api/v1/tiktok/web/get_live_room_id`接口获取\n### 参数:\n- room_id: 直播间id\n### 返回:\n- 是否在线\n\n# [English]\n### Purpose:\n- Check if live room is online\n- The Room ID of the live room can be obtained from the `/api/v1/tiktok/web/get_live_room_id` interface through the live room link\n### Parameters:\n- room_id: Live room id\n### Return:\n- Whether online\n\n# [示例/Example]\nroom_id = \"7358603858249009962\"","operationId":"check_live_room_online_api_v1_tiktok_app_v3_check_live_room_online_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间id/Live room id","title":"Room Id"},"description":"直播间id/Live room id","example":"7358603858249009962"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/check_live_room_online_batch":{"post":{"tags":["TikTok-App-V3-API"],"summary":"批量检测直播间是否在线/Batch check if live rooms are online","description":"# [中文]\n### 用途:\n- 批量检测多个 TikTok 直播间是否在线，最大支持50个直播间ID\n- Room ID 可以通过 `/api/v1/tiktok/web/get_live_room_id` 获取\n### 参数:\n- room_ids: 多个直播间 ID 的数组\n### 返回:\n- 每个直播间的在线状态\n\n# [English]\n### Purpose:\n- Batch check TikTok live rooms' online status, supports up to 50 room IDs\n- Room IDs can be retrieved from `/api/v1/tiktok/web/get_live_room_id`\n### Parameters:\n- room_ids: List of TikTok live room IDs\n### Return:\n- Online status per room\n\n# [示例/Example]\n```\npayload = {\n    \"room_ids\": [\n        \"7494491933781003054\",\n        \"7494514925034113835\"\n    ]\n}\n```","operationId":"check_live_room_online_batch_api_v1_tiktok_app_v3_check_live_room_online_batch_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiveRoomBatchCheckRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/app/v3/fetch_share_short_link":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取分享短链接/Get share short link","description":"# [中文]\n### 用途:\n- 获取分享短链接\n### 参数:\n- url: 长链接或想要转换的链接\n### 返回:\n- 短链接\n\n# [English]\n### Purpose:\n- Get share short link\n### Parameters:\n- url: Long link or link to convert\n### Return:\n- Short link\n\n# [示例/Example]\nurl = \"https://www.tiktok.com/passport/web/logout/\"","operationId":"fetch_share_short_link_api_v1_tiktok_app_v3_fetch_share_short_link_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Url"},"description":"分享链接/Share link","example":"https://www.tiktok.com/passport/web/logout/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_share_qr_code":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取分享二维码/Get share QR code","description":"# [中文]\n### 用途:\n- 获取分享二维码\n### 参数:\n- object_id: 对象id，当前支持个人主页接口响应中的uid作为参数。\n### 返回:\n- 二维码图片\n\n# [English]\n### Purpose:\n- Get share QR code\n### Parameters:\n- object_id: Object id, currently supports the uid in the response of the personal homepage interface as a parameter.\n### Return:\n- QR code image\n\n# [示例/Example]\nurl = \"6762244951259661318\"","operationId":"fetch_share_qr_code_api_v1_tiktok_app_v3_fetch_share_qr_code_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"object_id","in":"query","required":true,"schema":{"type":"string","description":"对象id/Object id","title":"Object Id"},"description":"对象id/Object id","example":"6762244951259661318"},{"name":"schema_type","in":"query","required":false,"schema":{"type":"integer","description":"模式类型/Schema type","default":4,"title":"Schema Type"},"description":"模式类型/Schema type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_product_search":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商品搜索结果/Get product search results","description":"# [中文]\n### 用途:\n- 获取商品搜索结果\n### 参数:\n- keyword: 关键词\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量\n- sort_type: 商品排序条件\n    - 1: 综合排序\n    - 2: 销量排序\n    - 3: 价格从高到低\n    - 4: 价格从低到高\n    - 5: 最新发布\n- customer_review_four_star: 四星以上评价\n- have_discount: 有优惠\n- min_price: 最低价格\n- max_price: 最高价格\n### 返回:\n- 商品搜索结果\n\n# [English]\n### Purpose:\n- Get product search results\n### Parameters:\n- keyword: Keyword\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number\n- sort_type: Product sorting conditions\n    - 1: Comprehensive sorting\n    - 2: Sales volume sorting\n    - 3: Price high to low\n    - 4: Price low to high\n    - 5: Latest release\n- customer_review_four_star: Four-star or more reviews\n- have_discount: Having discount\n- min_price: Minimum price\n- max_price: Maximum price\n### Return:\n- Product search results\n\n# [示例/Example]\nkeyword = \"Cat Toy\"\ncursor = 0\ncount = 12\nsort_type = 1\ncustomer_review_four_star = False\nhave_discount = False\nmin_price = \"10\"\nmax_price = \"25\"","operationId":"fetch_product_search_api_v1_tiktok_app_v3_fetch_product_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"Cat Toy"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":12,"title":"Count"},"description":"数量/Number"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"商品排序条件/Product sorting conditions","default":1,"title":"Sort Type"},"description":"商品排序条件/Product sorting conditions"},{"name":"customer_review_four_star","in":"query","required":false,"schema":{"type":"boolean","description":"四星以上评价/Four-star or more reviews","default":false,"title":"Customer Review Four Star"},"description":"四星以上评价/Four-star or more reviews"},{"name":"have_discount","in":"query","required":false,"schema":{"type":"boolean","description":"有优惠/Having discount","default":false,"title":"Have Discount"},"description":"有优惠/Having discount"},{"name":"min_price","in":"query","required":false,"schema":{"type":"string","description":"最低价格/Minimum price","default":"","title":"Min Price"},"description":"最低价格/Minimum price"},{"name":"max_price","in":"query","required":false,"schema":{"type":"string","description":"最高价格/Maximum price","default":"","title":"Max Price"},"description":"最高价格/Maximum price"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_creator_info":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取带货创作者信息/Get shopping creator information","description":"# [中文]\n### 用途:\n- 获取创作者信息，包括创作者的基本信息、粉丝数、橱窗商品数量、带货直播间等信息。\n### 参数:\n- creator_uid: 创作者uid\n### 返回:\n- 创作者信息\n\n# [English]\n### Purpose:\n- Get creator information, including the creator's basic information, number of fans, number of storefront products, shop live room and other information.\n### Parameters:\n- creator_uid: Creator uid\n### Return:\n- Creator information\n\n# [示例/Example]\ncreator_uid = \"6555451606845243393\"\n\n# [示例响应/Example Response]\nresponse = {\n    \"code\": 200,\n    \"request_id\": \"d5575d80-a8cc-44ab-a46a-b62c2e967829\",\n    \"router\": \"/api/v1/tiktok/app/v3/fetch_creator_info\",\n    \"params\": {\n        \"creator_uid\": \"6555451606845243393\"\n    },\n    \"data\": {\n        \"code\": 0,\n        \"data\": {\n            \"creator_info\": {\n                \"creator_id\": \"6555451606845243393\",\n                \"creator_name\": \"louissescarlettFamily's showcase\",\n                \"avatar\": {\n                    \"uri\": \"720x720/tos-alisg-avt-0068/28257cac3d733b5e4bc12655685fc248\",\n                    \"url_list\": [\n                        \"https://p19-common-sign-sg.tiktokcdn-us.com/tos-alisg-avt-0068/28257cac3d733b5e4bc12655685fc248~tplv-tiktokx-cropcenter:720:720.webp?dr=9640&refresh_token=fd81a69e&x-expires=1756022400&x-signature=neQwNv%2BxfA4YPnLFb51270Zi8Ps%3D&t=4d5b0474&ps=13740610&shp=a5d48078&shcp=85ba3243&idc=useast5\",\n                        \"https://p16-common-sign-sg.tiktokcdn-us.com/tos-alisg-avt-0068/28257cac3d733b5e4bc12655685fc248~tplv-tiktokx-cropcenter:720:720.webp?dr=9640&refresh_token=723df957&x-expires=1756022400&x-signature=9q4A2SUIO%2B42lqTsrVkkpks54dI%3D&t=4d5b0474&ps=13740610&shp=a5d48078&shcp=85ba3243&idc=useast5\",\n                        \"https://p19-common-sign-sg.tiktokcdn-us.com/tos-alisg-avt-0068/28257cac3d733b5e4bc12655685fc248~tplv-tiktokx-cropcenter:720:720.jpeg?dr=9640&refresh_token=d63d422b&x-expires=1756022400&x-signature=sycMEH0640dpjl%2BK0nDy1ZPbtxs%3D&t=4d5b0474&ps=13740610&shp=a5d48078&shcp=85ba3243&idc=useast5\"\n                    ]\n                },\n                \"followers_info\": {\n                    \"count\": \"18017938\",\n                    \"count_info\": \"18.0M followers\",\n                    \"value\": 18017938,\n                    \"count_format\": \"18.0M\"\n                },\n                \"sold_count_info\": {\n                    \"count\": \"0\",\n                    \"value\": 0\n                },\n                \"bg_pic\": {\n                    \"uri\": \"tos-alisg-i-aphluv4xwc-sg/72edb551d7c77636678a5518cdddfd1c.jpg\",\n                    \"url_list\": [\n                        \"https://p19-oec-general.ttcdn-us.com/tos-alisg-i-aphluv4xwc-sg/72edb551d7c77636678a5518cdddfd1c.jpg~tplv-fhlh96nyum-resize-jpeg:1600:1600.jpeg?dr=12186&t=555f072d&ps=933b5bde&shp=4ee6669e&shcp=9b759fb9&idc=useast5&from=1323722398\",\n                        \"https://p16-oec-general.ttcdn-us.com/tos-alisg-i-aphluv4xwc-sg/72edb551d7c77636678a5518cdddfd1c.jpg~tplv-fhlh96nyum-resize-jpeg:1600:1600.jpeg?dr=12186&t=555f072d&ps=933b5bde&shp=4ee6669e&shcp=9b759fb9&idc=useast5&from=1323722398\"\n                    ]\n                },\n                \"is_banned\": false,\n                \"sec_user_id\": \"MS4wLjABAAAARujvKaVWqgbVCwuxQghA99TUa5I-4g6jVzMXZd9FJIXSdJwJM47vm4-2T1K3gsux\",\n                \"follow_status_extended\": 0,\n                \"show_follow_button\": false,\n                \"can_share\": false,\n                \"show_commission_paid\": \"Creator earns commission\",\n                \"product_count_info\": {\n                    \"count\": \"713\",\n                    \"count_info\": \"713 products\",\n                    \"value\": 713,\n                    \"count_format\": \"713\"\n                },\n                \"dark_bg_pic_new\": {\n                    \"uri\": \"tos-maliva-i-acgf4d7es9-us/showcase_header_v2_dark.png\",\n                    \"url_list\": [\n                        \"https://p16-oec-general.ttcdn-us.com/tos-maliva-i-acgf4d7es9-us/showcase_header_v2_dark.png~tplv-fhlh96nyum-resize-jpeg:1170:699.jpeg?dr=12186&t=555f072d&ps=933b5bde&shp=4ee6669e&shcp=9b759fb9&idc=useast5&from=1323722398\",\n                        \"https://p19-oec-general.ttcdn-us.com/tos-maliva-i-acgf4d7es9-us/showcase_header_v2_dark.png~tplv-fhlh96nyum-resize-jpeg:1170:699.jpeg?dr=12186&t=555f072d&ps=933b5bde&shp=4ee6669e&shcp=9b759fb9&idc=useast5&from=1323722398\"\n                    ]\n                },\n                \"light_bg_pic_new\": {\n                    \"uri\": \"tos-maliva-i-acgf4d7es9-us/showcase_header_v2_light.png\",\n                    \"url_list\": [\n                        \"https://p16-oec-general.ttcdn-us.com/tos-maliva-i-acgf4d7es9-us/showcase_header_v2_light.png~tplv-fhlh96nyum-resize-jpeg:1170:699.jpeg?dr=12186&t=555f072d&ps=933b5bde&shp=4ee6669e&shcp=9b759fb9&idc=useast5&from=1323722398\",\n                        \"https://p19-oec-general.ttcdn-us.com/tos-maliva-i-acgf4d7es9-us/showcase_header_v2_light.png~tplv-fhlh96nyum-resize-jpeg:1170:699.jpeg?dr=12186&t=555f072d&ps=933b5bde&shp=4ee6669e&shcp=9b759fb9&idc=useast5&from=1323722398\"\n                    ]\n                },\n                \"is_new_header\": true,\n                \"dynamic_header\": {\n                    \"is_dynamic\": false,\n                    \"delay_time\": 0\n                },\n                \"extra_val\": {\n                    \"showcase_no_product_show_less_screen\": \"0\",\n                    \"us_uk_show_voucher_info\": \"0\"\n                }\n            },\n            \"live_info\": {\n                \"room_id\": \"7541231942331566853\",\n                \"upcoming_event_time\": \"1756141200\"\n            },\n            \"diversion_module\": 0\n        },\n        \"message\": \"success\"\n    }\n}","operationId":"fetch_creator_info_api_v1_tiktok_app_v3_fetch_creator_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"creator_uid","in":"query","required":true,"schema":{"type":"string","description":"创作者uid/Creator uid","title":"Creator Uid"},"description":"创作者uid/Creator uid","example":"6555451606845243393"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_creator_showcase_product_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取创作者橱窗商品列表/Get creator showcase product list","description":"# [中文]\n### 用途:\n- 获取创作者橱窗商品列表\n### 参数:\n- kol_id: 创作者的sec_user_id\n- count: 数量\n- next_scroll_param: 翻页参数，第一页为空字符串，后续请求使用上一次请求返回的next_scroll_param值。\n### 返回:\n- 创作者橱窗商品列表\n\n# [English]\n### Purpose:\n- Get creator showcase product list\n### Parameters:\n- kol_id: Creator's sec_user_id\n- count: Number\n- next_scroll_param: Page parameter, empty string for the first page, use the next_scroll_param value returned by the last request for subsequent requests.\n### Return:\n- Creator showcase product list\n\n# [示例/Example]\nkol_id = \"MS4wLjABAAAARujvKaVWqgbVCwuxQghA99TUa5I-4g6jVzMXZd9FJIXSdJwJM47vm4-2T1K3gsux\"\ncount = 20\nnext_scroll_param = \"\"","operationId":"fetch_creator_showcase_product_list_api_v1_tiktok_app_v3_fetch_creator_showcase_product_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kol_id","in":"query","required":true,"schema":{"type":"string","description":"创作者的sec_user_id/Creator's sec_user_id","title":"Kol Id"},"description":"创作者的sec_user_id/Creator's sec_user_id","example":"MS4wLjABAAAARujvKaVWqgbVCwuxQghA99TUa5I-4g6jVzMXZd9FJIXSdJwJM47vm4-2T1K3gsux"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"next_scroll_param","in":"query","required":false,"schema":{"type":"string","description":"翻页参数/Page parameter","default":"","title":"Next Scroll Param"},"description":"翻页参数/Page parameter"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_shop_id_by_share_link":{"get":{"tags":["TikTok-App-V3-API"],"summary":"通过分享链接获取店铺ID/Get Shop ID by Share Link","description":"# [中文]\n### 用途:\n- 通过分享链接获取店铺ID\n### 参数:\n- share_link: 分享链接\n### 返回:\n- 店铺ID\n\n# [English]\n### Purpose:\n- Get Shop ID by Share Link\n### Parameters:\n- share_link: Share link\n### Return:\n- Shop ID\n\n# [示例/Example]\nshare_link = \"https://vt.tiktok.com/ZT2AHoGsE/\"","operationId":"fetch_shop_id_by_share_link_api_v1_tiktok_app_v3_fetch_shop_id_by_share_link_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_link","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Link"},"description":"分享链接/Share link","example":"https://vt.tiktok.com/ZT2AHoGsE/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_product_id_by_share_link":{"get":{"tags":["TikTok-App-V3-API"],"summary":"通过分享链接获取商品ID/Get Product ID by Share Link","description":"# [中文]\n### 用途:\n- 通过分享链接获取商品ID\n### 参数:\n- share_link: 分享链接\n### 返回:\n- 商品ID\n\n# [English]\n### Purpose:\n- Get Product ID by Share Link\n### Parameters:\n- share_link: Share link\n### Return:\n- Product ID\n\n# [示例/Example]\nshare_link = \"https://www.tiktok.com/t/ZT2A9N1kw/\"\nshare_link2 = \"https://affiliate-us.tiktok.com/api/v1/share/AJ4hS3OdXmSg\"","operationId":"fetch_product_id_by_share_link_api_v1_tiktok_app_v3_fetch_product_id_by_share_link_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_link","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Link"},"description":"分享链接/Share link","example":"https://www.tiktok.com/t/ZT2A9N1kw/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_product_detail":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商品详情数据（即将弃用，使用 fetch_product_detail_v2 代替）/Get product detail data (will be deprecated, use fetch_product_detail_v2 instead)","description":"# [中文]\n### 用途:\n- 获取商品详情数据\n- 即将弃用，使用 fetch_product_detail_v2 代替\n### 参数:\n- product_id: 商品id，有时候需要从product_id_str字段中获取。\n### 返回:\n- 商品详情数据\n\n# [English]\n### Purpose:\n- Get product detail data\n- Will be deprecated, use fetch_product_detail_v2 instead\n### Parameters:\n- product_id: Product id, sometimes need to get from the product_id_str field.\n### Return:\n- Product detail data\n\n# [示例/Example]\nproduct_id = \"1729385239712731370\"","operationId":"fetch_product_detail_api_v1_tiktok_app_v3_fetch_product_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品id/Product id","title":"Product Id"},"description":"商品id/Product id","example":"1729385239712731370"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_product_detail_v2":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商品详情数据V2/Get product detail data V2","description":"# [中文]\n### 用途:\n- 获取商品详情数据V2\n### 参数:\n- product_id: 商品id，有时候需要从product_id_str字段中获取。\n### 返回:\n- 商品详情数据V2\n\n# [English]\n### Purpose:\n- Get product detail data V2\n### Parameters:\n- product_id: Product id, sometimes need to get from the product_id_str field.\n### Return:\n- Product detail data V2\n\n# [示例/Example]\nproduct_id = \"1729385239712731370\"","operationId":"fetch_product_detail_v2_api_v1_tiktok_app_v3_fetch_product_detail_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品id/Product id","title":"Product Id"},"description":"商品id/Product id","example":"1729385239712731370"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_product_detail_v3":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商品详情数据V3 / Get product detail data V3","description":"# [中文]\n### 用途:\n- 获取商品详情数据V3。如果商品详情数据V2无法获取，可以尝试使用此接口。\n\n### 参数:\n- product_id: 商品id，有时候需要从 `product_id_str` 字段中获取，也可以从商品分享链接中获取。\n- region: 商品的国家/地区代码，默认值为 \"US\"。\n\n### 支持的国家/地区代码（按区域分组）：\n- 东南亚 Southeast Asia:\n  ID（印度尼西亚）, SG（新加坡）, MY（马来西亚）, PH（菲律宾）, TH（泰国）\n- 北美 North America:\n  US（美国）, MX（墨西哥）\n- 欧洲 Europe:\n  IE（爱尔兰）, GB（英国）, ES（西班牙）\n- 越南 Vietnam:\n  VN（越南）\n\n### 返回:\n- 商品详情数据V3\n\n# [English]\n### Purpose:\n- Get product detail data V3. If product detail data V2 cannot be retrieved, try this version.\n\n### Parameters:\n- product_id: Product ID. Sometimes needs to be extracted from `product_id_str` field, or can be obtained from the product share link.\n- region: Country code of the product, default is \"US\".\n\n### Supported region codes (grouped by area):\n- Southeast Asia:\n  ID (Indonesia), SG (Singapore), MY (Malaysia), PH (Philippines), TH (Thailand)\n- North America:\n  US (United States), MX (Mexico)\n- Europe:\n  IE (Ireland), GB (United Kingdom), ES (Spain)\n- Vietnam:\n  VN (Vietnam)\n\n### Return:\n- Product detail data V3\n\n# [示例 / Example]\nproduct_id = \"1729385239712731370\"\nregion = \"US\"","operationId":"fetch_product_detail_v3_api_v1_tiktok_app_v3_fetch_product_detail_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品id / Product ID","title":"Product Id"},"description":"商品id / Product ID","example":"1729385239712731370"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"商品的国家/地区代码/ Country/region code of the product","default":"US","title":"Region"},"description":"商品的国家/地区代码/ Country/region code of the product","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_product_detail_v4":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商品详情数据V4 / Get product detail data V4","description":"# [中文]\n### 用途:\n- 获取商品详情数据V4。如果商品详情数据V3无法获取，可以尝试使用此接口。\n\n### 参数:\n- product_id: 商品id，有时候需要从 `product_id_str` 字段中获取，也可以从商品分享链接中获取。\n- region: 商品的国家/地区代码，默认值为 \"US\"。\n\n### 支持的国家/地区代码（按区域分组）：\n- 东南亚 Southeast Asia:\n  ID（印度尼西亚）, SG（新加坡）, MY（马来西亚）, PH（菲律宾）, TH（泰国）\n- 北美 North America:\n  US（美国）, MX（墨西哥）\n- 欧洲 Europe:\n  IE（爱尔兰）, GB（英国）, ES（西班牙）\n- 越南 Vietnam:\n  VN（越南）\n\n### 返回:\n- 商品详情数据V4\n\n# [English]\n### Purpose:\n- Get product detail data V4. If product detail data V3 cannot be retrieved, try this version.\n\n### Parameters:\n- product_id: Product ID. Sometimes needs to be extracted from `product_id_str` field, or can be obtained from the product share link.\n- region: Country code of the product, default is \"US\".\n\n### Supported region codes (grouped by area):\n- Southeast Asia:\n  ID (Indonesia), SG (Singapore), MY (Malaysia), PH (Philippines), TH (Thailand)\n- North America:\n  US (United States), MX (Mexico)\n- Europe:\n  IE (Ireland), GB (United Kingdom), ES (Spain)\n- Vietnam:\n  VN (Vietnam)\n\n### Return:\n- Product detail data V4\n\n# [示例 / Example]\nseller_id = \"8646929864612614278\"\nproduct_id = \"1729385239712731370\"\nregion = \"US\"","operationId":"fetch_product_detail_v4_api_v1_tiktok_app_v3_fetch_product_detail_v4_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品id / Product ID","title":"Product Id"},"description":"商品id / Product ID","example":"1729385239712731370"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"商品的国家/地区代码/ Country/region code of the product","default":"US","title":"Region"},"description":"商品的国家/地区代码/ Country/region code of the product","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_product_review":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商品评价数据/Get product review data","description":"# [中文]\n### 用途:\n- 获取商品评价数据\n### 参数:\n- product_id: 商品id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- size: 数量\n- filter_id: 筛选条件\n    - 0: 全部评价\n    - 1: 1星评价\n    - 2: 2星评价\n    - 3: 3星评价\n    - 4: 4星评价\n    - 5: 5星评价\n    - 102: 有图评价\n    - 104: 已购买的评价\n- sort_type: 排序条件\n    - 1: 相关度\n    - 2: 从新到旧\n### 返回:\n- 商品评价数据\n\n# [English]\n### Purpose:\n- Get product review data\n### Parameters:\n- product_id: Product id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- size: Count number\n- filter_id: Filter condition\n    - 0: All reviews\n    - 1: 1-star review\n    - 2: 2-star review\n    - 3: 3-star review\n    - 4: 4-star review\n    - 5: 5-star review\n    - 102: Reviews with pictures\n    - 104: Reviews of purchased products\n- sort_type: Sorting conditions\n    - 1: Relevance\n    - 2: New to old\n### Return:\n- Product review data\n\n# [示例/Example]\nproduct_id = \"1729448812983194615\"\ncursor = 0\nsize = 10\nfilter_id = 0\nsort_type = 0","operationId":"fetch_product_review_api_v1_tiktok_app_v3_fetch_product_review_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品id/Product id","title":"Product Id"},"description":"商品id/Product id","example":"1729448812983194615"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":10,"title":"Size"},"description":"数量/Number"},{"name":"filter_id","in":"query","required":false,"schema":{"type":"integer","description":"筛选条件/Filter condition","default":0,"title":"Filter Id"},"description":"筛选条件/Filter condition"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序条件/Sorting conditions","default":0,"title":"Sort Type"},"description":"排序条件/Sorting conditions"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_shop_home_page_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商家主页Page列表数据/Get shop home page list data","description":"# [中文]\n### 用途:\n- 获取商家主页Page列表数据, 用于商家主页展示，以及爬取商家主页的商品数据\n### 参数:\n- seller_id: 商家id,店铺id\n### 返回:\n- 商家主页Page列表数据\n\n# [English]\n### Purpose:\n- Get shop home page list data, used for shop home page display, and crawling shop home page product data\n### Parameters:\n- seller_id: Seller id, shop id\n### Return:\n- Shop home page list data\n\n# [示例/Example]\nseller_id = \"8646929864612614278\"","operationId":"fetch_shop_home_page_list_api_v1_tiktok_app_v3_fetch_shop_home_page_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"seller_id","in":"query","required":true,"schema":{"type":"string","description":"商家id,店铺id/Seller id, shop id","title":"Seller Id"},"description":"商家id,店铺id/Seller id, shop id","example":"8646929864612614278"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_shop_home":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商家主页数据/Get shop home page data","description":"# [中文]\n### 用途:\n- 获取商家主页的商品数据\n### 参数:\n- page_id: 爬取的商家主页Page id，可以从`fetch_shop_home_page_list`这个接口获取\n- seller_id: 商家id,店铺id\n### 返回:\n- 商家主页数据\n\n# [English]\n### Purpose:\n- Get product data of the shop home page\n### Parameters:\n- page_id: Page id of the crawled shop home page, which can be obtained from the interface `fetch_shop_home_page_list`\n- seller_id: Seller id, shop id\n### Return:\n- Shop home page data\n\n# [示例/Example]\npage_id = \"7314705727611930410\"\nseller_id = \"8646929864612614278\"","operationId":"fetch_shop_home_api_v1_tiktok_app_v3_fetch_shop_home_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page_id","in":"query","required":true,"schema":{"type":"string","description":"爬取的商家主页Page id/Page id of the crawled shop home page","title":"Page Id"},"description":"爬取的商家主页Page id/Page id of the crawled shop home page","example":"7314705727611930410"},{"name":"seller_id","in":"query","required":true,"schema":{"type":"string","description":"商家id,店铺id/Seller id, shop id","title":"Seller Id"},"description":"商家id,店铺id/Seller id, shop id","example":"8646929864612614278"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_shop_product_recommend":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商家商品推荐数据/Get shop product recommend data","description":"# [中文]\n### 用途:\n- 获取商家商品推荐数据\n### 参数:\n- seller_id: 商家id,店铺id\n- scroll_param: 滚动参数，用于加载更多商品数据\n- page_size: 每页数量\n### 返回:\n- 商家商品推荐数据\n\n# [English]\n### Purpose:\n- Get shop product recommend data\n### Parameters:\n- seller_id: Seller id, shop id\n- scroll_param: Scroll parameter, used to load more product data\n- page_size: Number per page\n### Return:\n- Shop product recommend data\n\n# [示例/Example]\nseller_id = \"8646929864612614278\"\nscroll_param = \"\"\npage_size = 10","operationId":"fetch_shop_product_recommend_api_v1_tiktok_app_v3_fetch_shop_product_recommend_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"seller_id","in":"query","required":true,"schema":{"type":"string","description":"商家id,店铺id/Seller id, shop id","title":"Seller Id"},"description":"商家id,店铺id/Seller id, shop id","example":"8646929864612614278"},{"name":"scroll_param","in":"query","required":false,"schema":{"type":"string","description":"滚动参数，用于加载更多商品数据/Scroll parameter, used to load more product data","default":"","title":"Scroll Param"},"description":"滚动参数，用于加载更多商品数据/Scroll parameter, used to load more product data"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":10,"title":"Page Size"},"description":"每页数量/Number per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_shop_product_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商家商品列表数据/Get shop product list data","description":"# [中文]\n### 用途:\n- 获取商家商品列表数据\n### 参数:\n- seller_id: 商家id,店铺id\n- scroll_params: 滚动参数，用于加载更多商品数据\n- page_size: 每页数量\n- sort_field: 排序字段\n    - 1: 综合排序\n    - 3: 最新发布\n    - 4: 销量最好\n    - 5: 价格排序\n- sort_order: 排序方式\n    - 0: 默认价格排序\n    - 1: 价格从高到低\n    - 2: 价格从低到高\n### 返回:\n- 商家商品列表数据\n\n# [English]\n### Purpose:\n- Get shop product list data\n### Parameters:\n- seller_id: Seller id, shop id\n- scroll_params: Scroll parameter, used to load more product data\n- page_size: Number per page\n- sort_field: Sorting field\n    - 1: Comprehensive sorting\n    - 3: Latest release\n    - 4: Best sales\n    - 5: Price sorting\n- sort_order: Sorting method\n    - 0: Default price sorting\n    - 1: Price high to low\n    - 2: Price low to high\n### Return:\n- Shop product list data\n\n# [示例/Example]\nseller_id = \"8646929864612614278\"\nscroll_params = \"\"\npage_size = 10\nsort_field = 1\nsort_order = 0","operationId":"fetch_shop_product_list_api_v1_tiktok_app_v3_fetch_shop_product_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"seller_id","in":"query","required":true,"schema":{"type":"string","description":"商家id,店铺id/Seller id, shop id","title":"Seller Id"},"description":"商家id,店铺id/Seller id, shop id","example":"8646929864612614278"},{"name":"scroll_params","in":"query","required":false,"schema":{"type":"string","description":"滚动参数，用于加载更多商品数据/Scroll parameter, used to load more product data","default":"","title":"Scroll Params"},"description":"滚动参数，用于加载更多商品数据/Scroll parameter, used to load more product data"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":10,"title":"Page Size"},"description":"每页数量/Number per page"},{"name":"sort_field","in":"query","required":false,"schema":{"type":"integer","description":"排序字段/Sorting field","default":1,"title":"Sort Field"},"description":"排序字段/Sorting field"},{"name":"sort_order","in":"query","required":false,"schema":{"type":"integer","description":"排序方式/Sorting method","default":0,"title":"Sort Order"},"description":"排序方式/Sorting method"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_shop_product_list_v2":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商家商品列表数据 V2/Get shop product list data V2","description":"# [中文]\n### 用途:\n- 获取商家商品列表数据\n### 参数:\n- seller_id: 商家id,店铺id\n- scroll_params: 滚动参数，用于加载更多商品数据\n- page_size: 每页数量\n- sort_field: 排序字段\n    - 1: 综合排序\n    - 3: 最新发布\n    - 4: 销量最好\n    - 5: 价格排序\n- sort_order: 排序方式\n    - 0: 默认价格排序\n    - 1: 价格从高到低\n    - 2: 价格从低到高\n### 返回:\n- 商家商品列表数据\n\n# [English]\n### Purpose:\n- Get shop product list data\n### Parameters:\n- seller_id: Seller id, shop id\n- scroll_params: Scroll parameter, used to load more product data\n- page_size: Number per page\n- sort_field: Sorting field\n    - 1: Comprehensive sorting\n    - 3: Latest release\n    - 4: Best sales\n    - 5: Price sorting\n- sort_order: Sorting method\n    - 0: Default price sorting\n    - 1: Price high to low\n    - 2: Price low to high\n### Return:\n- Shop product list data\n\n# [示例/Example]\nseller_id = \"8646929864612614278\"\nscroll_params = \"\"\npage_size = 10\nsort_field = 1\nsort_order = 0","operationId":"fetch_shop_product_list_v2_api_v1_tiktok_app_v3_fetch_shop_product_list_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"seller_id","in":"query","required":true,"schema":{"type":"string","description":"商家id,店铺id/Seller id, shop id","title":"Seller Id"},"description":"商家id,店铺id/Seller id, shop id","example":"8646929864612614278"},{"name":"scroll_params","in":"query","required":false,"schema":{"type":"string","description":"滚动参数，用于加载更多商品数据/Scroll parameter, used to load more product data","default":"","title":"Scroll Params"},"description":"滚动参数，用于加载更多商品数据/Scroll parameter, used to load more product data"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":10,"title":"Page Size"},"description":"每页数量/Number per page"},{"name":"sort_field","in":"query","required":false,"schema":{"type":"integer","description":"排序字段/Sorting field","default":1,"title":"Sort Field"},"description":"排序字段/Sorting field"},{"name":"sort_order","in":"query","required":false,"schema":{"type":"integer","description":"排序方式/Sorting method","default":0,"title":"Sort Order"},"description":"排序方式/Sorting method"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_shop_info":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商家信息数据/Get shop information data","description":"# [中文]\n### 用途:\n- 获取商家信息数据\n### 参数:\n- shop_id: 商家id,店铺id\n### 返回:\n- 商家信息数据\n\n# [English]\n### Purpose:\n- Get shop information data\n### Parameters:\n- shop_id: Seller id, shop id\n### Return:\n- Shop information data\n\n# [示例/Example]\nshop_id = \"8646942781241463007\"","operationId":"fetch_shop_info_api_v1_tiktok_app_v3_fetch_shop_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"shop_id","in":"query","required":true,"schema":{"type":"string","description":"商家id,店铺id/Seller id, shop id","title":"Shop Id"},"description":"商家id,店铺id/Seller id, shop id","example":"8646942781241463007"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_shop_product_category":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取商家产品分类数据/Get shop product category data","description":"# [中文]\n### 用途:\n- 获取商家产品分类数据\n### 参数:\n- seller_id: 商家id,店铺id\n### 返回:\n- 商家产品分类数据\n\n# [English]\n### Purpose:\n- Get shop product category data\n### Parameters:\n- seller_id: Seller id, shop id\n### Return:\n- Shop product category data\n\n# [示例/Example]\nseller_id = \"7495294980909468039\"","operationId":"fetch_shop_product_category_api_v1_tiktok_app_v3_fetch_shop_product_category_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"seller_id","in":"query","required":true,"schema":{"type":"string","description":"商家id,店铺id/Seller id, shop id","title":"Seller Id"},"description":"商家id,店铺id/Seller id, shop id","example":"7495294980909468039"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_live_daily_rank":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取直播每日榜单数据/Get live daily rank data","description":"# [中文]\n### 用途:\n- 获取直播每日榜单数据\n### 参数:\n- anchor_id: 主播id，可以从直播间信息接口获取，使用默认值即可，该参数会影响返回的数据，你可以尝试不同直播间的主播id。\n- room_id: 直播间id，可以从直播间信息接口获取，使用默认值即可，该参数会影响返回的数据，你可以尝试不同直播间的id。\n- rank_type: 榜单类型，参数值如下表：\n\n    | type | rankName | 分组类型 | 说明 |\n    |------|----------|----------|------|\n    | 0 | `hourly_rank` | GIFT_RANK | 小时榜 |\n    | 1 | `weekly_rank` | GIFT_RANK | 周榜 |\n    | 5 | `rookie_star_rank` | GIFT_RANK | 新星榜 |\n    | 6 | `sale_rank` | E_COMMERCE | 带货榜 |\n    | 8 | `daily_rank` | GIFT_RANK | 日榜 |\n    | 10 | `weekly_game_rank` | GAME_RANK | 周游戏榜 |\n    | 11 | `daily_game_rank` | GAME_RANK | 日游戏榜 |\n    | 12 | `hall_of_fame_rank` | GIFT_RANK | 名人堂 |\n    | 13 | `champion_tournament` | GIFT_RANK | 冠军赛（含phase_one/two/three） |\n    | 14 | `daily_rookie_star_rank` | GIFT_RANK | 日新星榜 |\n    | 15 | `fans_team_rank` | GIFT_RANK | 粉丝团榜 |\n    | 16 | `ranking_league` | GIFT_RANK | 排位联赛（App内显示: D5段位榜） |\n    | 20 | `pubg` | GAME_RANK | PUBG游戏榜 |\n    | 21 | `mlbb` | GAME_RANK | MLBB游戏榜（Mobile Legends: Bang Bang） |\n    | 22 | `free_fire` | GAME_RANK | Free Fire游戏榜 |\n    | 23 | `sub_weekly_game_rank1` | GAME_RANK | 子周游戏榜1 |\n    | 24 | `sub_weekly_game_rank2` | GAME_RANK | 子周游戏榜2 |\n    | 25 | `sub_weekly_game_rank3` | GAME_RANK | 子周游戏榜3 |\n    | 26 | `collectibles` | E_COMMERCE | 收藏品榜 |\n    | 27 | `beauty` | E_COMMERCE | 美妆榜 |\n    | 28 | `women_wear` | E_COMMERCE | 女装榜 |\n    | 29 | `sale_rank_daily` | E_COMMERCE | 日带货榜 |\n    | 1001 | `league_campaign_rank` | GIFT_RANK | 联赛活动榜 |\n    | -1 | `unknown` | DEFAULT | 未知 |\n\n- region_type: 地区类型，使用默认值即可，具体含义不明。\n- gap_interval: 时间间隔，使用默认值代表当天，使用-1代表排名记录。\n- cookie: 用户自己的cookie，可选参数，用于接口不可用时使用。\n### 返回:\n- 直播每日榜单数据\n\n# [English]\n### Purpose:\n- Get live daily rank data\n### Parameters:\n- anchor_id: Anchor id, which can be obtained from the live room information interface, use the default value, this parameter will affect the returned data, you can try different anchor ids of different live rooms.\n- room_id: Live room id, which can be obtained from the live room information interface, use the default value, this parameter will affect the returned data, you can try different room ids of different live rooms.\n- rank_type: Rank type, parameter values are as follows:\n\n    | type | rankName | Group Type | Description |\n    |------|----------|------------|-------------|\n    | 0 | `hourly_rank` | GIFT_RANK | Hourly Rank |\n    | 1 | `weekly_rank` | GIFT_RANK | Weekly Rank |\n    | 5 | `rookie_star_rank` | GIFT_RANK | Rookie Star Rank |\n    | 6 | `sale_rank` | E_COMMERCE | Sale Rank |\n    | 8 | `daily_rank` | GIFT_RANK | Daily Rank |\n    | 10 | `weekly_game_rank` | GAME_RANK | Weekly Game Rank |\n    | 11 | `daily_game_rank` | GAME_RANK | Daily Game Rank |\n    | 12 | `hall_of_fame_rank` | GIFT_RANK | Hall of Fame Rank |\n    | 13 | `champion_tournament` | GIFT_RANK | Champion Tournament (includes phase_one/two/three) |\n    | 14 | `daily_rookie_star_rank` | GIFT_RANK | Daily Rookie Star Rank |\n    | 15 | `fans_team_rank` | GIFT_RANK | Fans Team Rank |\n    | 16 | `ranking_league` | GIFT_RANK | Ranking League (App display: D5 Level Rank) |\n    | 20 | `pubg` | GAME_RANK | PUBG Rank |\n    | 21 | `mlbb` | GAME_RANK | MLBB Rank (Mobile Legends: Bang Bang) |\n    | 22 | `free_fire` | GAME_RANK | Free Fire Rank |\n    | 23 | `sub_weekly_game_rank1` | GAME_RANK | Sub Weekly Game Rank 1 |\n    | 24 | `sub_weekly_game_rank2` | GAME_RANK | Sub Weekly Game Rank 2 |\n    | 25 | `sub_weekly_game_rank3` | GAME_RANK | Sub Weekly Game Rank 3 |\n    | 26 | `collectibles` | E_COMMERCE | Collectibles Rank |\n    | 27 | `beauty` | E_COMMERCE | Beauty Rank |\n    | 28 | `women_wear` | E_COMMERCE | Women Wear Rank |\n    | 29 | `sale_rank_daily` | E_COMMERCE | Daily Sale Rank |\n    | 1001 | `league_campaign_rank` | GIFT_RANK | League Campaign Rank |\n    | -1 | `unknown` | DEFAULT | Unknown |\n\n- region_type: Region type, use the default value, the specific meaning is unknown.\n- gap_interval: Time interval, use the default value to represent the current day, use -1 to represent the ranking record.\n- cookie: User's own cookie, optional parameter, used when the interface is not available.\n### Return:\n- Live daily rank data","operationId":"fetch_live_daily_rank_api_v1_tiktok_app_v3_fetch_live_daily_rank_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"anchor_id","in":"query","required":false,"schema":{"type":"string","description":"主播id/Anchor id","default":"6952422426752205830","title":"Anchor Id"},"description":"主播id/Anchor id"},{"name":"room_id","in":"query","required":false,"schema":{"type":"string","description":"直播间id/Live room id","default":"7380221319910312750","title":"Room Id"},"description":"直播间id/Live room id"},{"name":"rank_type","in":"query","required":false,"schema":{"type":"integer","description":"榜单类型/Rank type","default":8,"title":"Rank Type"},"description":"榜单类型/Rank type"},{"name":"region_type","in":"query","required":false,"schema":{"type":"integer","description":"地区类型/Region type","default":1,"title":"Region Type"},"description":"地区类型/Region type"},{"name":"gap_interval","in":"query","required":false,"schema":{"type":"integer","description":"时间间隔/Time interval","default":0,"title":"Gap Interval"},"description":"时间间隔/Time interval"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户自己的cookie/User's own cookie","default":"","title":"Cookie"},"description":"用户自己的cookie/User's own cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_user_music_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取用户音乐列表数据/Get user music list data","description":"# [中文]\n### 用途:\n- 获取用户音乐列表数据\n### 参数:\n- sec_uid: 用户sec_uid\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量\n### 返回:\n- 用户音乐列表数据\n\n# [English]\n### Purpose:\n- Get user music list data\n### Parameters:\n- sec_uid: User sec_uid\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number\n\n# [示例/Example]\nsec_uid = \"MS4wLjABAAAAqB08cUbXaDWqbD6MCga2RbGTuhfO2EsHayBYx08NDrN7IE3jQuRDNNN6YwyfH6_6\"\ncursor = 0\ncount = 10","operationId":"fetch_user_music_list_api_v1_tiktok_app_v3_fetch_user_music_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_uid/User sec_uid","title":"Sec Uid"},"description":"用户sec_uid/User sec_uid","example":"MS4wLjABAAAAqB08cUbXaDWqbD6MCga2RbGTuhfO2EsHayBYx08NDrN7IE3jQuRDNNN6YwyfH6_6"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":10,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_content_translate":{"post":{"tags":["TikTok-App-V3-API"],"summary":"获取内容翻译数据/Get content translation data","description":"# [中文]\n### 用途:\n- 获取内容翻译数据\n### 参数:\n- trg_lang: 目标语言\n    - zh-Hans: 简体中文\n    - zh-Hant: 繁体中文\n    - en: 英语\n    - ja: 日语\n    - ko: 韩语\n    - fr: 法语\n    - de: 德语\n    - ru: 俄语\n    - es: 西班牙语\n    - pt: 葡萄牙语\n    - vi: 越南语\n    - th: 泰语\n    - id: 印尼语\n    - ar: 阿拉伯语\n    - it: 意大利语\n    - tr: 土耳其语\n    - he: 希伯来语\n    - pl: 波兰语\n    - nl: 荷兰语\n    - sv: 瑞典语\n    - da: 丹麦语\n    - fi: 芬兰语\n    - no: 挪威语\n    - cs: 捷克语\n    - hu: 匈牙利语\n- src_content: 源内容，也就是需要翻译的内容，长度不超过5000个字符，如果超过5000个字符，只会翻译前5000个字符。\n### 返回:\n- 内容翻译数据\n\n# [English]\n### Purpose:\n- Get content translation data\n### Parameters:\n- trg_lang: Target language\n    - zh-Hans: Simplified Chinese\n    - zh-Hant: Traditional Chinese\n    - en: English\n    - ja: Japanese\n    - ko: Korean\n    - fr: French\n    - de: German\n    - ru: Russian\n    - es: Spanish\n    - pt: Portuguese\n    - vi: Vietnamese\n    - th: Thai\n    - id: Indonesian\n    - ar: Arabic\n    - it: Italian\n    - tr: Turkish\n    - he: Hebrew\n    - pl: Polish\n    - nl: Dutch\n    - sv: Swedish\n    - da: Danish\n    - fi: Finnish\n    - no: Norwegian\n    - cs: Czech\n    - hu: Hungarian\n- src_content: Source content, that is, the content that needs to be translated, the length does not exceed 5000 characters, if it exceeds 5000 characters, only the first 5000 characters will be translated.\n### Return:\n- Content translation data\n\n# [示例/Example]\ntrg_lang = \"zh-Hans\"\nsrc_content = \"Hello, welcome to TikHub!\"","operationId":"fetch_content_translate_api_v1_tiktok_app_v3_fetch_content_translate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TikTok_APP_V3_Content_Translate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/app/v3/fetch_home_feed":{"post":{"tags":["TikTok-App-V3-API"],"summary":"获取主页视频推荐数据/Get home feed(recommend) video data","description":"# [中文]\n### 用途:\n- 获取主页视频推荐数据\n### 参数:\n- cookie: 用户自己的cookie，可选参数，用于接口返回数据的个性化推荐。\n### 返回:\n- 视频推荐数据\n\n# [English]\n### Purpose:\n- Get home feed(recommend) video data\n### Parameters:\n- cookie: User's own cookie, optional parameter, used for personalized recommendation of interface returned data.\n### Return:\n- Video recommend data","operationId":"fetch_home_feed_api_v1_tiktok_app_v3_fetch_home_feed_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TikTok_APP_V3_Home_Feed"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/app/v3/TTencrypt_algorithm":{"post":{"tags":["TikTok-App-V3-API"],"summary":"TikTok APP加密算法/TikTok APP encryption algorithm","description":"# [中文]\n### 用途:\n- TikTok APP加密算法，用于生成请求头中的加密参数。\n- 生成的加密参数列表：\n    - `x-ladon`\n    - `x-khronos`\n    - `x-argus`\n    - `x-gorgon` （8404）\n\n### 参数:\n- url: 需要加密的完整URL\n- data: 如果接口是POST请求，请填写POST请求的数据参与加密计算，GET请求时传入空字符串即可。\n- device_info: 设备信息，可选参数，如果不填写则使用默认设备信息，设备信息会修改传入的URL中的参数。\n\n### 返回:\n- 加密参数列表\n\n# [English]\n### Purpose:\n- TikTok APP encryption algorithm, used to generate encrypted parameters in the request header.\n- The generated encrypted parameter list:\n    - `x-ladon`\n    - `x-khronos`\n    - `x-argus`\n    - `x-gorgon` (8404)\n\n### Parameters:\n- url: Full URL to be encrypted\n- data: If the interface is a POST request, please fill in the data of the POST request to participate in the encryption calculation. For GET requests, pass an empty string.\n- device_info: Device information, optional parameter, if not filled in, the default device information will be used, and the device information will modify the parameters in the URL passed in.\n\n### Return:\n- Encrypted parameter list","operationId":"TTencrypt_algorithm_api_v1_tiktok_app_v3_TTencrypt_algorithm_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TikTok_APP_Encrypt_Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/app/v3/fetch_live_room_product_list":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取直播间商品列表数据/Get live room product list data","description":"# [中文]\n### 用途:\n- 获取直播间商品列表数据\n### 参数:\n- room_id: 直播间id，必填参数。\n- author_id: 主播id，必填参数。\n- page_size: 每页数量，可选参数，默认为15。\n- offset: 翻页游标，可选参数，默认为0，每次翻页增加15。\n- region: 地区，可选参数，默认为`US`，如果使用其他地区，如：`VN`，请自行携带Cookie，否则无法获取数据。\n- cookie: 用户自己的cookie，可选参数，用于爬取除`US`以外的地区数据。\n### 参数获取:\n- 第一步：使用接口`f\"{TikHub_Domain}/api/v1/tiktok/web/get_live_room_id\"`接口获取直播间id（room_id）。\n- 第二步：使用接口`f\"{TikHub_Domain}/api/v1/tiktok/app/v3/fetch_live_room_info\"`接口获取直播间信息。\n- 第三步：使用第二步返回的JSON数据中使用JSONPATH获取`$.data.data.owner.id_str`字段的值作为主播id（author_id）。\n### 返回:\n- 直播间商品列表数据\n\n# [English]\n### Purpose:\n- Get live room product list data\n### Parameters:\n- room_id: Live room id, required parameter.\n- author_id: Anchor id, required parameter.\n- page_size: Number per page, optional parameter, default is 15.\n- offset: Page turning cursor, optional parameter, default is 0, increasing by 15 each time.\n- region: Region, optional parameter, default is `US`, if you use other regions, such as: `VN`, please bring your own Cookie, otherwise you will not be able to get data.\n- cookie: User's own cookie, optional parameter, used to crawl data from regions other than `US`.\n### Get Parameters:\n- Step 1: Use the interface `f\"{TikHub_Domain}/api/v1/tiktok/web/get_live_room_id\"` to get the live room id (room_id).\n- Step 2: Use the interface `f\"{TikHub_Domain}/api/v1/tiktok/app/v3/fetch_live_room_info\"` to get the live room information.\n- Step 3: Use the JSONPATH in the JSON data returned in the second step to get the value of the field `$.data.data.owner.id_str` as the anchor id (author_id).\n### Return:\n- Live room product list data\n\n# [示例/Example]\nroom_id = \"7420741353250507562\"\nauthor_id = \"7408859677050274859\"\npage_size = 15\noffset = 0","operationId":"fetch_live_room_product_list_api_v1_tiktok_app_v3_fetch_live_room_product_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间id/Live room id","title":"Room Id"},"description":"直播间id/Live room id","example":"7420741353250507562"},{"name":"author_id","in":"query","required":true,"schema":{"type":"string","description":"主播id/Anchor id","title":"Author Id"},"description":"主播id/Anchor id","example":"7408859677050274859"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":15,"title":"Page Size"},"description":"数量/Number"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":0,"title":"Offset"},"description":"数量/Number"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区/Region","default":"US","title":"Region"},"description":"地区/Region"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户自己的cookie/User's own cookie","default":"","title":"Cookie"},"description":"用户自己的cookie/User's own cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/fetch_live_room_product_list_v2":{"get":{"tags":["TikTok-App-V3-API"],"summary":"获取直播间商品列表数据 V2 /Get live room product list data V2","description":"# [中文]\n### 用途:\n- 获取直播间商品列表数据 V2\n### 参数:\n- room_id: 直播间id，必填参数。\n- author_id: 主播id，必填参数。\n- page_size: 每页数量，可选参数，默认为15。\n- offset: 翻页游标，可选参数，默认为0，每次翻页增加15。\n- region: 地区，可选参数，默认为`US`，如果使用其他地区，如：`VN`，请自行携带Cookie，否则无法获取数据。\n- cookie: 用户自己的cookie，可选参数，用于爬取除`US`以外的地区数据。\n### 参数获取:\n- 第一步：使用接口`f\"{TikHub_Domain}/api/v1/tiktok/web/get_live_room_id\"`接口获取直播间id（room_id）。\n- 第二步：使用接口`f\"{TikHub_Domain}/api/v1/tiktok/app/v3/fetch_live_room_info\"`接口获取直播间信息。\n- 第三步：使用第二步返回的JSON数据中使用JSONPATH获取`$.data.data.owner.id_str`字段的值作为主播id（author_id）。\n### 返回:\n- 直播间商品列表数据\n\n# [English]\n### Purpose:\n- Get live room product list data V2\n### Parameters:\n- room_id: Live room id, required parameter.\n- author_id: Anchor id, required parameter.\n- page_size: Number per page, optional parameter, default is 15.\n- offset: Page turning cursor, optional parameter, default is 0, increasing by 15 each time.\n- region: Region, optional parameter, default is `US`, if you use other regions, such as: `VN`, please bring your own Cookie, otherwise you will not be able to get data.\n- cookie: User's own cookie, optional parameter, used to crawl data from regions other than `US`.\n### Get Parameters:\n- Step 1: Use the interface `f\"{TikHub_Domain}/api/v1/tiktok/web/get_live_room_id\"` to get the live room id (room_id).\n- Step 2: Use the interface `f\"{TikHub_Domain}/api/v1/tiktok/app/v3/fetch_live_room_info\"` to get the live room information.\n- Step 3: Use the JSONPATH in the JSON data returned in the second step to get the value of the field `$.data.data.owner.id_str` as the anchor id (author_id).\n### Return:\n- Live room product list data\n\n# [示例/Example]\nroom_id = \"7420741353250507562\"\nauthor_id = \"7408859677050274859\"\npage_size = 15\noffset = 0","operationId":"fetch_live_room_product_list_v2_api_v1_tiktok_app_v3_fetch_live_room_product_list_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间id/Live room id","title":"Room Id"},"description":"直播间id/Live room id","example":"7420741353250507562"},{"name":"author_id","in":"query","required":true,"schema":{"type":"string","description":"主播id/Anchor id","title":"Author Id"},"description":"主播id/Anchor id","example":"7408859677050274859"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":15,"title":"Page Size"},"description":"数量/Number"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":0,"title":"Offset"},"description":"数量/Number"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区/Region","default":"US","title":"Region"},"description":"地区/Region"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户自己的cookie/User's own cookie","default":"","title":"Cookie"},"description":"用户自己的cookie/User's own cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/add_video_play_count":{"get":{"tags":["TikTok-App-V3-API"],"summary":"根据视频ID来增加作品的播放数/Increase the number of plays of the work according to the video ID","description":"# [中文]\n### 用途:\n- 根据视频ID来增加作品的播放数\n### 参数:\n- aweme_type: 作品类型，0:视频 1:图文，可以从单一作品数据接口中获取。\n- item_id: 作品id，别名为aweme_id\n- invite_code: 邀请码，此接口需要邀请码才能使用。\n### 返回:\n- 当前时间戳和状态码，状态码为200时表示成功，否则为失败，可以尝试更换一个作品id再次调用，或者等待一段时间后再次调用。\n\n# [English]\n### Purpose:\n- Increase the number of plays of the work according to the video ID\n### Parameters:\n- aweme_type: Video type, 0: Video 1: Graphic and text, can be obtained from the single work data interface.\n- item_id: Video id, alias aweme_id\n- invite_code: Invite code, this interface requires an invite code to use.\n### Return:\n- The current timestamp and status code. When the status code is 200, it means success, otherwise it is a failure. You can try to change another work id and call it again, or wait for a period of time and call it again.\n\n# [示例/Example]\naweme_type = 0\nitem_id = \"7419966340443819295\"\ncookie = None","operationId":"add_video_play_count_api_v1_tiktok_app_v3_add_video_play_count_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_type","in":"query","required":true,"schema":{"type":"integer","description":"作品类型/Video type","title":"Aweme Type"},"description":"作品类型/Video type","example":0},{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7419966340443819295"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/encrypt_decrypt_login_request":{"post":{"tags":["TikTok-App-V3-API"],"summary":"加密或解密 TikTok APP 登录请求体/Encrypt or Decrypt TikTok APP login request body","description":"# [中文]\n### 用途:\n- 加密/解密 TikTok APP 登录请求体，用于登录接口的请求体加密和解密。\n### 参数:\n- username: 用户名，可以是密文或明文。\n- password: 密码，可以是密文或明文。\n- mode: 模式\n    - `encrypt`: 加密\n    - `decrypt`: 解密\n### 返回:\n- 加密/解密后的请求体\n\n# [English]\n### Purpose:\n- Encrypt/decrypt the TikTok APP login request body, used for encrypting and decrypting the request body of the login interface.\n### Parameters:\n- username: Username, can be ciphertext or plaintext.\n- password: Password, can be ciphertext or plaintext.\n- mode: Mode\n    - `encrypt`: Encrypt\n    - `decrypt`: Decrypt\n### Return:\n- Encrypted/decrypted request body\n\n# [示例/Example]\n```json\n{\n    \"username\": \"example_username\",\n    \"password\": \"example_password\",\n    \"mode\": \"encrypt\"\n}\n```","operationId":"encrypt_decrypt_login_request_api_v1_tiktok_app_v3_encrypt_decrypt_login_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TikTok_APP_Login_Encrypt_Decrypt_Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/app/v3/open_tiktok_app_to_video_detail":{"get":{"tags":["TikTok-App-V3-API"],"summary":"生成TikTok分享链接，唤起TikTok APP，跳转指定作品详情页/Generate TikTok share link, call TikTok APP, and jump to the specified video details page","description":"# [中文]\n### 用途:\n- 生成TikTok分享链接，唤起TikTok APP，跳转指定作品详情页。\n\n### 参数:\n- aweme_id: 作品id\n- 注意: 如果未能跳转，请确保APP已经在后台运行。\n\n### 返回:\n- 分享链接\n\n# [English]\n### Purpose:\n- Generate TikTok share link, call TikTok APP, and jump to the specified video\n\n### Parameters:\n- aweme_id: Video id\n- Note: If you cannot jump, please make sure that the APP is running in the background\n\n### Return:\n- Share link\n\n# [示例/Example]\naweme_id = \"7440436579409153311\"","operationId":"open_tiktok_app_to_video_detail_api_v1_tiktok_app_v3_open_tiktok_app_to_video_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7440436579409153311"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/open_tiktok_app_to_user_profile":{"get":{"tags":["TikTok-App-V3-API"],"summary":"生成TikTok分享链接，唤起TikTok APP，跳转指定用户主页/Generate TikTok share link, call TikTok APP, and jump to the specified user profile","description":"# [中文]\n### 用途:\n- 生成TikTok分享链接，唤起TikTok APP，跳转指定用户主页。\n\n### 参数:\n- uid: 用户id，从用户主页接口中获取。\n- 注意: 如果未能跳转，请确保APP已经在后台运行。\n\n### 返回:\n- 分享链接\n\n# [English]\n### Purpose:\n- Generate TikTok share link, call TikTok APP, and jump to the specified user profile\n\n### Parameters:\n- uid: User id, obtained from the user profile interface.\n- Note: If you cannot jump, please make sure that the APP is running in the background.\n\n### Return:\n- Share link\n\n# [示例/Example]\nuid = \"7059867056504407087\"","operationId":"open_tiktok_app_to_user_profile_api_v1_tiktok_app_v3_open_tiktok_app_to_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"Uid"},"description":"用户id/User id","example":"7059867056504407087"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/open_tiktok_app_to_keyword_search":{"get":{"tags":["TikTok-App-V3-API"],"summary":"生成TikTok分享链接，唤起TikTok APP，跳转指定关键词搜索结果/Generate TikTok share link, call TikTok APP, and jump to the specified keyword search result","description":"# [中文]\n### 用途:\n- 生成TikTok分享链接，唤起TikTok APP，跳转指定关键词搜索结果。\n\n### 参数:\n- keyword: 关键词\n- 注意: 如果未能跳转，请确保APP已经在后台运行。\n\n### 返回:\n- 分享链接\n\n# [English]\n### Purpose:\n- Generate TikTok share link, call TikTok APP, and jump to the specified keyword search result\n\n### Parameters:\n- keyword: Keyword\n- Note: If you cannot jump, please make sure that the APP is running in the background\n\n### Return:\n- Share link\n\n# [示例/Example]\nkeyword = \"Evil0ctal\"","operationId":"open_tiktok_app_to_keyword_search_api_v1_tiktok_app_v3_open_tiktok_app_to_keyword_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"Evil0ctal"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/app/v3/open_tiktok_app_to_send_private_message":{"get":{"tags":["TikTok-App-V3-API"],"summary":"生成TikTok分享链接，唤起TikTok APP，给指定用户发送私信/Generate TikTok share link, call TikTok APP, and send private messages to specified users","description":"# [中文]\n### 用途:\n- 生成TikTok分享链接，唤起TikTok APP，给指定用户发送私信。\n\n### 参数:\n- uid: 用户id，从用户主页接口中获取。\n- 注意: 如果未能跳转，请确保APP已经在后台运行。\n\n### 返回:\n- 分享链接\n\n# [English]\n### Purpose:\n- Generate TikTok share link, call TikTok APP, and send private messages to specified users\n\n### Parameters:\n- uid: User id, obtained from the user profile interface.\n- Note: If you cannot jump, please make sure that the APP is running in the background.\n\n### Return:\n- Share link\n\n# [示例/Example]\nuid = \"7059867056504407087\"","operationId":"open_tiktok_app_to_send_private_message_api_v1_tiktok_app_v3_open_tiktok_app_to_send_private_message_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"Uid"},"description":"用户id/User id","example":"7059867056504407087"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/creator/get_account_health_status":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取创作者账号健康状态/Get Creator Account Health Status","description":"# [中文]\n### 用途:\n- 获取 TikTok Shop 创作者账号的健康状况信息，包括过去 90 天内的健康评分（风险等级）以及当前累计的违规积分数量。\n- 关于违规积分：\n    - 违规积分是 TikTok 用于衡量账号健康状况的重要指标。\n    - 违规积分越高，账号健康状况越差，可能面临限流、禁播、封禁等处罚。\n    - 违规积分将直接影响账号的曝光量和推荐量。\n\n### 累计违规积分对应的惩罚等级：\n| 分数范围  | 惩罚措施                                                | 惩罚时长 |\n| --------- | --------------------------------------------------------- | -------- |\n| 9-11      | 警告（Warning）                                           | 无       |\n| 12-14     | 暂停电商权限（视频、直播、商品展示功能）                  | 24 小时  |\n| 15-17     | 暂停电商权限                                              | 48 小时  |\n| 18-20     | 暂停电商权限                                              | 72 小时  |\n| 21-23     | 暂停电商权限                                              | 1 周     |\n| 24 及以上 | 永久移除电商权限，封禁 TikTok Shop 创作者账号             | 永久禁用 |\n\n### 备注:\n- 此接口仅适用于已开通 TikTok Shop 的创作者账号。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回:\n- `risk_info`（健康状态信息）:\n  - `risk_level_text`: 当前风险等级描述（如 Healthy）\n  - `light_color`: 健康状态浅色展示色值（rgba 格式）\n  - `dark_color`: 健康状态深色展示色值（rgba 格式）\n- `vio_score_rule_learn_url`: 查看违规积分规则说明的链接\n- `is_show_score`: 是否展示违规积分（布尔值）\n- `violation_score`: 当前违规积分数量\n- `creator_status`: 创作者账号状态码（0=正常）\n\n# [English]\n### Purpose:\n- Retrieve the health status of a TikTok Shop creator account, including the health score over the past 90 days and the current number of accumulated violation points.\n- About violation points:\n    - Violation points are key metrics used by TikTok to measure the health of a creator account.\n    - Higher violation points indicate worse account health, and may lead to restrictions such as reduced exposure, suspension, or account bans.\n    - Violation points directly impact the account’s visibility and recommendation on the platform.\n\n### Punishment Levels for Accumulated Violation Points:\n| Score Range | Punishment Measures                                       | Duration         |\n| ----------- | ---------------------------------------------------------- | ---------------- |\n| 9-11        | Warning                                                     | None             |\n| 12-14       | E-commerce permissions suspended (video, live, product showcase) | 24 hours         |\n| 15-17       | E-commerce permissions suspended                           | 48 hours         |\n| 18-20       | E-commerce permissions suspended                           | 72 hours         |\n| 21-23       | E-commerce permissions suspended                           | 1 week           |\n| 24+         | Permanent removal of e-commerce permissions and banning of TikTok Shop creator account | Permanently disabled |\n\n### Notes:\n- This API is only applicable to TikTok Shop creator accounts.\n\n### Parameters:\n- cookie: User Cookie string for authentication\n- proxy: Optional HTTP proxy address, can be omitted if not needed\n    - Example format: `http://username:password@host:port`\n\n### Response:\n- `risk_info`: Account health status:\n  - `risk_level_text`: Current health level description (e.g., Healthy)\n  - `light_color`: Light color code for health level display (RGBA format)\n  - `dark_color`: Dark color code for health level display (RGBA format)\n- `vio_score_rule_learn_url`: URL to learn more about violation point rules\n- `is_show_score`: Whether to display violation points (boolean)\n- `violation_score`: Current violation score\n- `creator_status`: Creator account status code (0 = normal)\n\n# [示例/Example]\n```json\npayload = {\n    \"cookie\": \"your_cookie\"\n}","operationId":"get_account_health_status_api_v1_tiktok_creator_get_account_health_status_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountHealthRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_account_violation_list":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取创作者账号违规记录列表/Get Creator Account Violation Record List","description":"# [中文]\n### 用途:\n- 获取 TikTok Shop 创作者账号的违规记录信息，用于了解账号在运营期间的违规历史和处理情况。\n- 返回的违规记录包含违规类型、违规时间、违规原因、违规处理措施、申诉状态、是否可申诉等信息。\n- 支持分页查询，可按时间顺序获取多条违规记录。\n- 适用于创作者账号违规风险管理、账号健康监控和数据合规审计。\n\n### 备注:\n- 此接口仅适用于 TikTok Shop 创作者账号。\n- 支持分页查询，每次默认返回最新的违规记录。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- page: 整数类型，页码，默认为第 1 页\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回:\n- `records`（违规记录列表）:\n  - `record_id`: 违规记录 ID\n  - `violation_time`: 违规发生时间（Unix 时间戳）\n  - `violation_info`:\n    - `violation_reason`: 违规原因描述\n    - `violation_detail`: 违规详情描述\n    - `violation_suggestion`: 平台提供的整改建议\n    - `policy_url`: 相关政策链接\n    - `violation_type`: 违规类别（如视频违规）\n  - `record_status`: 记录状态（1 表示有效）\n  - `appeal_status`: 申诉状态（0=未申诉，1=已申诉）\n  - `enforcement_title`: 平台针对违规采取的执行措施描述（例如扣分、佣金冻结等）\n  - `appeal_valid_time`: 申诉有效截止时间（Unix 时间戳）\n  - `can_appeal`: 是否允许发起申诉（布尔值）\n- `total`: 总违规记录数\n- `has_more`: 是否还有更多数据\n- `start_time`: 查询起始时间\n- `end_time`: 查询结束时间\n- `creator_status`: 创作者账号状态码（如 0=正常）\n\n# [English]\n### Purpose:\n- Retrieve the violation history of a TikTok Shop creator account, providing details about past violations and corresponding enforcement actions.\n- The returned violation records include violation type, violation time, violation reasons, enforcement actions, appeal status, and eligibility for appeal.\n- Pagination is supported to retrieve multiple records in chronological order.\n- Suitable for creator account risk management, health monitoring, and compliance auditing.\n\n### Notes:\n- This API is available only for TikTok Shop creator accounts.\n- Pagination is supported; by default, it retrieves the latest violation records.\n\n### Parameters:\n- cookie: User's Cookie string for authentication\n- page: Integer, page number (default is `1`)\n- proxy: Optional HTTP proxy address, can be omitted if not needed\n    - Example format: `http://username:password@host:port`\n\n### Response:\n- `records`: List of violation records:\n  - `record_id`: Unique ID of the violation record\n  - `violation_time`: Time when the violation occurred (Unix timestamp)\n  - `violation_info`:\n    - `violation_reason`: Reason for the violation\n    - `violation_detail`: Detailed description (may be empty)\n    - `violation_suggestion`: Recommended corrective action\n    - `policy_url`: Link to the related policy\n    - `violation_type`: Type of violation (e.g., Video violation)\n  - `record_status`: Record status (1 = active)\n  - `appeal_status`: Appeal status (0 = not appealed, 1 = appealed)\n  - `enforcement_title`: List of enforcement actions taken (e.g., point assignment, commission withholding)\n  - `appeal_valid_time`: Deadline for submitting an appeal (Unix timestamp)\n  - `can_appeal`: Whether the record is eligible for appeal (boolean)\n- `total`: Total number of violation records\n- `has_more`: Whether there are more records to fetch\n- `start_time`: Query start time\n- `end_time`: Query end time\n- `creator_status`: Creator account status code (e.g., 0 = normal)\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"your_cookie_here\",\n    \"page\": 1\n}\n```","operationId":"get_account_violation_list_api_v1_tiktok_creator_get_account_violation_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetViolationRecordRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_account_insights_overview":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取创作者账号概览/Get Creator Account Overview","description":"# [中文]\n### 用途:\n- 获取 TikTok Shop 创作者账号在指定时间范围内的表现概览，包括收益、曝光、点击、成交等多维度数据。\n- 默认统计从 `start_date` 当月起 1 个自然月（如传入 2025-04-01，则统计整个 4 月的数据）。\n\n### 备注:\n- 此接口仅适用于已开通 TikTok Shop 功能的创作者账号。\n- 数据按照时间粒度进行分段统计，可用于数据分析和趋势观察。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- start_date: 查询开始时间，格式为 'MM-DD-YYYY'，如 '04-01-2025'\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回:\n- `segments`（分段数据列表）:\n  - `time_selector`: 当前统计段的时间设置，包括周期、起止时间戳、时区、语言等\n  - `timed_stats`: 每天/每段的详细数据，包含以下字段：\n    - `live_revenue.amount`: 直播带货收益\n    - `video_revenue.amount`: 视频带货收益\n    - `revenue.amount`: 总收益（直播 + 视频）\n    - `base_revenue.amount`: 基础收益\n    - `commission_estimated.amount`: 预估佣金\n    - `alc_base_revenue.amount`: ALC 模式下基础收益\n    - `overall_item_sold_cnt`: 商品成交数\n    - `product_show_cnt`: 商品展示次数\n    - `product_click_cnt`: 商品点击次数\n    - `alc_pay_sku_order_cnt`: ALC 成交订单数\n- `meta.is_bound_shop`: 是否绑定 TikTok 店铺\n\n# [English]\n### Purpose:\n- Retrieve performance overview of a TikTok Shop creator account within a specified date range, including metrics like revenue, exposure, clicks, and orders.\n- By default, it aggregates data from the month of `start_date` (e.g., if `start_date` is 2025-04-01, it retrieves data for the entire month of April).\n\n### Notes:\n- This API is only applicable to TikTok accounts that have TikTok Shop enabled.\n- Data is segmented by time granularity (daily/monthly), and can be used for performance analysis or trend monitoring.\n\n### Parameters:\n- cookie: User cookie string for authentication\n- start_date: Query start date in 'MM-DD-YYYY' format, e.g. '04-01-2025'\n- proxy: Optional HTTP proxy address. Leave empty if not needed.\n    - Example format: `http://username:password@host:port`\n\n### Response:\n- `segments`: List of data segments, each containing:\n  - `time_selector`: Time settings for the segment, including period, timestamp range, timezone, and locale\n  - `timed_stats`: Daily or interval-based statistics, including:\n    - `live_revenue.amount`: Revenue from livestream sales\n    - `video_revenue.amount`: Revenue from video sales\n    - `revenue.amount`: Total revenue (live + video)\n    - `base_revenue.amount`: Base revenue\n    - `commission_estimated.amount`: Estimated commission\n    - `alc_base_revenue.amount`: Base revenue under ALC model\n    - `overall_item_sold_cnt`: Total items sold\n    - `product_show_cnt`: Product exposure count\n    - `product_click_cnt`: Product click count\n    - `alc_pay_sku_order_cnt`: Orders under ALC model\n- `meta.is_bound_shop`: Whether the TikTok account is bound to a shop","operationId":"get_account_insights_overview_api_v1_tiktok_creator_get_account_insights_overview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountOverviewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_live_analytics_summary":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取创作者直播概览/Get Creator Live Overview","description":"# [中文]\n### 用途:\n- 获取 TikTok Shop 创作者账号在指定时间范围内的直播表现数据概览。\n- 默认统计从 `start_date` 当月起 1 个自然月（如传入 2025-04-01，则统计整个 4 月的数据）。\n\n### 返回内容说明:\n- `segments`（分段数据列表）:\n  - `time_selector`: 时间范围设置（周期、起止时间戳、时区、语言）\n  - `filter.creator_id`: 创作者 ID\n  - `timed_stats`: 每个时间段（通常按日或月分段）的直播表现数据，包含：\n    - `live_revenue.amount`: 直播带货收入\n    - `live_show_gpm.amount`: 直播场均带货收入\n    - `new_follower_cnt`: 新增粉丝数量\n    - `sku_order_paid_cnt`: 已付款 SKU 数量\n    - `item_sold_cnt`: 成交商品件数\n    - `product_view`: 商品曝光次数（浏览量）\n    - `product_click`: 商品点击次数\n    - `live_pay_order_ucnt`: 直播支付订单人数\n    - `live_ctr`: 直播点击率（Click-Through Rate）\n    - `live_co`: 直播转化率（Conversion Rate）\n    - `live_like_cnt`: 直播点赞次数\n    - `live_comment_cnt`: 直播评论次数\n    - `live_show_cnt`: 直播场次\n    - `live_watch_cnt`: 直播观看人数\n\n### 备注:\n- 此接口仅适用于 TikTok Shop 创作者账号。\n- 直播期间数据按自然日拆分。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- start_date: 查询开始时间（格式 `MM-DD-YYYY`），如 `04-01-2025`\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回:\n- 创作者账号直播数据概览\n\n# [English]\n### Purpose:\n- Retrieve a summary of live streaming performance for a TikTok Shop creator account within a specified time range.\n- By default, it covers one full calendar month starting from the provided `start_date` (e.g., input `04-01-2025` will fetch data for the entire April 2025).\n\n### Response Fields:\n- `segments` (List of segmented data):\n  - `time_selector`: Time period settings (period, start/end timestamps, timezone, locale)\n  - `filter.creator_id`: Creator ID\n  - `timed_stats`: Live performance statistics per time segment, including:\n    - `live_revenue.amount`: Live streaming revenue\n    - `live_show_gpm.amount`: Average revenue per live show\n    - `new_follower_cnt`: Number of new followers\n    - `sku_order_paid_cnt`: Number of SKUs paid\n    - `item_sold_cnt`: Number of items sold\n    - `product_view`: Number of product views\n    - `product_click`: Number of product clicks\n    - `live_pay_order_ucnt`: Number of unique users who placed live orders\n    - `live_ctr`: Live Click-Through Rate (CTR)\n    - `live_co`: Live Conversion Rate (CO)\n    - `live_like_cnt`: Number of live likes\n    - `live_comment_cnt`: Number of live comments\n    - `live_show_cnt`: Number of live sessions\n    - `live_watch_cnt`: Number of live viewers\n\n### Notes:\n- This API is only applicable to TikTok Shop creator accounts.\n- Data is split by natural days during the live sessions.\n\n### Parameters:\n- cookie: User Cookie string for authentication\n- start_date: Query start date in the format `MM-DD-YYYY`, e.g., `04-01-2025`\n- proxy: Optional HTTP proxy address, can be omitted if not used\n    - Example format: `http://username:password@host:port`\n\n### Return:\n- Creator live streaming performance overview\n\n# [示例/Example]\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\"\n}\n```","operationId":"get_live_overview_api_v1_tiktok_creator_get_live_analytics_summary_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLiveOverviewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_video_analytics_summary":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取创作者视频概览/Get Creator Video Overview","description":"# [中文]\n### 用途:\n- 获取 TikTok Shop 创作者账号在指定时间范围内的视频表现概览。\n- 默认统计从调用当天向前 30 天的数据（或按平台设定的自然月分段）。\n- 适合用于视频表现分析，例如视频数量、播放量、粉丝增长、成交数据等。\n\n### 返回内容说明:\n- `segments`（分段数据列表）:\n  - `time_selector`: 时间范围设置信息（周期、起止时间戳、时区、语言）\n  - `filter.creator_id`: 创作者账号 ID\n  - `timed_stats`: 每个时间段的视频表现数据，包含：\n    - `vv_cnt`: 视频播放量（Video Views Count）\n    - `new_follower_cnt`: 新增粉丝数量\n    - `video_cnt`: 发布视频数量\n    - `gmv.amount`: 视频带货产生的 GMV 金额\n    - `items_sold`: 售出商品数量\n\n### 备注:\n- 此接口仅适用于 TikTok Shop 创作者账号。\n- 如果某个时间段无数据，返回的 `stats` 字段可能为空 `{}`。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回:\n- 创作者账号视频表现概览\n\n# [English]\n### Purpose:\n- Retrieve a video performance overview for a TikTok Shop creator account over a specified time range.\n- By default, the API fetches data for the past 30 days (or full calendar month based on the platform settings).\n- Useful for analyzing metrics like video count, views, new followers, and generated GMV.\n\n### Response Fields:\n- `segments` (List of segmented data):\n  - `time_selector`: Time period settings (period, start/end timestamps, timezone, locale)\n  - `filter.creator_id`: Creator account ID\n  - `timed_stats`: Video performance statistics for each time segment, including:\n    - `vv_cnt`: Video Views Count\n    - `new_follower_cnt`: Number of new followers\n    - `video_cnt`: Number of videos published\n    - `gmv.amount`: Gross Merchandise Value generated by videos\n    - `items_sold`: Number of items sold\n\n### Notes:\n- This API is only available for TikTok Shop creator accounts.\n- If no data is available for a time segment, the `stats` field might be an empty `{}`.\n\n### Parameters:\n- cookie: User Cookie string for authentication\n- proxy: Optional HTTP proxy address, can be omitted if not used\n    - Example format: `http://username:password@host:port`\n\n### Return:\n- Creator account video performance overview\n\n# [示例/Example]\n```json\n{\n  \"cookie\": \"your_cookie\"\n}\n```","operationId":"get_video_analytics_summary_api_v1_tiktok_creator_get_video_analytics_summary_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVideoOverviewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_video_list_analytics":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取创作者视频列表分析/Get Creator Video List Analytics","description":"# [中文]\n### 用途:\n- 获取 TikTok Shop 创作者账号在指定时间范围内发布的视频列表及其详细数据表现。\n- 支持分页查询，每页返回指定时间段内的视频及其播放、成交等详细数据。\n\n### 返回内容说明:\n- `segments`（分段数据列表）:\n  - `time_selector`: 查询时间范围（起止时间戳、时区、语言等）\n  - `filter.creator_id`: 创作者账号 ID\n  - `list_control`:\n    - `rules`: 列表排序规则（通常按发布时间降序）\n    - `next_pagination`: 翻页信息（是否有更多页，当前页，总页数，总记录数）\n  - `timed_lists`: 每个时间段内的视频数据，包括：\n    - `video_meta`:\n      - `item_id`: 视频 Item ID\n      - `name`: 视频标题\n      - `publish_time`: 视频发布时间（Unix 时间戳）\n      - `duration`: 视频时长（秒）\n      - `video_play_info`: 视频播放资源信息（封面图、播放链接等）\n    - `new_follower_cnt`: 视频期间新增粉丝数\n    - `vv_cnt`: 视频播放量\n    - `ctr`: 商品点击率（Click Through Rate）\n    - `gmv.amount`: 视频带货产生的总 GMV 金额\n    - `item_sold_cnt`: 视频带动的商品售出数量\n    - `direct_gmv.amount`: 直接带货 GMV\n    - `completion_rate`: 视频观看完成率\n\n### 备注:\n- 此接口仅适用于 TikTok Shop 创作者账号。\n- 数据按自然日或周分组，且每条视频数据对应一段时间内的统计值。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- start_date: 查询起始日期，格式为 'MM-DD-YYYY'，如 '04-01-2025'\n- page: 页码，默认为第一页 `0`\n- rules: 列表排序规则，默认按发布时间排序，可选值如下：\n    - `\"VIDEO_LIST_PUBLISH_TIME\"`：按发布时间排序\n    - `\"VIDEO_LIST_GMV\"`：按商品交易总额排序\n    - `\"VIDEO_LIST_DIRECT_GMV\"`：按直接商品交易总额排序\n    - `\"VIDEO_LIST_VV_CNT\"`：按观看人次数排序\n    - `\"VIDEO_LIST_ITEM_SOLD_CNT\"`：按成交件数排序\n    - `\"VIDEO_LIST_CTR\"`：按商品点击率排序\n    - `\"VIDEO_LIST_COMPLETION_RATE\"`：按观看完播率排序\n    - `\"VIDEO_LIST_LIKE_CNT\"`：按点赞数排序\n    - `\"VIDEO_LIST_NEW_FOLLOWER_CNT\"`：按新增粉丝数排序\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回:\n- 创作者账号视频列表及详细分析数据\n\n# [English]\n### Purpose:\n- Retrieve a list of videos published by a TikTok Shop creator account within a specified time range, along with detailed performance metrics.\n- Supports pagination to fetch multiple pages of video records within the given time range.\n\n### Response Fields:\n- `segments` (List of segmented data):\n  - `time_selector`: Time range settings (start/end timestamps, timezone, locale)\n  - `filter.creator_id`: Creator account ID\n  - `list_control`:\n    - `rules`: List sorting rules (typically by publish time descending)\n    - `next_pagination`: Pagination information (has more pages, current page, total pages, total records)\n  - `timed_lists`: List of videos for each time range, including:\n    - `video_meta`:\n      - `item_id`: Video Item ID\n      - `name`: Video title\n      - `publish_time`: Video publish time (Unix timestamp)\n      - `duration`: Video duration (seconds)\n      - `video_play_info`: Video play resources (cover image, playback URL, etc.)\n    - `new_follower_cnt`: Number of new followers during the video's period\n    - `vv_cnt`: Video views count\n    - `ctr`: Click Through Rate for associated products\n    - `gmv.amount`: Gross Merchandise Value generated by the video\n    - `item_sold_cnt`: Number of items sold due to the video\n    - `direct_gmv.amount`: Direct GMV from the video\n    - `completion_rate`: Video completion rate\n\n### Notes:\n- This API is only available for TikTok Shop creator accounts.\n- Data is grouped by natural day or week, and each video's stats represent the corresponding period.\n\n### Parameters:\n- cookie: User Cookie string for authentication\n- start_date: Query start date, formatted as 'MM-DD-YYYY', e.g., '04-01-2025'\n- page: Page number, default is the first page `0`\n- rules: List sorting rules, default is by publish time. Available options:\n    - `\"VIDEO_LIST_PUBLISH_TIME\"`: Sort by video publish time\n    - `\"VIDEO_LIST_GMV\"`: Sort by gross merchandise value (GMV)\n    - `\"VIDEO_LIST_DIRECT_GMV\"`: Sort by direct GMV\n    - `\"VIDEO_LIST_VV_CNT\"`: Sort by video view count\n    - `\"VIDEO_LIST_ITEM_SOLD_CNT\"`: Sort by number of items sold\n    - `\"VIDEO_LIST_CTR\"`: Sort by click-through rate\n    - `\"VIDEO_LIST_COMPLETION_RATE\"`: Sort by video completion rate\n    - `\"VIDEO_LIST_LIKE_CNT\"`: Sort by number of likes\n    - `\"VIDEO_LIST_NEW_FOLLOWER_CNT\"`: Sort by number of new followers\n- proxy: Optional HTTP proxy address, can be omitted if not used\n    - Example format: `http://username:password@host:port`\n\n### Return:\n- Detailed video list and performance analysis for the creator account\n\n# [示例/Example]\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"page\": 0\n}\n```","operationId":"get_video_list_api_v1_tiktok_creator_get_video_list_analytics_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVideoListRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_product_analytics_list":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取创作者商品列表分析/Get Creator Product List Analytics","description":"# [中文]\n### 用途:\n- 获取 TikTok Shop 创作者账号在指定时间范围内推广的商品列表及其销售数据分析。\n- 支持按商品成交额、商品上架时间排序，可分页查询。\n\n### 返回内容说明:\n- `segments`（分段数据列表）:\n  - `filter.creator_id`: 创作者账号 ID\n  - `list_control`:\n    - `rules`: 列表排序规则（如按成交额、商品 ID 排序）\n    - `next_pagination`: 翻页信息（是否还有更多页、下一页页码、总页数、总记录数）\n  - `timed_lists`: 每个时间段内的商品数据，包括：\n    - `product`:\n      - `id`: 商品 ID\n      - `name`: 商品标题\n      - `cover_image.thumb_url_list`: 商品封面图列表\n    - `item_sold_cnt`: 销售商品数量\n    - `revenue.amount`: 该商品带来的总成交金额（GMV）\n    - `commission.amount`: 该商品预估佣金收入\n\n### 备注:\n- 此接口仅适用于 TikTok Shop 创作者账号。\n- 数据以自然月或自定义时间范围统计。\n- 默认排序为成交额（GMV）从高到低。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- start_date: 开始日期，格式为 'YYYY-MM-DD'，如 '2025-04-01'\n- end_date: 结束日期，格式为 'YYYY-MM-DD'，如 '2025-05-01'\n- page: 页码，默认为第一页 `0`\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回:\n- 创作者账号商品列表及商品销售分析数据\n\n# [English]\n### Purpose:\n- Retrieve the list of products promoted by a TikTok Shop creator account within a specified time range, along with their sales analytics.\n- Supports sorting by revenue or product publish time and allows pagination.\n\n### Response Fields:\n- `segments` (List of segmented data):\n  - `filter.creator_id`: Creator account ID\n  - `list_control`:\n    - `rules`: Sorting rules (e.g., by revenue, by product ID)\n    - `next_pagination`: Pagination info (has more pages, next page number, total pages, total records)\n  - `timed_lists`: List of product statistics within each time range, including:\n    - `product`:\n      - `id`: Product ID\n      - `name`: Product title\n      - `cover_image.thumb_url_list`: List of product thumbnail URLs\n    - `item_sold_cnt`: Number of items sold\n    - `revenue.amount`: Total Gross Merchandise Value (GMV) generated by the product\n    - `commission.amount`: Estimated commission income from the product\n\n### Notes:\n- This API is only available for TikTok Shop creator accounts.\n- Data is aggregated by natural month or the customized date range.\n- Default sorting is by GMV in descending order.\n\n### Parameters:\n- cookie: User Cookie string for authentication\n- start_date: Start date, formatted as 'YYYY-MM-DD', e.g., '2025-04-01'\n- end_date: End date, formatted as 'YYYY-MM-DD', e.g., '2025-05-01'\n- page: Page number, default is the first page `0`\n- proxy: Optional HTTP proxy address, can be omitted if not used\n    - Example format: `http://username:password@host:port`\n\n### Return:\n- Creator product list and corresponding sales analytics data\n\n# [示例/Example]\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"2025-04-01\",\n  \"end_date\": \"2025-05-01\",\n  \"page\": 0\n}\n```","operationId":"get_product_analytics_list_api_v1_tiktok_creator_get_product_analytics_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductListRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_creator_account_info":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取创作者账号信息/Get Creator Account Info","description":"# [中文]\n### 用途:\n- 获取 TikTok Shop 创作者账号的基础信息，包括用户名、头像链接、账号ID、注册地区、绑定合作伙伴信息、权限列表等。\n- 可用于账号状态验证、账号信息展示、合作关系检查及后续业务逻辑处理。\n\n### 备注:\n- 适用于所有 TikTok 创作者账号。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回内容说明:\n- `user_id`: 用户ID（字符串）\n- `user_type`: 用户类型（数字，代表账号类型）\n- `register_region_id`: 注册地区代码（如 \"us\"）\n- `user_name`: 用户名\n- `avatar`: 头像信息对象\n  - `uri`: 头像资源URI\n  - `url_list`: 头像图片URL列表\n- `permission_list`: 权限列表（整数数组）\n- `partner_id`: 合作伙伴ID\n- `partner_name`: 合作伙伴名称\n- `shop_account_official`: 是否为官方认证店铺账号（布尔值）\n- `switch_info`: 功能开关信息（如直播功能开关，字符串格式）\n- `tt_uid`: TikTok UID（字符串）\n- `nick_name`: 昵称\n- `live_streamer_menu_experiment`: 直播菜单实验字段（字符串，可能为空）\n- `experiment_variants`: 实验变种配置（对象）\n\n# [English]\n### Purpose:\n- Retrieve basic information of a TikTok Shop creator account, including username, avatar URLs, account ID, register region, partner binding info, and permission list.\n- Useful for verifying account status, displaying user profile data, checking partner binding status, and determining access permissions for business processes.\n\n### Notes:\n- Applicable to all TikTok creator accounts.\n\n### Parameters:\n- cookie: User Cookie string for authentication\n- proxy: Optional HTTP proxy address, can be omitted if not used\n    - Example format: `http://username:password@host:port`\n\n### Return Content Description:\n- `user_id`: User ID (string)\n- `user_type`: User type (integer, indicates account type)\n- `register_region_id`: Registered region code (e.g., \"us\")\n- `user_name`: Username\n- `avatar`: Avatar info object\n  - `uri`: Avatar resource URI\n  - `url_list`: List of avatar image URLs\n- `permission_list`: Permission list (list of integers)\n- `partner_id`: Partner ID\n- `partner_name`: Partner name\n- `shop_account_official`: Whether it's an official shop account (boolean)\n- `switch_info`: Feature switch info (e.g., live event switch, string format)\n- `tt_uid`: TikTok UID (string)\n- `nick_name`: Nickname\n- `live_streamer_menu_experiment`: Live streamer menu experiment field (string, may be empty)\n- `experiment_variants`: Experiment variant configurations (object)\n\n# [示例/Example]\n```json\n{\n  \"cookie\": \"your_cookie\"\n}\n```","operationId":"get_creator_account_info_api_v1_tiktok_creator_get_creator_account_info_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCreatorAccountInfoRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_showcase_product_list":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取橱窗商品列表/Get Showcase Product List","description":"# [中文]\n### 用途:\n- 获取 TikTok Shop 创作者账号橱窗中正在展示的商品列表。\n- 可用于商品管理、数据分析、查看当前推广商品等场景。\n\n### 备注:\n- 仅适用于已开通橱窗功能的 TikTok Shop 创作者账号。\n- 支持分页查询，通过 `count` 和 `offset` 控制数据量。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- count: 每页返回商品数量，默认 20\n- offset: 分页偏移量，默认 0\n- proxy: 可选 HTTP 代理地址\n    - 示例: `http://username:password@host:port`\n\n### 返回内容说明:\n- `products` (List[Dict]): 商品列表，每项包含以下字段：\n  - `product_id` (str): 商品ID\n  - `title` (str): 商品标题\n  - `format_available_price` (str): 商品展示价格（格式化后的字符串，如 `$7.94`）\n  - `seller_info` (dict):\n    - `seller_id` (str): 卖家ID\n    - `shop_name` (str): 店铺名称\n  - `cover` (dict): 主图信息\n    - `url_list` (List[str]): 主图 URL 列表（300x300）\n  - `images` (List[dict]): 图片列表\n    - 每张图片包含 `url_list` (原图 URL)\n  - `source` (str): 商品来源渠道（如 `Affiliate`）\n  - `stock_status` (int): 库存状态（1: 有货）\n  - `review_status` (int): 审核状态（1: 通过）\n  - `affiliate_info` (dict): 联盟佣金信息\n    - `commission_with_currency` (str): 佣金金额（如 `$0.95`）\n    - `commission_rate` (int): 佣金比例（如 1200 = 12%）\n  - `category_info` (dict): 类目信息\n    - `name` (str): 主分类名（如 `Beauty & Personal Care`）\n\n### 示例请求体:\n```json\n{\n  \"cookie\": \"your_cookie_string\",\n  \"count\": 20,\n  \"offset\": 0\n}\n```\n\n### 示例返回数据片段:\n```json\n{\n  \"products\": [\n    {\n      \"product_id\": \"1730905148396180014\",\n      \"title\": \"Car Paint Care Spray\",\n      \"format_available_price\": \"$7.94\",\n      \"seller_info\": {\n        \"seller_id\": \"7496108716782225966\",\n        \"shop_name\": \"moon moon shop shop\"\n      },\n      \"cover\": {\n        \"url_list\": [\n          \"https://example.com/xxx.jpg\"\n        ]\n      },\n      \"images\": [\n        {\n          \"url_list\": [\n            \"https://example.com/xxx.jpg\"\n          ]\n        }\n      ],\n      \"source\": \"Affiliate\",\n      \"stock_status\": 1,\n      \"review_status\": 1,\n      \"affiliate_info\": {\n        \"commission_with_currency\": \"$0.95\",\n        \"commission_rate\": 1200\n      },\n      \"category_info\": {\n        \"name\": \"Beauty & Personal Care\"\n      }\n    }\n  ]\n}\n```\n\n# [English]\n### Purpose:\n- Retrieve the list of products currently displayed in a TikTok Shop creator's showcase.\n- Useful for product management, analytics, and monitoring promoted items.\n\n### Notes:\n- Only available for TikTok creator accounts with the showcase feature enabled.\n- Supports pagination via `count` and `offset`.\n\n### Parameters:\n- cookie: User Cookie string for authentication\n- count: Number of products per page (default 20)\n- offset: Pagination offset (default 0)\n- proxy: Optional HTTP proxy address\n    - Example: `http://username:password@host:port`\n\n### Return Structure:\n- `products` (List[Dict]): List of showcased products, including:\n  - `product_id`, `title`, `format_available_price`, `seller_info`, `cover`, `images`, `source`, `stock_status`, `review_status`, `affiliate_info`, `category_info`.\n\n### Example Request:\n```json\n{\n  \"cookie\": \"your_cookie_string\",\n  \"count\": 20,\n  \"offset\": 0\n}\n```\n\n### Example Response Snippet:\n```json\n{\n  \"products\": [\n    {\n      \"product_id\": \"1730905148396180014\",\n      \"title\": \"Car Paint Care Spray\",\n      \"format_available_price\": \"$7.94\",\n      \"seller_info\": {\n        \"seller_id\": \"7496108716782225966\",\n        \"shop_name\": \"moon moon shop shop\"\n      },\n      \"cover\": {\n        \"url_list\": [\n          \"https://example.com/xxx.jpg\"\n        ]\n      },\n      \"images\": [...],\n      \"source\": \"Affiliate\",\n      \"stock_status\": 1,\n      \"review_status\": 1,\n      \"affiliate_info\": {\n        \"commission_with_currency\": \"$0.95\",\n        \"commission_rate\": 1200\n      },\n      \"category_info\": {\n        \"name\": \"Beauty & Personal Care\"\n      }\n    }\n  ]\n}\n```","operationId":"get_showcase_product_list_api_v1_tiktok_creator_get_showcase_product_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetShowcaseProductListRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_video_associated_product_list":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取视频关联商品列表/Get Video Associated Product List","description":"# [中文]\n### 用途:\n- 获取指定视频在 TikTok Shop 中关联展示的商品列表及其推广表现数据。\n- 可用于分析每个视频挂载商品的数量、商品价格区间、商品跳转链接，以及商品销售和推广效果。\n\n### 备注:\n- 必须提供 item_ids（视频 ID 列表）。\n- 时间范围默认使用 start_date 所在自然月。\n- 支持单次查询多个视频，返回每个视频关联的所有商品信息及对应商品的推广数据。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- start_date: 查询起始日期，格式为 'MM-DD-YYYY'，如 '04-01-2025'\n- item_ids: 视频 ID 列表，例如 [\"7496499484705246507\", \"7496110433699482923\"]\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回内容说明:\n- `segments`（分段数据列表）:\n  - `time_selector`: 时间筛选信息（起止时间戳）\n  - `filter`: 查询条件（视频 ID 列表）\n  - `timed_lists`: 每个时间段下的视频商品关联列表\n    - `videoToProductsMap`:\n      - `item_id`: 视频 ID\n      - `products`: 关联商品列表\n        - `id`: 商品 ID\n        - `name`: 商品名称\n        - `cover_image.thumb_url_list`: 商品图片 URL 列表\n        - `product_detail_page_url`: 商品跳转链接\n        - `price_min` / `price_max`: 商品价格区间\n      - `stats`:\n        - `product.id`: 商品 ID\n        - 商品销售推广表现（如销量、点击率等）\n\n### 示例请求体:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_ids\": [\"7496499484705246507\", \"7496110433699482923\"]\n}\n```\n\n# [English]\n### Purpose:\n- Retrieve the list of products associated with specified videos on TikTok Shop, along with their promotional performance data.\n- Useful for analyzing the number of products linked to each video, the product price range, product detail page links, and sales performance metrics.\n\n### Notes:\n- Requires item_ids (list of video IDs).\n- The time range defaults to the calendar month of the specified start_date.\n- Supports querying multiple videos at once.\n\n### Return Description:\n- `segments`:\n  - `time_selector`: Time filter information (start/end timestamps)\n  - `filter`: Query conditions (video ID list)\n  - `timed_lists`: Product list associated with videos in the selected time range\n    - `videoToProductsMap`:\n      - `item_id`: Video ID\n      - `products`:\n        - `id`: Product ID\n        - `name`: Product name\n        - `cover_image.thumb_url_list`: List of product image URLs\n        - `product_detail_page_url`: Product detail page link\n        - `price_min` / `price_max`: Price range\n      - `stats`:\n        - `product.id`: Product ID\n        - Promotional performance metrics (e.g., sales volume, CTR)\n\n### Example Request Body:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_ids\": [\"7496499484705246507\", \"7496110433699482923\"]\n}\n```","operationId":"get_video_associated_product_list_api_v1_tiktok_creator_get_video_associated_product_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVideoAssociatedProductListRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_video_detailed_stats":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取视频详细分段统计数据/Get Video Detailed Statistics","description":"# [中文]\n### 用途:\n- 获取指定 TikTok 视频在指定自然月内的详细分段统计数据。\n- 支持按时间段（日/周/月）统计新粉丝、点赞、评论、分享、商品浏览、完播率等多维指标。\n- 可用于深入分析单个视频在不同时间段的表现变化，优化内容策略和推广效果。\n\n### 备注:\n- 必须提供 item_id（视频 ID）。\n- 时间范围基于 start_date 所在自然月。\n- 若数据量大，返回的数据将按不同时间粒度分段统计（granularity=日/周/月）。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- start_date: 查询起始日期，格式为 'MM-DD-YYYY'，如 '04-01-2025'\n- item_id: 视频 ID，例如 \"7496499484705246507\"\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回内容说明:\n- `segments`（数据分段列表）:\n  - `time_selector`: 时间筛选条件（period, granularity, start_timestamp, end_timestamp）\n  - `filter`: 查询条件（creator_id, item_id）\n  - `timed_stats`: 按时间段返回的统计数据列表\n    - `start_timestamp`: 开始时间戳\n    - `end_timestamp`: 结束时间戳\n    - `stats`:\n      - `creator_id`: 创作者账号 ID\n      - `item_id`: 视频 ID\n      - `new_follower_cnt`: 新增粉丝数量\n      - `share_cnt`: 分享次数\n      - `comment_cnt`: 评论次数\n      - `like_cnt`: 点赞次数\n      - `product_view_cnt`: 商品浏览量\n      - `video_completion_rate`: 视频完播率（字符串，0-1）\n\n### 示例请求体:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_id\": \"7496499484705246507\"\n}\n```\n\n# [English]\n### Purpose:\n- Retrieve detailed segmented statistics for a specified TikTok video within a given calendar month.\n- Supports analyzing new followers, likes, comments, shares, product views, and video completion rates across different time segments (daily/weekly/monthly).\n- Useful for deeply analyzing the performance changes of a single video over time, optimizing content strategies and promotional outcomes.\n\n### Notes:\n- Requires item_id (video ID).\n- Time range is based on the calendar month of start_date.\n- Large datasets will be automatically segmented based on granularity (daily/weekly/monthly).\n\n### Return Description:\n- `segments`:\n  - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp)\n  - `filter`: Query conditions (creator_id, item_id)\n  - `timed_stats`: Segmented statistics list\n    - `start_timestamp`: Start timestamp\n    - `end_timestamp`: End timestamp\n    - `stats`:\n      - `creator_id`: Creator ID\n      - `item_id`: Video ID\n      - `new_follower_cnt`: Number of new followers\n      - `share_cnt`: Number of shares\n      - `comment_cnt`: Number of comments\n      - `like_cnt`: Number of likes\n      - `product_view_cnt`: Number of product views\n      - `video_completion_rate`: Video completion rate (string, range 0-1)\n\n### Example Request Body:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_id\": \"7496499484705246507\"\n}\n```","operationId":"get_video_detailed_stats_api_v1_tiktok_creator_get_video_detailed_stats_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVideoDetailedStatsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_video_to_product_stats":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取视频与商品关联统计数据/Get Video-Product Association Statistics","description":"# [中文]\n### 用途:\n- 获取指定 TikTok 视频与指定商品关联的推广详细统计数据。\n- 支持分析视频为商品带来的商品浏览量、点击量、销售量、订单量、商品收入、直接收入等多维度指标。\n- 返回数据按时间段（日/周/月）分段统计，便于观察趋势变化。\n\n### 备注:\n- 必须同时提供 item_id（视频 ID）和 product_id（商品 ID）。\n- 时间范围基于 start_date 所在自然月。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- start_date: 查询起始日期，格式为 'MM-DD-YYYY'，如 '04-01-2025'\n- item_id: 视频 ID，例如 \"7496499484705246507\"\n- product_id: 商品 ID，例如 \"1731050202505515549\"\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回内容说明:\n- `segments`（数据分段列表）:\n  - `time_selector`: 时间筛选参数（period, granularity, start_timestamp, end_timestamp）\n  - `filter`: 查询条件（creator_id, item_id, product_id）\n  - `timed_stats`: 按时间段分段的统计数据\n    - `start_timestamp`: 时间段开始时间戳\n    - `end_timestamp`: 时间段结束时间戳\n    - `stats`:\n      - `item_id`: 视频 ID\n      - `product_id`: 商品 ID\n      - `product_revenue.amount_formatted`: 商品产生的总收入（格式化字符串，如 \"$100.00\"）\n      - `product_revenue.amount`: 商品产生的总收入（数值）\n      - `direct_revenue.amount_formatted`: 直接成交产生的收入（格式化字符串）\n      - `product_sales_cnt`: 商品销售数量\n      - `product_view_cnt`: 商品浏览量\n      - `product_click_cnt`: 商品点击量\n      - `order_cnt`: 生成订单数量\n\n### 示例请求体:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_id\": \"7496499484705246507\",\n  \"product_id\": \"1731050202505515549\"\n}\n```\n\n# [English]\n### Purpose:\n- Retrieve detailed promotional statistics between a specific TikTok video and a specific product.\n- Supports analyzing metrics such as product views, clicks, sales, order counts, product revenue, and direct revenue.\n- The data is segmented by time intervals (daily/weekly/monthly) to observe trends over time.\n\n### Notes:\n- Requires both item_id (video ID) and product_id (product ID).\n- The time range is based on the calendar month of the specified start_date.\n\n### Return Description:\n- `segments`:\n  - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp)\n  - `filter`: Query conditions (creator_id, item_id, product_id)\n  - `timed_stats`: Segmented statistics list\n    - `start_timestamp`: Start timestamp\n    - `end_timestamp`: End timestamp\n    - `stats`:\n      - `item_id`: Video ID\n      - `product_id`: Product ID\n      - `product_revenue.amount_formatted`: Total product revenue (formatted string, e.g., \"$100.00\")\n      - `product_revenue.amount`: Total product revenue (numeric)\n      - `direct_revenue.amount_formatted`: Direct sales revenue (formatted string)\n      - `product_sales_cnt`: Number of products sold\n      - `product_view_cnt`: Number of product views\n      - `product_click_cnt`: Number of product clicks\n      - `order_cnt`: Number of orders created\n\n### Example Request Body:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_id\": \"7496499484705246507\",\n  \"product_id\": \"1731050202505515549\"\n}\n```","operationId":"get_video_to_product_stats_api_v1_tiktok_creator_get_video_to_product_stats_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVideoToProductStatsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_product_related_videos":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取同款商品关联视频/Get Product Related Videos","description":"# [中文]\n### 用途:\n- 获取与指定商品关联的所有视频列表和对应的互动数据（如点赞数、评论数、分享数）。\n- 可用于分析同款商品在不同创作者视频中的推广效果和差异。\n- 支持按时间筛选，默认查询指定 start_date 所在自然月内的数据。\n\n### 备注:\n- 必须同时提供 item_id（当前视频 ID）和 product_id（商品 ID）。\n- 返回数据按时间范围查询，同一商品下的其他视频列表。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- start_date: 查询起始日期，格式为 'MM-DD-YYYY'，如 '04-01-2025'\n- item_id: 当前视频 ID，例如 \"7496499484705246507\"\n- product_id: 商品 ID，例如 \"1731050202505515549\"\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回内容说明:\n- `segments`（数据分段列表）:\n  - `time_selector`: 时间筛选参数（period, granularity, start_timestamp, end_timestamp）\n  - `filter`: 查询条件（creator_id, product_id, item_id）\n  - `timed_lists`: 视频列表\n    - `start_timestamp`: 开始时间戳\n    - `end_timestamp`: 结束时间戳\n    - `stats`:\n      - `video_product_id`: 商品 ID\n      - `video`:\n        - `item_id`: 视频 ID\n        - `video_id`: 视频内部唯一 ID\n        - `name`: 视频文案标题\n        - `publish_time`: 发布时间戳\n        - `duration`: 视频时长（秒）\n        - `video_play_info`:\n          - `post_url`: 视频封面图片链接\n          - `video_infos.main_url`: 视频播放地址\n      - `video_like_cnt`: 视频点赞数\n      - `video_comment_cnt`: 视频评论数\n      - `video_share_cnt`: 视频分享数\n\n### 示例请求体:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_id\": \"7496499484705246507\",\n  \"product_id\": \"1731050202505515549\"\n}\n```\n\n# [English]\n### Purpose:\n- Retrieve the list of all videos associated with a specified product along with their interaction metrics (such as like count, comment count, share count).\n- Useful for analyzing the promotional effectiveness and differences of the same product across different creators' videos.\n- Supports time-based filtering, defaulting to the calendar month of the specified start_date.\n\n### Notes:\n- Requires both item_id (current video ID) and product_id (product ID).\n- Returns a list of other videos where the same product is featured.\n\n### Return Description:\n- `segments`:\n  - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp)\n  - `filter`: Query conditions (creator_id, product_id, item_id)\n  - `timed_lists`: List of related videos\n    - `start_timestamp`: Start timestamp\n    - `end_timestamp`: End timestamp\n    - `stats`:\n      - `video_product_id`: Product ID\n      - `video`:\n        - `item_id`: Video ID\n        - `video_id`: Video internal ID\n        - `name`: Video caption/title\n        - `publish_time`: Publish timestamp\n        - `duration`: Video duration (seconds)\n        - `video_play_info`:\n          - `post_url`: Video cover image link\n          - `video_infos.main_url`: Main video URL\n      - `video_like_cnt`: Like count\n      - `video_comment_cnt`: Comment count\n      - `video_share_cnt`: Share count\n\n### Example Request Body:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_id\": \"7496499484705246507\",\n  \"product_id\": \"1731050202505515549\"\n}\n```","operationId":"get_product_related_videos_api_v1_tiktok_creator_get_product_related_videos_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductRelatedVideosRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/creator/get_video_audience_stats":{"post":{"tags":["TikTok-Creator-API"],"summary":"获取视频受众分析数据/Get Video Audience Analysis Data","description":"# [中文]\n### 用途:\n- 获取指定 TikTok 视频观众的用户画像统计数据，包括性别分布、年龄分布、地区分布等维度。\n- 可用于精准了解视频观众群体特征，指导内容创作、商品选择和营销策略优化。\n- 支持按时间段（日/周/月）分析变化趋势。\n\n### 备注:\n- 此接口需要提供 item_id（视频 ID）。\n- 受众画像数据来源于观看和互动用户的统计特征。\n\n### 参数:\n- cookie: 用户 Cookie 字符串（用于身份认证）\n- start_date: 查询起始日期，格式为 'MM-DD-YYYY'，如 '04-01-2025'\n- item_id: 视频 ID，例如 \"7496499484705246507\"\n- proxy: 可选 HTTP 代理地址，如不使用可省略\n    - 示例格式: `http://username:password@host:port`\n\n### 返回内容说明:\n- `segments`（数据分段列表）:\n  - `time_selector`: 时间筛选参数（period, granularity, start_timestamp, end_timestamp）\n  - `filter`: 查询条件（creator_id, item_id）\n  - `timed_profile`: 分段画像统计数据\n    - `start_timestamp`: 开始时间戳\n    - `end_timestamp`: 结束时间戳\n    - `stats`:\n      - `follower_genders`: 性别分布\n        - `key`: 性别（female/male）\n        - `value`: 占比（字符串，0-1）\n      - `follower_ages`: 年龄段分布\n        - `key`: 年龄段（如 \"18-24\", \"25-34\", 等）\n        - `value`: 占比（字符串，0-1）\n      - `follower_regions`: 地区分布\n        - `key`: 国家代码（如 \"US\"）\n        - `value`: 占比（字符串，0-1）\n      - `profile_type`: 画像类型，固定值 2（受众画像）\n\n### 示例请求体:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_id\": \"7496499484705246507\"\n}\n```\n\n# [English]\n### Purpose:\n- Retrieve audience profile statistics for a specified TikTok video, including gender distribution, age distribution, and regional distribution.\n- Useful for accurately understanding the characteristics of the video audience to guide content creation, product selection, and marketing strategy optimization.\n- Supports trend analysis across different time intervals (daily/weekly/monthly).\n\n### Notes:\n- Requires item_id (video ID).\n- Audience profile data is based on characteristics of users who viewed and interacted with the video.\n\n### Return Description:\n- `segments`:\n  - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp)\n  - `filter`: Query conditions (creator_id, item_id)\n  - `timed_profile`: Audience profile statistics\n    - `start_timestamp`: Start timestamp\n    - `end_timestamp`: End timestamp\n    - `stats`:\n      - `follower_genders`: Gender distribution\n        - `key`: Gender (\"female\" or \"male\")\n        - `value`: Proportion (string, range 0-1)\n      - `follower_ages`: Age group distribution\n        - `key`: Age group (e.g., \"18-24\", \"25-34\")\n        - `value`: Proportion (string, range 0-1)\n      - `follower_regions`: Regional distribution\n        - `key`: Country code (e.g., \"US\")\n        - `value`: Proportion (string, range 0-1)\n      - `profile_type`: Profile type, fixed value 2 (Audience Profile)\n\n### Example Request Body:\n```json\n{\n  \"cookie\": \"your_cookie\",\n  \"start_date\": \"04-01-2025\",\n  \"item_id\": \"7496499484705246507\"\n}\n```","operationId":"get_video_audience_stats_api_v1_tiktok_creator_get_video_audience_stats_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVideoAudienceStatsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/analytics/fetch_video_metrics":{"get":{"tags":["TikTok-Analytics-API"],"summary":"获取作品的统计数据/Get video metrics","description":"# [中文]\n### 用途:\n- 获取TikTok视频的详细统计数据，包括观看量、点赞数、评论数和收藏数等核心指标\n- 提供总量统计以及从发布日期起14天的每日趋势数据，便于分析视频表现\n- 帮助创作者分析内容效果，评估用户互动情况，优化内容策略\n\n### 参数:\n- item_id: 视频作品ID，必填参数，可从视频分享链接或TikTok Studio获取\n\n### 返回内容说明:\n- `item_id`: 请求的视频ID\n- `video_views`: 视频总观看次数\n  - `value`: 观看次数数值\n- `video_views_14_days`: 近14天的每日观看量趋势数据\n  - `interval`: 数据间隔类型\n  - `value`: 每日数据列表\n- `likes`: 视频总点赞数\n  - `value`: 点赞数值\n- `likes_14_days`: 近14天的每日点赞数趋势数据\n- `comments`: 视频总评论数\n  - `value`: 评论数值\n- `comments_14_days`: 近14天的每日评论数趋势数据\n- `favorites`: 视频总收藏数\n  - `value`: 收藏数值\n- `favorites_14_days`: 近14天的每日收藏数趋势数据\n- `video_summary`: 视频表现的概览分析\n  - `title`: 概览标题\n  - `content`: 概览内容\n  - `summary_type`: 概览类型\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/analytics/fetch_video_metrics\",\n  \"params\": {\n    \"item_id\": \"7502551047378832671\"\n  },\n  \"data\": {\n    \"item_id\": \"7502551047378832671\",\n    \"video_views\": {\n      \"value\": 1555500\n    },\n    \"likes\": {\n      \"value\": 11571\n    },\n    \"comments\": {\n      \"value\": 6920\n    },\n    \"favorites\": {\n      \"value\": 1243\n    },\n    \"video_summary\": {\n      \"title\": \"Overview\",\n      \"content\": \"This post received more comments per view than most other posts.\"\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Retrieve detailed analytics data for TikTok videos, including views, likes, comments, and favorites\n- Provide total statistics and daily trends for 14 days since the release date, facilitating video performance analysis\n- Help creators analyze content effectiveness, evaluate user engagement, and optimize content strategy\n\n### Parameters:\n- item_id: Video ID, required parameter, can be obtained from video sharing links or TikTok Studio\n\n### Return Description:\n- `item_id`: The requested video ID\n- `video_views`: Total number of video views\n  - `value`: View count value\n- `video_views_14_days`: Daily view trends for the past 14 days\n  - `interval`: Data interval type\n  - `value`: List of daily data\n- `likes`: Total number of likes on the video\n  - `value`: Like count value\n- `likes_14_days`: Daily like trends for the past 14 days\n- `comments`: Total number of comments on the video\n  - `value`: Comment count value\n- `comments_14_days`: Daily comment trends for the past 14 days\n- `favorites`: Total number of times the video was favorited\n  - `value`: Favorite count value\n- `favorites_14_days`: Daily favorite trends for the past 14 days\n- `video_summary`: Overview analysis of video performance\n  - `title`: Overview title\n  - `content`: Overview content\n  - `summary_type`: Overview type\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/analytics/fetch_video_metrics\",\n  \"params\": {\n    \"item_id\": \"7502551047378832671\"\n  },\n  \"data\": {\n    \"item_id\": \"7502551047378832671\",\n    \"video_views\": {\n      \"value\": 1555500\n    },\n    \"likes\": {\n      \"value\": 11571\n    },\n    \"comments\": {\n      \"value\": 6920\n    },\n    \"favorites\": {\n      \"value\": 1243\n    },\n    \"video_summary\": {\n      \"title\": \"Overview\",\n      \"content\": \"This post received more comments per view than most other posts.\"\n    }\n  }\n}\n```","operationId":"fetch_video_metrics_api_v1_tiktok_analytics_fetch_video_metrics_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7502551047378832671"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/analytics/detect_fake_views":{"get":{"tags":["TikTok-Analytics-API"],"summary":"检测视频虚假流量分析/Detect fake views in video","description":"# [中文]\n### 用途:\n- 通过高级算法分析TikTok视频流量数据，精确检测可能存在的虚假观看量和不自然互动\n- 基于TikTok赛马机制(Traffic Pool)流量池理论，评估内容真实性和流量质量\n- 提供全面的欺诈风险分析，包含8种维度、20+指标的深度评估\n- 为创作者、MCN机构和内容管理者提供专业的流量质量报告和优化建议\n\n### 参数:\n- item_id: 视频作品ID，必填参数，可从视频URL中提取(例如: https://www.tiktok.com/@tiktok/video/7460937381265411370 中的7460937381265411370)\n- content_category: 内容分类，可选参数，影响互动率基准值，选项包括:\n  - default: 默认类别，通用内容\n  - entertainment: 娱乐内容，预期有较高互动率\n  - education: 教育内容，预期有适中互动和较高收藏率\n  - product: 产品内容，预期有较低互动但较高转化\n  - verified_large: 大型认证账号，预期互动率适当降低\n\n### 返回内容详解:\n- `video_metrics`: 视频核心指标\n  - `total_views`: 总观看量，视频被观看的总次数\n  - `total_likes`: 总点赞数，用户点赞互动次数\n  - `total_comments`: 总评论数，用户评论互动次数\n  - `total_favorites`: 总收藏数，用户收藏次数\n  - `total_shares`: 总分享数，用户分享次数\n  - `engagement_rates`: 互动率指标，值越高越好\n    - `like_ratio`: 点赞率，正常值 1-10%，大账号可能较低\n    - `comment_ratio`: 评论率，正常值 0.1-0.5%，高于1%极佳\n    - `favorite_ratio`: 收藏率，正常值 0.05-0.8%\n    - `share_ratio`: 分享率，正常值 0.05-0.5%，高于1%极佳\n\n- `creator_metrics`: 创作者账号健康指标\n  - `account_age_days`: 账号存在天数，越长越可信\n  - `follower_count`: 粉丝数量，影响预期观看量\n  - `verified`: 是否验证账号，认证账号可信度更高\n  - `trust_score`: 账号信任度评分(0-100)，越高越可信\n\n- `content_metrics`: 内容质量指标\n  - `content_type`: 内容类型(video, image等)\n  - `created_by_ai`: 是否AI生成，AI生成内容可能有特定流量模式\n  - `high_quality_upload`: 是否高质量上传，高质量上传更可信\n\n- `fake_view_analysis`: 虚假流量综合分析\n  - `fake_score`: 虚假流量评分(0-100)，评分越低越好:\n    - 0-20: 极低风险，自然流量模式\n    - 20-40: 低风险，可能有少量异常但不构成问题\n    - 40-60: 中等风险，存在值得关注的异常\n    - 60-80: 高风险，明显的虚假流量特征\n    - 80-100: 极高风险，几乎确定存在虚假流量\n  - `confidence_level`: 风险等级，分为\"Minimal\", \"Low\", \"Medium\", \"High\"\n  - `estimated_fake_views`: 估计虚假观看量，基于虚假流量模型推算\n  - `fake_view_percentage`: 虚假观看百分比，虚假占总量的比例\n  - `is_suspicious`: 是否可疑，综合判断是否需要关注\n  - `main_detection_reason`: 主要检测原因，最显著的异常特征\n  - `component_scores`: 各维度异常评分，各项都是0-100，越低越好:\n    - `engagement_score`: 互动异常评分\n    - `distribution_score`: 分布异常评分\n    - `consistency_score`: 一致性异常评分\n    - `creator_credibility_score`: 创作者可信度异常评分\n    - `content_authenticity_score`: 内容真实性异常评分\n    - `follower_correlation_score`: 粉丝相关性异常评分\n    - `racing_mechanism_score`: 赛马机制异常评分\n    - `fan_growth_score`: 粉丝增长异常评分\n\n- `traffic_pool`: 流量池分析(TikTok赛马机制)\n  - `current_tier`: 当前流量池级别(1-8)，越高代表流量越大\n  - `current_tier_name`: 当前流量池名称\n  - `expected_tier`: 预期流量池级别，基于有机流量预测\n  - `expected_tier_name`: 预期流量池名称\n  - `current_views_range`: 当前流量池预期观看范围\n  - `expected_views_range`: 预期流量池观看范围\n  - `estimated_organic_views`: 估计有机观看量，扣除虚假后的真实观看\n\n- `suspicious_features`: 可疑特征列表，检测到的具体异常现象\n\n- `recommendations`: 建议操作\n  - `action`: 建议操作类型，可能值包括:\n    - `no_action`: 无需操作，健康内容\n    - `monitor`: 持续监控，存在轻微异常\n    - `scheduled_review`: 安排审核，存在值得关注的异常\n    - `immediate_review`: 立即审核，存在严重异常\n  - `risk_level`: 风险等级(\"low\", \"medium\", \"high\", \"critical\")\n  - `potential_revenue_impact`: 潜在收益影响\n  - `suggested_steps`: 建议步骤，具体操作建议\n\n- `mcn_report`: (可选)MCN商业影响分析报告，适用于商业账号\n  - `summary`: 摘要信息\n  - `business_impact`: 商业影响评估\n    - `revenue_impact`: 收益影响评估\n    - `brand_safety_impact`: 品牌安全影响\n    - `platform_relationship`: 平台关系影响\n    - `contract_impact`: 合约影响评估\n  - `recommended_actions`: 建议操作清单\n  - `historical_context`: 历史背景数据\n\n### 特性与优势:\n- 基于TikTok原生流量池(Traffic Pool)理论构建的精确评估系统\n- 8个维度、20+指标的全面分析，覆盖流量、互动、创作者、内容等全方位评估\n- 自适应算法，根据账号规模、认证状态、内容类型自动调整阈值\n- 基于大数据统计模型的异常检测，准确识别不自然流量模式\n- 为不同规模账号(微型、小型、中型、大型、超大型)提供定制化评估标准\n- 提供详细的商业影响分析和具体可行的建议步骤\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/analytics/detect_fake_views\",\n  \"params\": {\n    \"item_id\": \"7460937381265411370\",\n    \"content_category\": \"verified_large\"\n  },\n  \"data\": {\n    \"video_metrics\": {\n      \"total_views\": 159414915,\n      \"total_likes\": 15817234,\n      \"total_comments\": 392493,\n      \"total_favorites\": 1051470,\n      \"total_shares\": 1312741,\n      \"engagement_rates\": {\n        \"like_ratio\": 0.09922,\n        \"comment_ratio\": 0.00246,\n        \"favorite_ratio\": 0.0066,\n        \"share_ratio\": 0.00823\n      }\n    },\n    \"creator_metrics\": {\n      \"account_age_days\": 3733.94,\n      \"follower_count\": 89827771,\n      \"verified\": true,\n      \"trust_score\": 100\n    },\n    \"content_metrics\": {\n      \"content_type\": \"video\",\n      \"created_by_ai\": false,\n      \"high_quality_upload\": true\n    },\n    \"fake_view_analysis\": {\n      \"fake_score\": 7.16,\n      \"confidence_level\": \"Minimal\",\n      \"estimated_fake_views\": 7970745,\n      \"fake_view_percentage\": 5.0,\n      \"is_suspicious\": false,\n      \"main_detection_reason\": \"Statistical View Anomalies\",\n      \"component_scores\": {\n        \"engagement_score\": 0.0,\n        \"distribution_score\": 10.0,\n        \"consistency_score\": 0,\n        \"creator_credibility_score\": 0,\n        \"content_authenticity_score\": 34.0,\n        \"follower_correlation_score\": 35.0,\n        \"racing_mechanism_score\": 0,\n        \"fan_growth_score\": 45\n      }\n    },\n    \"traffic_pool\": {\n      \"current_tier\": 8,\n      \"current_tier_name\": \"8th-Level Traffic Pool\",\n      \"expected_tier\": 8,\n      \"expected_tier_name\": \"8th-Level Traffic Pool\",\n      \"current_views_range\": \"30M+\",\n      \"expected_views_range\": \"30M+\",\n      \"estimated_organic_views\": 148000807\n    },\n    \"suspicious_features\": [\n      \"Suspicious: Reached 100000 followers from 10000 in only 31 days\",\n      \"Suspicious: Account gaining 24063 followers per day on average\"\n    ],\n    \"recommendations\": {\n      \"action\": \"no_action\",\n      \"risk_level\": \"low\",\n      \"potential_revenue_impact\": \"minimal\",\n      \"suggested_steps\": [\n        \"No immediate action required\",\n        \"Include in routine monitoring\"\n      ]\n    },\n    \"mcn_report\": {\n      \"summary\": {\n        \"estimated_revenue_impact\": 7970.745,\n        \"recommended_actions\": \"No immediate action required\"\n      },\n      \"business_impact\": {\n        \"revenue_impact\": {\n          \"level\": \"low\",\n          \"estimated_amount\": 7970.745\n        },\n        \"brand_safety_impact\": {\n          \"level\": \"minimal\"\n        },\n        \"platform_relationship\": {\n          \"status\": \"good\"\n        }\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Analyze TikTok video traffic data using advanced algorithms to precisely detect potential fake views and unnatural engagement\n- Evaluate content authenticity and traffic quality based on TikTok's Traffic Pool theory\n- Provide comprehensive fraud risk analysis with in-depth assessment across 8 dimensions and 20+ metrics\n- Deliver professional traffic quality reports and optimization recommendations for creators, MCN agencies, and content managers\n\n### Parameters:\n- item_id: Video ID, required parameter, can be extracted from video URL (e.g., 7460937381265411370 from https://www.tiktok.com/@tiktok/video/7460937381265411370)\n- content_category: Content category, optional parameter, affects engagement rate benchmarks, options include:\n  - default: Default category for general content\n  - entertainment: Entertainment content, expected to have higher engagement\n  - education: Educational content, expected to have moderate engagement and higher save rates\n  - product: Product content, expected to have lower engagement but higher conversion\n  - verified_large: Large verified accounts, expected to have appropriately lower engagement rates\n\n### Return Description:\n- `video_metrics`: Core video metrics\n  - `total_views`: Total number of views\n  - `total_likes`: Total number of likes\n  - `total_comments`: Total number of comments\n  - `total_favorites`: Total number of saves\n  - `total_shares`: Total number of shares\n  - `engagement_rates`: Engagement rate metrics, higher is better\n    - `like_ratio`: Like rate, normal range 1-10%, may be lower for large accounts\n    - `comment_ratio`: Comment rate, normal range 0.1-0.5%, excellent if above 1%\n    - `favorite_ratio`: Save rate, normal range 0.05-0.8%\n    - `share_ratio`: Share rate, normal range 0.05-0.5%, excellent if above 1%\n\n- `creator_metrics`: Creator account health indicators\n  - `account_age_days`: Account age in days, longer is more credible\n  - `follower_count`: Number of followers, affects expected view count\n  - `verified`: Whether account is verified, verified accounts have higher credibility\n  - `trust_score`: Account trust score (0-100), higher is more trustworthy\n\n- `content_metrics`: Content quality indicators\n  - `content_type`: Content type (video, image, etc.)\n  - `created_by_ai`: Whether AI-generated, AI-generated content may have specific traffic patterns\n  - `high_quality_upload`: Whether high-quality upload, high-quality uploads are more credible\n\n- `fake_view_analysis`: Comprehensive fake traffic analysis\n  - `fake_score`: Fake view score (0-100), lower is better:\n    - 0-20: Very low risk, natural traffic patterns\n    - 20-40: Low risk, may have minor anomalies but not problematic\n    - 40-60: Medium risk, anomalies worth attention\n    - 60-80: High risk, obvious fake traffic characteristics\n    - 80-100: Very high risk, almost certainly fake traffic\n  - `confidence_level`: Risk level, categorized as \"Minimal\", \"Low\", \"Medium\", \"High\"\n  - `estimated_fake_views`: Estimated fake views, calculated based on fake traffic model\n  - `fake_view_percentage`: Fake view percentage, proportion of fake views to total views\n  - `is_suspicious`: Whether suspicious, comprehensive judgment if attention is needed\n  - `main_detection_reason`: Main detection reason, most significant anomaly feature\n  - `component_scores`: Dimensional anomaly scores, each 0-100, lower is better:\n    - `engagement_score`: Engagement anomaly score\n    - `distribution_score`: Distribution anomaly score\n    - `consistency_score`: Consistency anomaly score\n    - `creator_credibility_score`: Creator credibility anomaly score\n    - `content_authenticity_score`: Content authenticity anomaly score\n    - `follower_correlation_score`: Follower correlation anomaly score\n    - `racing_mechanism_score`: Racing mechanism anomaly score\n    - `fan_growth_score`: Fan growth anomaly score\n\n- `traffic_pool`: Traffic pool analysis (TikTok racing mechanism)\n  - `current_tier`: Current traffic pool level (1-8), higher means more traffic\n  - `current_tier_name`: Current traffic pool name\n  - `expected_tier`: Expected traffic pool level, based on organic traffic prediction\n  - `expected_tier_name`: Expected traffic pool name\n  - `current_views_range`: Current traffic pool expected view range\n  - `expected_views_range`: Expected traffic pool view range\n  - `estimated_organic_views`: Estimated organic views, real views after deducting fake ones\n\n- `suspicious_features`: List of suspicious features, specific detected anomalies\n\n- `recommendations`: Recommended actions\n  - `action`: Recommended action type, possible values include:\n    - `no_action`: No action needed, healthy content\n    - `monitor`: Continuous monitoring, minor anomalies present\n    - `scheduled_review`: Schedule review, anomalies worth attention\n    - `immediate_review`: Immediate review, serious anomalies present\n  - `risk_level`: Risk level (\"low\", \"medium\", \"high\", \"critical\")\n  - `potential_revenue_impact`: Potential revenue impact\n  - `suggested_steps`: Suggested steps, specific action recommendations\n\n- `mcn_report`: (Optional) MCN business impact analysis report, applicable for business accounts\n  - `summary`: Summary information\n  - `business_impact`: Business impact assessment\n    - `revenue_impact`: Revenue impact assessment\n    - `brand_safety_impact`: Brand safety impact\n    - `platform_relationship`: Platform relationship impact\n    - `contract_impact`: Contract impact assessment\n  - `recommended_actions`: Recommended action list\n  - `historical_context`: Historical background data\n\n### Features and Advantages:\n- Precise evaluation system built on TikTok's native Traffic Pool theory\n- Comprehensive analysis across 8 dimensions and 20+ metrics, covering traffic, engagement, creator, content, etc.\n- Adaptive algorithm automatically adjusts thresholds based on account size, verification status, content type\n- Anomaly detection based on big data statistical models, accurately identifies unnatural traffic patterns\n- Provides customized evaluation standards for different account sizes (micro, small, medium, large, extra-large)\n- Delivers detailed business impact analysis and specific, actionable recommendations\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/analytics/detect_fake_views\",\n  \"params\": {\n    \"item_id\": \"7460937381265411370\",\n    \"content_category\": \"verified_large\"\n  },\n  \"data\": {\n    \"video_metrics\": {\n      \"total_views\": 159414915,\n      \"total_likes\": 15817234,\n      \"total_comments\": 392493,\n      \"total_favorites\": 1051470,\n      \"total_shares\": 1312741,\n      \"engagement_rates\": {\n        \"like_ratio\": 0.09922,\n        \"comment_ratio\": 0.00246,\n        \"favorite_ratio\": 0.0066,\n        \"share_ratio\": 0.00823\n      }\n    },\n    \"creator_metrics\": {\n      \"account_age_days\": 3733.94,\n      \"follower_count\": 89827771,\n      \"verified\": true,\n      \"trust_score\": 100\n    },\n    \"content_metrics\": {\n      \"content_type\": \"video\",\n      \"created_by_ai\": false,\n      \"high_quality_upload\": true\n    },\n    \"fake_view_analysis\": {\n      \"fake_score\": 7.16,\n      \"confidence_level\": \"Minimal\",\n      \"estimated_fake_views\": 7970745,\n      \"fake_view_percentage\": 5.0,\n      \"is_suspicious\": false,\n      \"main_detection_reason\": \"Statistical View Anomalies\",\n      \"component_scores\": {\n        \"engagement_score\": 0.0,\n        \"distribution_score\": 10.0,\n        \"consistency_score\": 0,\n        \"creator_credibility_score\": 0,\n        \"content_authenticity_score\": 34.0,\n        \"follower_correlation_score\": 35.0,\n        \"racing_mechanism_score\": 0,\n        \"fan_growth_score\": 45\n      }\n    },\n    \"traffic_pool\": {\n      \"current_tier\": 8,\n      \"current_tier_name\": \"8th-Level Traffic Pool\",\n      \"expected_tier\": 8,\n      \"expected_tier_name\": \"8th-Level Traffic Pool\",\n      \"current_views_range\": \"30M+\",\n      \"expected_views_range\": \"30M+\",\n      \"estimated_organic_views\": 148000807\n    },\n    \"suspicious_features\": [\n      \"Suspicious: Reached 100000 followers from 10000 in only 31 days\",\n      \"Suspicious: Account gaining 24063 followers per day on average\"\n    ],\n    \"recommendations\": {\n      \"action\": \"no_action\",\n      \"risk_level\": \"low\",\n      \"potential_revenue_impact\": \"minimal\",\n      \"suggested_steps\": [\n        \"No immediate action required\",\n        \"Include in routine monitoring\"\n      ]\n    },\n    \"mcn_report\": {\n      \"summary\": {\n        \"estimated_revenue_impact\": 7970.745,\n        \"recommended_actions\": \"No immediate action required\"\n      },\n      \"business_impact\": {\n        \"revenue_impact\": {\n          \"level\": \"low\",\n          \"estimated_amount\": 7970.745\n        },\n        \"brand_safety_impact\": {\n          \"level\": \"minimal\"\n        },\n        \"platform_relationship\": {\n          \"status\": \"good\"\n        }\n      }\n    }\n  }\n}\n```","operationId":"detect_fake_views_api_v1_tiktok_analytics_detect_fake_views_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7460937381265411370"},{"name":"content_category","in":"query","required":false,"schema":{"type":"string","description":"内容分类/Content category, options: default, entertainment, education, product, verified_large","default":"default","title":"Content Category"},"description":"内容分类/Content category, options: default, entertainment, education, product, verified_large"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/analytics/fetch_comment_keywords":{"get":{"tags":["TikTok-Analytics-API"],"summary":"获取视频评论关键词分析/Get comment keywords analysis","description":"# [中文]\n### 用途:\n- 分析视频评论中出现的热门关键词和话题，挖掘用户反馈\n- 提取观众评论中的主要内容和观点，帮助理解受众关注点\n- 支持创作者优化内容策略，增强与观众的互动和连接\n\n### 参数:\n- item_id: 视频作品ID，必填参数，可从视频分享链接或TikTok Studio获取\n\n### 返回内容说明:\n- `item_id`: 请求的视频ID\n- `key_words`: 评论中提取的关键词列表，包含以下字段:\n  - `key_word`: 关键词文本\n  - `comments`: 包含该关键词的评论列表，每条评论包含:\n    - `cid`: 评论ID\n    - `text`: 评论内容\n    - `create_date`: 评论创建时间戳\n    - `digg_count`: 评论获赞数量\n    - `comment_type`: 评论类型\n    - `comment_author`: 评论作者信息\n      - `uid`: 用户ID\n      - `nick_name`: 用户昵称\n      - `cover`: 用户头像信息\n        - `url_list`: 头像URL列表\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/analytics/fetch_comment_keywords\",\n  \"params\": {\n    \"item_id\": \"7502551047378832671\"\n  },\n  \"data\": {\n    \"item_id\": \"7502551047378832671\",\n    \"key_words\": [\n      {\n        \"key_word\": \"tik tok\",\n        \"comments\": [\n          {\n            \"cid\": \"7502621950457463574\",\n            \"comment_author\": {\n              \"nick_name\": \"ollie_russell05\",\n              \"uid\": \"7332627012203414560\"\n            },\n            \"create_date\": 1746840350,\n            \"digg_count\": 17,\n            \"text\": \"Imagine been tik tok and only getting 700 likes 🥀🙏😭\"\n          }\n        ]\n      },\n      {\n        \"key_word\": \"go viral\",\n        \"comments\": [\n          {\n            \"cid\": \"7502743477604680465\",\n            \"comment_author\": {\n              \"nick_name\": \"★ 🇦🇫\",\n              \"uid\": \"7274239704915149829\"\n            },\n            \"create_date\": 1746868614,\n            \"digg_count\": 13,\n            \"text\": \"I want to go viral\"\n          }\n        ]\n      }\n    ]\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Analyze popular keywords and topics in video comments to uncover user feedback\n- Extract main content and opinions from audience comments to understand viewer focus points\n- Support creators in optimizing content strategy and enhancing audience engagement and connection\n\n### Parameters:\n- item_id: Video ID, required parameter, can be obtained from video sharing links or TikTok Studio\n\n### Return Description:\n- `item_id`: The requested video ID\n- `key_words`: List of keywords extracted from comments, including:\n  - `key_word`: Keyword text\n  - `comments`: List of comments containing this keyword, each comment includes:\n    - `cid`: Comment ID\n    - `text`: Comment content\n    - `create_date`: Comment creation timestamp\n    - `digg_count`: Number of likes on the comment\n    - `comment_type`: Comment type\n    - `comment_author`: Comment author information\n      - `uid`: User ID\n      - `nick_name`: User nickname\n      - `cover`: User avatar information\n        - `url_list`: List of avatar URLs\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/analytics/fetch_comment_keywords\",\n  \"params\": {\n    \"item_id\": \"7502551047378832671\"\n  },\n  \"data\": {\n    \"item_id\": \"7502551047378832671\",\n    \"key_words\": [\n      {\n        \"key_word\": \"tik tok\",\n        \"comments\": [\n          {\n            \"cid\": \"7502621950457463574\",\n            \"comment_author\": {\n              \"nick_name\": \"ollie_russell05\",\n              \"uid\": \"7332627012203414560\"\n            },\n            \"create_date\": 1746840350,\n            \"digg_count\": 17,\n            \"text\": \"Imagine been tik tok and only getting 700 likes 🥀🙏😭\"\n          }\n        ]\n      },\n      {\n        \"key_word\": \"go viral\",\n        \"comments\": [\n          {\n            \"cid\": \"7502743477604680465\",\n            \"comment_author\": {\n              \"nick_name\": \"★ 🇦🇫\",\n              \"uid\": \"7274239704915149829\"\n            },\n            \"create_date\": 1746868614,\n            \"digg_count\": 13,\n            \"text\": \"I want to go viral\"\n          }\n        ]\n      }\n    ]\n  }\n}\n```","operationId":"fetch_comment_keywords_api_v1_tiktok_analytics_fetch_comment_keywords_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7502551047378832671"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/analytics/fetch_creator_info_and_milestones":{"get":{"tags":["TikTok-Analytics-API"],"summary":"获取创作者信息和里程碑数据/Get creator info and milestones","description":"# [中文]\n### 用途:\n- 获取TikTok创作者账号的基本信息和关键统计数据\n- 查看创作者账号的成长历程和达成的重要里程碑\n- 分析创作者账号发展轨迹，了解粉丝增长和内容影响力变化\n\n### 参数:\n- user_id: 创作者用户ID，必填参数，可从用户主页URL或TikTok后台获取\n\n### 返回内容说明:\n- `user_id`: 请求的创作者ID\n- `creator_info`: The creator's basic information\n  - `nickname`: 创作者昵称\n  - `sec_user_id`: 安全用户ID\n  - `unique_id`: 唯一用户名\n  - `avatar_url`: 头像URL\n  - `follower_count`: 粉丝数量\n  - `like_count`: 获赞总数\n- `milestones`: 创作者账号里程碑列表，每个里程碑包含:\n  - `milestone`: 里程碑类型ID\n  - `milestone_title`: 里程碑标题（如\"达到100万粉丝\"）\n  - `milestone_year`: 里程碑达成年份\n  - `milestone_month_day`: 里程碑达成月日\n  - `creator_summary`: 里程碑相关描述\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/analytics/fetch_creator_info_and_milestones\",\n  \"params\": {\n    \"user_id\": \"107955\"\n  },\n  \"data\": {\n    \"user_id\": \"107955\",\n    \"creator_info\": {\n      \"avatar_url\": \"https://p19-pu-sign-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:720:720.webp\",\n      \"follower_count\": 89812099,\n      \"like_count\": 382411162,\n      \"nickname\": \"TikTok\",\n      \"sec_user_id\": \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\",\n      \"unique_id\": \"tiktok\"\n    },\n    \"milestones\": [\n      {\n        \"milestone\": 6,\n        \"milestone_month_day\": \"10/4\",\n        \"milestone_title\": \"Reached 1 million followers\",\n        \"milestone_year\": \"2015\"\n      },\n      {\n        \"milestone\": 1,\n        \"milestone_month_day\": \"2/27\",\n        \"milestone_title\": \"Started posting on TikTok\",\n        \"milestone_year\": \"2015\"\n      }\n    ]\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Retrieve basic information and key metrics for TikTok creator accounts\n- View creator growth journey and important achieved milestones\n- Analyze creator account development trajectory, understand follower growth and content influence changes\n\n### Parameters:\n- user_id: Creator user ID, required parameter, can be obtained from user profile URL or TikTok backend\n\n### Return Description:\n- `user_id`: The requested creator ID\n- `creator_info`: The creator's basic information\n  - `nickname`: Creator's display name\n  - `sec_user_id`: Security user ID\n  - `unique_id`: Unique username\n  - `avatar_url`: Profile picture URL\n  - `follower_count`: Number of followers\n  - `like_count`: Total number of likes received\n- `milestones`: List of creator account milestones, each milestone includes:\n  - `milestone`: Milestone type ID\n  - `milestone_title`: Milestone title (e.g., \"Reached 1 million followers\")\n  - `milestone_year`: Year when the milestone was achieved\n  - `milestone_month_day`: Month and day when the milestone was achieved\n  - `creator_summary`: Milestone-related description\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/analytics/fetch_creator_info_and_milestones\",\n  \"params\": {\n    \"user_id\": \"107955\"\n  },\n  \"data\": {\n    \"user_id\": \"107955\",\n    \"creator_info\": {\n      \"avatar_url\": \"https://p19-pu-sign-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ba67b11de451691939223e9d978e613a~tplv-tiktokx-cropcenter:720:720.webp\",\n      \"follower_count\": 89812099,\n      \"like_count\": 382411162,\n      \"nickname\": \"TikTok\",\n      \"sec_user_id\": \"MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM\",\n      \"unique_id\": \"tiktok\"\n    },\n    \"milestones\": [\n      {\n        \"milestone\": 6,\n        \"milestone_month_day\": \"10/4\",\n        \"milestone_title\": \"Reached 1 million followers\",\n        \"milestone_year\": \"2015\"\n      },\n      {\n        \"milestone\": 1,\n        \"milestone_month_day\": \"2/27\",\n        \"milestone_title\": \"Started posting on TikTok\",\n        \"milestone_year\": \"2015\"\n      }\n    ]\n  }\n}\n```","operationId":"fetch_creator_info_and_milestones_api_v1_tiktok_analytics_fetch_creator_info_and_milestones_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"User Id"},"description":"用户id/User id","example":"107955"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_ads_detail":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取单个广告详情/Get single ad detail","description":"# [中文]\n### 用途:\n- 获取TikTok单个广告的详细信息，包括广告素材、创作者信息、互动数据等\n- 分析广告的表现指标，如观看量、点赞数、评论数等核心数据\n- 帮助广告主和营销人员深入了解特定广告的效果和用户反馈\n\n### 参数:\n- ads_id: 广告ID，必填参数，可从广告列表或TikTok Ads Creative Center获取\n\n### 返回内容说明:\n- `ad_title`: 广告标题\n- `brand_name`: 品牌名称\n- `comment`: 评论数\n- `cost`: 花费等级(1-5)\n- `country_code`: 投放国家代码列表\n- `ctr`: 点击率（百分比）\n- `favorite`: 是否收藏\n- `has_summary`: 是否有摘要\n- `highlight_text`: 高亮文本\n- `id`: 广告ID\n- `industry_key`: 行业标签\n- `is_search`: 是否搜索结果\n- `keyword_list`: 关键词列表\n- `landing_page`: 落地页URL\n- `like`: 点赞数\n- `objective_key`: 广告目标键\n- `objectives`: 广告目标列表\n  - `label`: 目标标签\n  - `value`: 目标值\n- `pattern_label`: 模式标签列表\n- `share`: 分享数\n- `source`: 来源\n- `source_key`: 来源键值\n- `tag`: 标签\n- `video_info`: 视频信息\n  - `vid`: 视频ID\n  - `duration`: 时长（秒）\n  - `cover`: 封面图URL\n  - `video_url`: 视频播放地址\n    - `720p`: 720p质量视频URL\n  - `width`: 视频宽度\n  - `height`: 视频高度\n- `voice_over`: 是否有配音\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_ads_detail\",\n  \"params\": {\n    \"ads_id\": \"7131673574381518849\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"ad_title\": \"BLACK FRIDAY SALE at 50% OFF + FREE SHIPPING\",\n      \"brand_name\": \"The Bamboo Breeze Shop\",\n      \"comment\": 232,\n      \"cost\": 2,\n      \"country_code\": [\"US\", \"CA\", \"PH\", \"SE\", \"FI\"],\n      \"ctr\": 0.14,\n      \"favorite\": false,\n      \"has_summary\": true,\n      \"highlight_text\": \"\",\n      \"id\": \"7131673574381518849\",\n      \"industry_key\": \"label_29100000000\",\n      \"is_search\": false,\n      \"keyword_list\": [\n        \"adjustable back posture corrector\",\n        \"poor posture\",\n        \"eliminate unnecessary back pain\"\n      ],\n      \"landing_page\": \"https://thebamboobreezeshop.com/products/adjustable-back-shoulder-posture-corrector\",\n      \"like\": 61242,\n      \"objective_key\": \"campaign_objective_conversion\",\n      \"objectives\": [\n        {\n          \"label\": \"campaign_objective_conversion\",\n          \"value\": 3\n        },\n        {\n          \"label\": \"campaign_objective_product_sales\",\n          \"value\": 15\n        }\n      ],\n      \"pattern_label\": [],\n      \"share\": 6486,\n      \"source\": \"TikTok Ads Manager\",\n      \"source_key\": 1,\n      \"tag\": 3,\n      \"video_info\": {\n        \"vid\": \"v12025gd0000cuavia7og65o5g7ucnb0\",\n        \"duration\": 17,\n        \"cover\": \"https://p16-sign-va.tiktokcdn.com/xxx\",\n        \"video_url\": {\n          \"720p\": \"https://v16m-default.tiktokcdn.com/xxx\"\n        },\n        \"width\": 576,\n        \"height\": 1024\n      },\n      \"voice_over\": true\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Retrieve detailed information about a single TikTok ad, including creative content, creator info, and engagement data\n- Analyze ad performance metrics such as views, likes, comments, and other core statistics\n- Help advertisers and marketers gain deep insights into specific ad effectiveness and user feedback\n\n### Parameters:\n- ads_id: Ad ID, required parameter, can be obtained from ad lists or TikTok Ads Creative Center\n\n### Return Description:\n- `ad_title`: Ad title\n- `brand_name`: Brand name\n- `comment`: Comment count\n- `cost`: Cost level (1-5)\n- `country_code`: List of target country codes\n- `ctr`: Click-through rate (percentage)\n- `favorite`: Whether favorited\n- `has_summary`: Whether has summary\n- `highlight_text`: Highlight text\n- `id`: Ad ID\n- `industry_key`: Industry label\n- `is_search`: Whether from search results\n- `keyword_list`: List of keywords\n- `landing_page`: Landing page URL\n- `like`: Like count\n- `objective_key`: Ad objective key\n- `objectives`: List of ad objectives\n  - `label`: Objective label\n  - `value`: Objective value\n- `pattern_label`: List of pattern labels\n- `share`: Share count\n- `source`: Source\n- `source_key`: Source key value\n- `tag`: Tag\n- `video_info`: Video information\n  - `vid`: Video ID\n  - `duration`: Duration (seconds)\n  - `cover`: Cover image URL\n  - `video_url`: Video playback URLs\n    - `720p`: 720p quality video URL\n  - `width`: Video width\n  - `height`: Video height\n- `voice_over`: Whether has voice over\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_ads_detail\",\n  \"params\": {\n    \"ads_id\": \"7131673574381518849\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"ad_title\": \"BLACK FRIDAY SALE at 50% OFF + FREE SHIPPING\",\n      \"brand_name\": \"The Bamboo Breeze Shop\",\n      \"comment\": 232,\n      \"cost\": 2,\n      \"country_code\": [\"US\", \"CA\", \"PH\", \"SE\", \"FI\"],\n      \"ctr\": 0.14,\n      \"favorite\": false,\n      \"has_summary\": true,\n      \"highlight_text\": \"\",\n      \"id\": \"7131673574381518849\",\n      \"industry_key\": \"label_29100000000\",\n      \"is_search\": false,\n      \"keyword_list\": [\n        \"adjustable back posture corrector\",\n        \"poor posture\",\n        \"eliminate unnecessary back pain\"\n      ],\n      \"landing_page\": \"https://thebamboobreezeshop.com/products/adjustable-back-shoulder-posture-corrector\",\n      \"like\": 61242,\n      \"objective_key\": \"campaign_objective_conversion\",\n      \"objectives\": [\n        {\n          \"label\": \"campaign_objective_conversion\",\n          \"value\": 3\n        },\n        {\n          \"label\": \"campaign_objective_product_sales\",\n          \"value\": 15\n        }\n      ],\n      \"pattern_label\": [],\n      \"share\": 6486,\n      \"source\": \"TikTok Ads Manager\",\n      \"source_key\": 1,\n      \"tag\": 3,\n      \"video_info\": {\n        \"vid\": \"v12025gd0000cuavia7og65o5g7ucnb0\",\n        \"duration\": 17,\n        \"cover\": \"https://p16-sign-va.tiktokcdn.com/xxx\",\n        \"video_url\": {\n          \"720p\": \"https://v16m-default.tiktokcdn.com/xxx\"\n        },\n        \"width\": 576,\n        \"height\": 1024\n      },\n      \"voice_over\": true\n    }\n  }\n}\n```","operationId":"get_ads_detail_api_v1_tiktok_ads_get_ads_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ads_id","in":"query","required":true,"schema":{"type":"string","description":"广告ID/Ad ID","title":"Ads Id"},"description":"广告ID/Ad ID","example":"7131673574381518849"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/search_ads":{"get":{"tags":["TikTok-Ads-API"],"summary":"搜索广告/Search ads","description":"# [中文]\n### 用途:\n- 搜索TikTok广告创意库中的广告，支持多维度筛选和排序\n- 发现特定行业、关键词或目标相关的高效广告案例\n- 为广告策划和创意制作提供参考和灵感\n\n### 参数:\n- keyword: 搜索关键词，可选参数，留空返回所有广告\n- objective: 广告目标，1=全部\n- like: 点赞数筛选，1=全部\n- period: 时间范围（天），如7、30、120、180天\n- industry: 行业ID列表，多个ID用逗号分隔。完整行业ID列表见: https://github.com/TikHub/TikTok-Ads-Industry-Code\n- page: 页码，默认1\n- limit: 每页数量，默认20，最大50\n- order_by: 排序方式，\"for_you\"=为你推荐，\"likes\"=按点赞数排序\n- country_code: 国家代码，如US、UK、JP等\n- ad_format: 广告格式，1=视频广告\n- ad_language: 广告语言代码，如en、zh等\n\n### 常用行业ID示例:\n- 游戏: 27000000000\n- 电子商务: 19000000000\n- 金融服务: 30000000000\n- 教育: 10000000000\n- 美妆个护: 22000000000\n- 食品饮料: 16000000000\n\n### 返回内容说明:\n- `materials`: 广告素材列表\n  - `id`: 广告素材ID\n  - `aweme_id`: 广告视频ID\n  - `desc`: 广告描述\n  - `create_time`: 创建时间\n  - `video_info`: 视频信息\n    - `cover`: 封面图URL\n    - `duration`: 时长（秒）\n  - `statistics`: 统计数据\n    - `digg_count`: 点赞数\n    - `comment_count`: 评论数\n    - `share_count`: 分享数\n  - `ads_info`: 广告信息\n    - `advertiser_name`: 广告主名称\n    - `landing_page`: 落地页URL\n- `pagination`: 分页信息\n  - `page`: 当前页\n  - `limit`: 每页数量\n  - `total`: 总数量\n  - `has_more`: 是否有更多\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/search_ads\",\n  \"params\": {\n    \"keyword\": \"cat toy\",\n    \"period\": 180,\n    \"industry\": \"27000000000\",\n    \"page\": 1,\n    \"limit\": 20\n  },\n  \"data\": {\n    \"materials\": [\n      {\n        \"id\": \"7213258221116751874\",\n        \"aweme_id\": \"7213258221116751874\",\n        \"desc\": \"Best interactive cat toys! Keep your cats entertained 🐱\",\n        \"create_time\": 1680234567,\n        \"video_info\": {\n          \"cover\": \"https://p16-ad-sg.tiktokcdn.com/img/xxx.jpeg\",\n          \"duration\": 15\n        },\n        \"statistics\": {\n          \"digg_count\": 128456,\n          \"comment_count\": 3421,\n          \"share_count\": 892\n        },\n        \"ads_info\": {\n          \"advertiser_name\": \"PetToys Inc.\",\n          \"landing_page\": \"https://example.com/cat-toys\"\n        }\n      }\n    ],\n    \"pagination\": {\n      \"page\": 1,\n      \"limit\": 20,\n      \"total\": 1523,\n      \"has_more\": true\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Search ads in TikTok's Creative Center with multi-dimensional filtering and sorting\n- Discover effective ad cases related to specific industries, keywords, or objectives\n- Provide reference and inspiration for ad planning and creative production\n\n### Parameters:\n- keyword: Search keyword, optional, returns all ads if empty\n- objective: Ad objective, 1=All\n- like: Like count filter, 1=All\n- period: Time period in days, e.g., 7, 30, 120, 180 days\n- industry: Industry ID list, multiple IDs separated by commas. Full industry ID list: https://github.com/TikHub/TikTok-Ads-Industry-Code\n- page: Page number, default 1\n- limit: Items per page, default 20, max 50\n- order_by: Sort method, \"for_you\"=Recommended, \"likes\"=Sort by likes\n- country_code: Country code, e.g., US, UK, JP\n- ad_format: Ad format, 1=Video ads\n- ad_language: Ad language code, e.g., en, zh\n\n### Common Industry ID Examples:\n- Games: 27000000000\n- E-commerce: 19000000000\n- Financial Services: 30000000000\n- Education: 10000000000\n- Beauty & Personal Care: 22000000000\n- Food & Beverage: 16000000000\n\n### Return Description:\n- `materials`: List of ad materials\n  - `id`: Ad material ID\n  - `aweme_id`: Ad video ID\n  - `desc`: Ad description\n  - `create_time`: Creation time\n  - `video_info`: Video information\n    - `cover`: Cover image URL\n    - `duration`: Duration in seconds\n  - `statistics`: Statistics\n    - `digg_count`: Number of likes\n    - `comment_count`: Number of comments\n    - `share_count`: Number of shares\n  - `ads_info`: Ad information\n    - `advertiser_name`: Advertiser name\n    - `landing_page`: Landing page URL\n- `pagination`: Pagination info\n  - `page`: Current page\n  - `limit`: Items per page\n  - `total`: Total count\n  - `has_more`: Whether there are more items\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/search_ads\",\n  \"params\": {\n    \"keyword\": \"cat toy\",\n    \"period\": 180,\n    \"industry\": \"27000000000\",\n    \"page\": 1,\n    \"limit\": 20\n  },\n  \"data\": {\n    \"materials\": [\n      {\n        \"id\": \"7213258221116751874\",\n        \"aweme_id\": \"7213258221116751874\",\n        \"desc\": \"Best interactive cat toys! Keep your cats entertained 🐱\",\n        \"create_time\": 1680234567,\n        \"video_info\": {\n          \"cover\": \"https://p16-ad-sg.tiktokcdn.com/img/xxx.jpeg\",\n          \"duration\": 15\n        },\n        \"statistics\": {\n          \"digg_count\": 128456,\n          \"comment_count\": 3421,\n          \"share_count\": 892\n        },\n        \"ads_info\": {\n          \"advertiser_name\": \"PetToys Inc.\",\n          \"landing_page\": \"https://example.com/cat-toys\"\n        }\n      }\n    ],\n    \"pagination\": {\n      \"page\": 1,\n      \"limit\": 20,\n      \"total\": 1523,\n      \"has_more\": true\n    }\n  }\n}\n```","operationId":"search_ads_api_v1_tiktok_ads_search_ads_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"objective","in":"query","required":false,"schema":{"type":"integer","description":"广告目标类型/Ad objective (1:流量 2:应用安装 3:转化 4:视频浏览 5:触达 6:潜在客户 7:产品销售)","default":1,"title":"Objective"},"description":"广告目标类型/Ad objective (1:流量 2:应用安装 3:转化 4:视频浏览 5:触达 6:潜在客户 7:产品销售)"},{"name":"like","in":"query","required":false,"schema":{"type":"integer","description":"表现排名/Performance rank (1:前1-20% 2:前21-40% 3:前41-60% 4:前61-80%)","default":1,"title":"Like"},"description":"表现排名/Performance rank (1:前1-20% 2:前21-40% 3:前41-60% 4:前61-80%)"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间段/Time period (days)","default":180,"title":"Period"},"description":"时间段/Time period (days)"},{"name":"industry","in":"query","required":false,"schema":{"type":"string","description":"行业ID/Industry ID","title":"Industry"},"description":"行业ID/Industry ID"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort by (for_you, likes)","default":"for_you","title":"Order By"},"description":"排序方式/Sort by (for_you, likes)"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"},{"name":"ad_format","in":"query","required":false,"schema":{"type":"integer","description":"广告格式/Ad format (1:视频)","default":1,"title":"Ad Format"},"description":"广告格式/Ad format (1:视频)"},{"name":"ad_language","in":"query","required":false,"schema":{"type":"string","description":"广告语言/Ad language","default":"en","title":"Ad Language"},"description":"广告语言/Ad language"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索ID（可选）/Search ID (optional)","title":"Search Id"},"description":"搜索ID（可选）/Search ID (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_keyword_insights":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取关键词洞察数据/Get keyword insights data","description":"# [中文]\n### 用途:\n- 获取TikTok广告关键词洞察数据，了解热门关键词的表现指标\n- 分析不同关键词的点击率、发布量、增长趋势等核心数据\n- 帮助广告主优化关键词策略，提升广告投放效果\n\n### 参数:\n- page: 页码，默认1\n- limit: 每页数量，默认20\n- period: 时间范围（天），如7、30、120天\n- country_code: 国家代码，如US、UK、JP等\n- order_by: 排序字段，可选：post（发布量）、ctr（点击率）、click_rate（点击率）、trend（趋势）\n- order_type: 排序方式，desc（降序）或asc（升序）\n- industry: 行业ID，多个用逗号分隔\n- objective: 广告目标\n- keyword_type: 关键词类型\n\n### 返回内容说明:\n- `keyword_list`: 关键词列表\n  - `comment`: 评论数\n  - `cost`: 花费金额\n  - `cpa`: 每次转化成本\n  - `ctr`: 点击率（百分比）\n  - `cvr`: 转化率（百分比）\n  - `impression`: 展示量\n  - `keyword`: 关键词文本\n  - `like`: 点赞数\n  - `play_six_rate`: 6秒播放率（百分比）\n  - `post`: 发布量\n  - `post_change`: 发布量变化率（百分比）\n  - `share`: 分享数\n  - `video_list`: 视频ID列表\n- `pagination`: 分页信息\n  - `page`: 当前页\n  - `size`: 每页数量\n  - `total`: 总数量\n  - `has_more`: 是否有更多\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_keyword_insights\",\n  \"params\": {\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"period\": \"7\",\n    \"country_code\": \"US\",\n    \"order_by\": \"post\",\n    \"order_type\": \"desc\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"keyword_list\": [\n        {\n          \"comment\": 4785,\n          \"cost\": 756000,\n          \"cpa\": 20.2,\n          \"ctr\": 0.53,\n          \"cvr\": 9.75,\n          \"impression\": 164000000,\n          \"keyword\": \"summer\",\n          \"like\": 475734,\n          \"play_six_rate\": 6.43,\n          \"post\": 14200,\n          \"post_change\": 111.21,\n          \"share\": 5754,\n          \"video_list\": [\n            \"7504060523021896977\",\n            \"7512164952346529031\",\n            \"7511370341621435679\",\n            \"7511483560939785514\",\n            \"7506971390613015854\"\n          ]\n        },\n        {\n          \"comment\": 2151,\n          \"cost\": 264000,\n          \"cpa\": 17.8,\n          \"ctr\": 1.38,\n          \"cvr\": 6.15,\n          \"impression\": 38100000,\n          \"keyword\": \"free shipping\",\n          \"like\": 84131,\n          \"play_six_rate\": 8.64,\n          \"post\": 7810,\n          \"post_change\": 91.91,\n          \"share\": 3707,\n          \"video_list\": [\n            \"7471433861654727943\",\n            \"7515178617568070930\",\n            \"7502578466194312456\",\n            \"7513186274711244054\",\n            \"7514776490123201810\"\n          ]\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 484,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get TikTok ad keyword insights data to understand performance metrics of popular keywords\n- Analyze CTR, post volume, growth trends and other core data for different keywords\n- Help advertisers optimize keyword strategies and improve ad delivery effectiveness\n\n### Parameters:\n- page: Page number, default 1\n- limit: Items per page, default 20\n- period: Time period in days, e.g., 7, 30, 120 days\n- country_code: Country code, e.g., US, UK, JP\n- order_by: Sort field, options: post (post volume), ctr (click-through rate), click_rate, trend\n- order_type: Sort order, desc (descending) or asc (ascending)\n- industry: Industry IDs, multiple separated by commas\n- objective: Ad objectives\n- keyword_type: Keyword type\n\n### Return Description:\n- `keyword_list`: List of keywords\n  - `comment`: Comment count\n  - `cost`: Cost amount\n  - `cpa`: Cost per acquisition\n  - `ctr`: Click-through rate (percentage)\n  - `cvr`: Conversion rate (percentage)\n  - `impression`: Impression count\n  - `keyword`: Keyword text\n  - `like`: Like count\n  - `play_six_rate`: 6-second play rate (percentage)\n  - `post`: Post volume\n  - `post_change`: Post volume change rate (percentage)\n  - `share`: Share count\n  - `video_list`: List of video IDs\n- `pagination`: Pagination info\n  - `page`: Current page\n  - `size`: Items per page\n  - `total`: Total count\n  - `has_more`: Whether there are more items\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_keyword_insights\",\n  \"params\": {\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"period\": \"7\",\n    \"country_code\": \"US\",\n    \"order_by\": \"post\",\n    \"order_type\": \"desc\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"keyword_list\": [\n        {\n          \"comment\": 4785,\n          \"cost\": 756000,\n          \"cpa\": 20.2,\n          \"ctr\": 0.53,\n          \"cvr\": 9.75,\n          \"impression\": 164000000,\n          \"keyword\": \"summer\",\n          \"like\": 475734,\n          \"play_six_rate\": 6.43,\n          \"post\": 14200,\n          \"post_change\": 111.21,\n          \"share\": 5754,\n          \"video_list\": [\n            \"7504060523021896977\",\n            \"7512164952346529031\",\n            \"7511370341621435679\",\n            \"7511483560939785514\",\n            \"7506971390613015854\"\n          ]\n        },\n        {\n          \"comment\": 2151,\n          \"cost\": 264000,\n          \"cpa\": 17.8,\n          \"ctr\": 1.38,\n          \"cvr\": 6.15,\n          \"impression\": 38100000,\n          \"keyword\": \"free shipping\",\n          \"like\": 84131,\n          \"play_six_rate\": 8.64,\n          \"post\": 7810,\n          \"post_change\": 91.91,\n          \"share\": 3707,\n          \"video_list\": [\n            \"7471433861654727943\",\n            \"7515178617568070930\",\n            \"7502578466194312456\",\n            \"7513186274711244054\",\n            \"7514776490123201810\"\n          ]\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 484,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```","operationId":"get_keyword_insights_api_v1_tiktok_ads_get_keyword_insights_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间段（天）/Time period (days, 7/30/120/180)","default":7,"title":"Period"},"description":"时间段（天）/Time period (days, 7/30/120/180)"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"排序字段/Sort field (post, ctr, click_rate, etc.)","default":"post","title":"Order By"},"description":"排序字段/Sort field (post, ctr, click_rate, etc.)"},{"name":"order_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort order (desc, asc)","default":"desc","title":"Order Type"},"description":"排序方式/Sort order (desc, asc)"},{"name":"industry","in":"query","required":false,"schema":{"type":"string","description":"行业ID/Industry ID","title":"Industry"},"description":"行业ID/Industry ID"},{"name":"objective","in":"query","required":false,"schema":{"type":"string","description":"广告目标/Ad objective","title":"Objective"},"description":"广告目标/Ad objective"},{"name":"keyword_type","in":"query","required":false,"schema":{"type":"string","description":"关键词类型/Keyword type","title":"Keyword Type"},"description":"关键词类型/Keyword type"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_top_products":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取热门产品列表/Get top products list","description":"# [中文]\n### 用途:\n- 获取TikTok广告中的热门产品排行榜，了解各类目下的爆款产品\n- 分析产品的广告投放量、点击率、转化率等核心指标\n- 帮助电商卖家发现潜力产品，优化选品和营销策略\n\n### 参数:\n- last: 最近天数，如7、30天\n- page: 页码，默认1\n- limit: 每页数量，默认20\n- country_code: 国家代码，如US、UK、JP等\n- first_ecom_category_id: 电商类目ID，多个用逗号分隔\n- ecom_type: 电商类型，默认\"l3\"\n- period_type: 时间类型，默认\"last\"\n- order_by: 排序字段，可选：post（发布量）、ctr（点击率）、cvr（转化率）\n- order_type: 排序方式，desc（降序）或asc（升序）\n\n### 常用电商类目ID:\n- 美妆个护: 605196\n- 女装女内衣: 602284\n- 时尚配饰: 601450\n- 手机电子: 801928\n- 健康产品: 951432\n- 家居用品: 601755\n- 男装男内衣: 605248\n- 香水: 601583\n\n### 返回内容说明:\n- `list`: 产品列表\n  - `comment`: 评论数\n  - `cost`: 花费金额\n  - `cover_url`: 封面图URL（可能为null）\n  - `cpa`: 每次转化成本\n  - `ctr`: 点击率（百分比）\n  - `cvr`: 转化率（百分比）\n  - `ecom_type`: 电商类型\n  - `first_ecom_category`: 一级电商类目\n    - `id`: 类目ID\n    - `label`: 类目标签\n    - `value`: 类目名称\n  - `impression`: 展示量\n  - `like`: 点赞数\n  - `play_six_rate`: 6秒播放率（百分比）\n  - `post`: 发布量\n  - `post_change`: 发布量变化率（百分比）\n  - `second_ecom_category`: 二级电商类目\n    - `id`: 类目ID\n    - `label`: 类目标签\n    - `parent_id`: 父类目ID\n    - `value`: 类目名称\n  - `share`: 分享数\n  - `third_ecom_category`: 三级电商类目\n    - `id`: 类目ID\n    - `label`: 类目标签\n    - `parent_id`: 父类目ID\n    - `value`: 类目名称\n  - `url_title`: URL标题\n- `pagination`: 分页信息\n  - `page`: 当前页\n  - `size`: 每页数量\n  - `total`: 总数量\n  - `has_more`: 是否有更多\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_top_products\",\n  \"params\": {\n    \"last\": \"7\",\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"country_code\": \"US\",\n    \"first_ecom_category_id\": \"\",\n    \"ecom_type\": \"l3\",\n    \"period_type\": \"last\",\n    \"order_by\": \"post\",\n    \"order_type\": \"desc\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"list\": [\n        {\n          \"comment\": 3449,\n          \"cost\": 477000,\n          \"cover_url\": null,\n          \"cpa\": 9.21,\n          \"ctr\": 1.29,\n          \"cvr\": 12.94,\n          \"ecom_type\": \"l3\",\n          \"first_ecom_category\": {\n            \"id\": \"601450\",\n            \"label\": \"category_601450\",\n            \"value\": \"Beauty & Personal Care\"\n          },\n          \"impression\": 65000000,\n          \"like\": 166618,\n          \"play_six_rate\": 7.62,\n          \"post\": 10600,\n          \"post_change\": -10.16,\n          \"second_ecom_category\": {\n            \"id\": \"848648\",\n            \"label\": \"category_848648\",\n            \"parent_id\": \"601450\",\n            \"value\": \"Makeup & Perfume\"\n          },\n          \"share\": 2359,\n          \"third_ecom_category\": {\n            \"id\": \"601583\",\n            \"label\": \"category_601583\",\n            \"parent_id\": \"848648\",\n            \"value\": \"Perfume\"\n          },\n          \"url_title\": \"Perfume\"\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 156,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get top product rankings in TikTok ads to understand popular products in various categories\n- Analyze core metrics like ad post volume, CTR, and conversion rate for products\n- Help e-commerce sellers discover potential products and optimize product selection and marketing strategies\n\n### Parameters:\n- last: Number of recent days, e.g., 7, 30 days\n- page: Page number, default 1\n- limit: Items per page, default 20\n- country_code: Country code, e.g., US, UK, JP\n- first_ecom_category_id: E-commerce category IDs, multiple separated by commas\n- ecom_type: E-commerce type, default \"l3\"\n- period_type: Period type, default \"last\"\n- order_by: Sort field, options: post (post volume), ctr (click-through rate), cvr (conversion rate)\n- order_type: Sort order, desc (descending) or asc (ascending)\n\n### Common E-commerce Category IDs:\n- Beauty & Personal Care: 605196\n- Women's Clothing & Underwear: 602284\n- Fashion Accessories: 601450\n- Mobile & Electronics: 801928\n- Health Products: 951432\n- Home & Living: 601755\n- Men's Clothing & Underwear: 605248\n- Perfume: 601583\n\n### Return Description:\n- `list`: Product list\n  - `comment`: Comment count\n  - `cost`: Cost amount\n  - `cover_url`: Cover image URL (may be null)\n  - `cpa`: Cost per acquisition\n  - `ctr`: Click-through rate (percentage)\n  - `cvr`: Conversion rate (percentage)\n  - `ecom_type`: E-commerce type\n  - `first_ecom_category`: First-level e-commerce category\n    - `id`: Category ID\n    - `label`: Category label\n    - `value`: Category name\n  - `impression`: Impression count\n  - `like`: Like count\n  - `play_six_rate`: 6-second play rate (percentage)\n  - `post`: Post volume\n  - `post_change`: Post volume change rate (percentage)\n  - `second_ecom_category`: Second-level e-commerce category\n    - `id`: Category ID\n    - `label`: Category label\n    - `parent_id`: Parent category ID\n    - `value`: Category name\n  - `share`: Share count\n  - `third_ecom_category`: Third-level e-commerce category\n    - `id`: Category ID\n    - `label`: Category label\n    - `parent_id`: Parent category ID\n    - `value`: Category name\n  - `url_title`: URL title\n- `pagination`: Pagination info\n  - `page`: Current page\n  - `size`: Items per page\n  - `total`: Total count\n  - `has_more`: Whether there are more items\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_top_products\",\n  \"params\": {\n    \"last\": \"7\",\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"country_code\": \"US\",\n    \"first_ecom_category_id\": \"\",\n    \"ecom_type\": \"l3\",\n    \"period_type\": \"last\",\n    \"order_by\": \"post\",\n    \"order_type\": \"desc\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"list\": [\n        {\n          \"comment\": 3449,\n          \"cost\": 477000,\n          \"cover_url\": null,\n          \"cpa\": 9.21,\n          \"ctr\": 1.29,\n          \"cvr\": 12.94,\n          \"ecom_type\": \"l3\",\n          \"first_ecom_category\": {\n            \"id\": \"601450\",\n            \"label\": \"category_601450\",\n            \"value\": \"Beauty & Personal Care\"\n          },\n          \"impression\": 65000000,\n          \"like\": 166618,\n          \"play_six_rate\": 7.62,\n          \"post\": 10600,\n          \"post_change\": -10.16,\n          \"second_ecom_category\": {\n            \"id\": \"848648\",\n            \"label\": \"category_848648\",\n            \"parent_id\": \"601450\",\n            \"value\": \"Makeup & Perfume\"\n          },\n          \"share\": 2359,\n          \"third_ecom_category\": {\n            \"id\": \"601583\",\n            \"label\": \"category_601583\",\n            \"parent_id\": \"848648\",\n            \"value\": \"Perfume\"\n          },\n          \"url_title\": \"Perfume\"\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 156,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```","operationId":"get_top_products_api_v1_tiktok_ads_get_top_products_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"last","in":"query","required":false,"schema":{"type":"integer","description":"最近天数/Last days","default":7,"title":"Last"},"description":"最近天数/Last days"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"},{"name":"first_ecom_category_id","in":"query","required":false,"schema":{"type":"string","description":"电商类目ID，多个用逗号分隔/E-commerce category IDs, comma separated","default":"","title":"First Ecom Category Id"},"description":"电商类目ID，多个用逗号分隔/E-commerce category IDs, comma separated"},{"name":"ecom_type","in":"query","required":false,"schema":{"type":"string","description":"电商类型/E-commerce type (l3)","default":"l3","title":"Ecom Type"},"description":"电商类型/E-commerce type (l3)"},{"name":"period_type","in":"query","required":false,"schema":{"type":"string","description":"时间类型/Period type (last)","default":"last","title":"Period Type"},"description":"时间类型/Period type (last)"},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"排序字段/Sort field (post, ctr, cvr)","default":"post","title":"Order By"},"description":"排序字段/Sort field (post, ctr, cvr)"},{"name":"order_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort order (desc, asc)","default":"desc","title":"Order Type"},"description":"排序方式/Sort order (desc, asc)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_hashtag_list":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取热门标签列表/Get popular hashtags list","description":"# [中文]\n### 用途:\n- 获取TikTok广告中的热门标签排行榜，了解当前流行的话题标签\n- 分析标签的使用量、观看量等数据，发现潜力标签\n- 帮助广告主选择合适的标签，提升广告曝光和互动率\n\n### 参数:\n- page: 页码，默认1\n- limit: 每页数量，默认20\n- period: 时间范围（天），如7、30、120天\n- country_code: 国家代码，如US、UK、JP等\n- sort_by: 排序方式，\"popular\"=热门，\"new\"=最新\n- industry_id: 行业ID，留空返回所有行业\n- filter_by: 筛选条件，\"new_on_board\"=新上榜标签\n\n### 返回内容说明:\n- `list`: 标签列表\n  - `hashtag_id`: 标签ID\n  - `hashtag_name`: 标签名称\n  - `country_info`: 国家信息\n    - `id`: 国家ID\n    - `value`: 国家名称\n    - `label`: 国家标签\n  - `industry_info`: 行业信息\n    - `id`: 行业ID\n    - `value`: 行业名称\n    - `label`: 行业标签\n  - `is_promoted`: 是否推广\n  - `trend`: 趋势数据列表\n    - `time`: 时间戳\n    - `value`: 该时间点的值\n  - `creators`: 创作者列表\n    - `nick_name`: 昵称\n    - `avatar_url`: 头像URL\n  - `publish_cnt`: 发布数量\n  - `video_views`: 视频观看量\n  - `rank`: 排名\n  - `rank_diff`: 排名变化\n  - `rank_diff_type`: 排名变化类型\n- `pagination`: 分页信息\n  - `page`: 当前页\n  - `size`: 每页数量\n  - `total`: 总数量\n  - `has_more`: 是否有更多\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_hashtag_list\",\n  \"params\": {\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"period\": \"120\",\n    \"country_code\": \"US\",\n    \"sort_by\": \"popular\",\n    \"industry_id\": \"\",\n    \"filter_by\": \"\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"list\": [\n        {\n          \"hashtag_id\": \"4100\",\n          \"hashtag_name\": \"summer\",\n          \"country_info\": {\n            \"id\": \"US\",\n            \"value\": \"United States\",\n            \"label\": \"US\"\n          },\n          \"industry_info\": {\n            \"id\": 28000000000,\n            \"value\": \"Sports & Outdoor\",\n            \"label\": \"label_28000000000\"\n          },\n          \"is_promoted\": false,\n          \"trend\": [\n            {\n              \"time\": 1740787200,\n              \"value\": 0.38\n            },\n            {\n              \"time\": 1741392000,\n              \"value\": 0.37\n            },\n            {\n              \"time\": 1741996800,\n              \"value\": 0.43\n            },\n            {\n              \"time\": 1749254400,\n              \"value\": 1\n            }\n          ],\n          \"creators\": [\n            {\n              \"nick_name\": \"Mark Broze\",\n              \"avatar_url\": \"https://p16-sign-sg.tiktokcdn.com/tos-alisg-avt-0068/28bb3ad309c2165f9579a67515d17ca9~tplv-tiktokx-cropcenter:100:100.png\"\n            },\n            {\n              \"nick_name\": \"Liam 🤠\",\n              \"avatar_url\": \"https://p16-sign-sg.tiktokcdn.com/tos-alisg-avt-0068/a27b40671c78f8af17cdd2618ad8ba20~tplv-tiktokx-cropcenter:100:100.png\"\n            }\n          ],\n          \"publish_cnt\": 2886791,\n          \"video_views\": 19583705445,\n          \"rank\": 1,\n          \"rank_diff\": 1,\n          \"rank_diff_type\": 1\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 100,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get popular hashtag rankings in TikTok ads to understand current trending topics\n- Analyze usage and view data for hashtags to discover potential tags\n- Help advertisers choose appropriate hashtags to increase ad exposure and engagement\n\n### Parameters:\n- page: Page number, default 1\n- limit: Items per page, default 20\n- period: Time period in days, e.g., 7, 30, 120 days\n- country_code: Country code, e.g., US, UK, JP\n- sort_by: Sort method, \"popular\"=Popular, \"new\"=Latest\n- industry_id: Industry ID, empty returns all industries\n- filter_by: Filter condition, \"new_on_board\"=Newly trending hashtags\n\n### Return Description:\n- `list`: Hashtag list\n  - `hashtag_id`: Hashtag ID\n  - `hashtag_name`: Hashtag name\n  - `country_info`: Country information\n    - `id`: Country ID\n    - `value`: Country name\n    - `label`: Country label\n  - `industry_info`: Industry information\n    - `id`: Industry ID\n    - `value`: Industry name\n    - `label`: Industry label\n  - `is_promoted`: Whether promoted\n  - `trend`: Trend data list\n    - `time`: Timestamp\n    - `value`: Value at that time point\n  - `creators`: Creator list\n    - `nick_name`: Nickname\n    - `avatar_url`: Avatar URL\n  - `publish_cnt`: Publish count\n  - `video_views`: Video views\n  - `rank`: Ranking\n  - `rank_diff`: Rank difference\n  - `rank_diff_type`: Rank difference type\n- `pagination`: Pagination info\n  - `page`: Current page\n  - `size`: Items per page\n  - `total`: Total count\n  - `has_more`: Whether there are more items\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_hashtag_list\",\n  \"params\": {\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"period\": \"120\",\n    \"country_code\": \"US\",\n    \"sort_by\": \"popular\",\n    \"industry_id\": \"\",\n    \"filter_by\": \"\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"list\": [\n        {\n          \"hashtag_id\": \"4100\",\n          \"hashtag_name\": \"summer\",\n          \"country_info\": {\n            \"id\": \"US\",\n            \"value\": \"United States\",\n            \"label\": \"US\"\n          },\n          \"industry_info\": {\n            \"id\": 28000000000,\n            \"value\": \"Sports & Outdoor\",\n            \"label\": \"label_28000000000\"\n          },\n          \"is_promoted\": false,\n          \"trend\": [\n            {\n              \"time\": 1740787200,\n              \"value\": 0.38\n            },\n            {\n              \"time\": 1741392000,\n              \"value\": 0.37\n            }\n          ],\n          \"creators\": [\n            {\n              \"nick_name\": \"creator1\",\n              \"avatar_url\": \"https://example.com/avatar1.jpg\"\n            }\n          ],\n          \"publish_cnt\": 45678,\n          \"video_views\": 123456789,\n          \"rank\": 1,\n          \"rank_diff\": 2,\n          \"rank_diff_type\": 1\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 500,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```","operationId":"get_hashtag_list_api_v1_tiktok_ads_get_hashtag_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间范围（天）/Time period (days)","default":120,"title":"Period"},"description":"时间范围（天）/Time period (days)"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort by (popular, new)","default":"popular","title":"Sort By"},"description":"排序方式/Sort by (popular, new)"},{"name":"industry_id","in":"query","required":false,"schema":{"type":"string","description":"行业ID/Industry ID","default":"","title":"Industry Id"},"description":"行业ID/Industry ID"},{"name":"filter_by","in":"query","required":false,"schema":{"type":"string","description":"筛选条件/Filter (new_on_board)","default":"","title":"Filter By"},"description":"筛选条件/Filter (new_on_board)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_sound_rank_list":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取热门音乐排行榜/Get popular sound rankings","description":"# [中文]\n### 用途:\n- 获取TikTok广告中的热门音乐排行榜，了解当前流行的音乐素材\n- 分析音乐的使用量、增长趋势等数据，发现潜力音乐\n- 帮助广告主选择合适的背景音乐，提升广告吸引力和传播效果\n\n### 参数:\n- period: 时间范围（天），如7、30、120天\n- page: 页码，默认1\n- limit: 每页数量，默认20\n- rank_type: 排行类型，\"popular\"=热门，\"surging\"=上升最快\n- new_on_board: 是否只看新上榜音乐，默认False\n- commercial_music: 是否只看商业音乐，默认False\n- country_code: 国家代码，如US、UK、JP等\n\n### 返回内容说明:\n- `pagination`: 分页信息\n  - `page`: 当前页\n  - `size`: 每页数量\n  - `total`: 总数量\n  - `has_more`: 是否有更多\n- `sound_list`: 音乐列表\n  - `author`: 音乐作者\n  - `clip_id`: 片段ID\n  - `cml_mid`: 商业音乐ID\n  - `country_code`: 国家代码\n  - `cover`: 封面图URL\n  - `duration`: 时长（秒）\n  - `if_cml`: 是否商业音乐\n  - `is_search`: 是否搜索结果\n  - `link`: 音乐链接\n  - `music_url`: 音乐播放URL\n  - `on_list_times`: 上榜次数（可能为null）\n  - `promoted`: 是否推广\n  - `rank`: 排名\n  - `rank_diff`: 排名变化\n  - `rank_diff_type`: 排名变化类型\n  - `related_items`: 相关视频列表\n    - `item_id`: 视频ID\n    - `cover_uri`: 封面URI\n  - `song_id`: 歌曲ID\n  - `title`: 音乐标题\n  - `trend`: 趋势数据\n    - `time`: 时间戳\n    - `value`: 该时间点的值\n  - `url_title`: URL标题\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_sound_rank_list\",\n  \"params\": {\n    \"period\": \"30\",\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"rank_type\": \"popular\",\n    \"new_on_board\": \"false\",\n    \"commercial_music\": \"false\",\n    \"country_code\": \"US\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 99,\n        \"has_more\": true\n      },\n      \"sound_list\": [\n        {\n          \"author\": \"CYRIL & MOONLGHT & The La's\",\n          \"clip_id\": \"7424014547218565904\",\n          \"cml_mid\": \"7512350022513852432\",\n          \"country_code\": \"US\",\n          \"cover\": \"https://p16-sg.tiktokcdn.com/aweme/720x720/tos-alisg-v-2774/osxQt9H6AFAPAzveAQL4SQgGreoyVe6IDaCCXQ.jpeg\",\n          \"duration\": 22,\n          \"if_cml\": true,\n          \"is_search\": false,\n          \"link\": \"https://www.tiktok.com/music/x-7424014547218565904\",\n          \"music_url\": \"https://sf16-ies-music-sg.tiktokcdn.com/obj/tos-alisg-ve-2774/o0W7XTIwoABiiicgwksz8EfQKFBPAA1M4Oq0kj\",\n          \"on_list_times\": null,\n          \"promoted\": false,\n          \"rank\": 1,\n          \"rank_diff\": 0,\n          \"rank_diff_type\": 2,\n          \"related_items\": [\n            {\n              \"item_id\": 7512619474084711723,\n              \"cover_uri\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068c799-us/osLDIJAZvBbnB4E0gCiaBbHnigExB8CUIGvI4~tplv-noop.image\"\n            }\n          ],\n          \"song_id\": \"7503950818010335233\",\n          \"title\": \"There She Goes\",\n          \"trend\": [\n            {\n              \"time\": 1740787200,\n              \"value\": 0.15\n            }\n          ],\n          \"url_title\": \"There She Goes (CYRIL Remix)\"\n        }\n      ]\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get popular music rankings in TikTok ads to understand current trending audio materials\n- Analyze usage and growth trend data for music to discover potential sounds\n- Help advertisers choose appropriate background music to enhance ad appeal and virality\n\n### Parameters:\n- period: Time period in days, e.g., 7, 30, 120 days\n- page: Page number, default 1\n- limit: Items per page, default 20\n- rank_type: Ranking type, \"popular\"=Popular, \"surging\"=Fastest rising\n- new_on_board: Only show newly trending music, default False\n- commercial_music: Only show commercial music, default False\n- country_code: Country code, e.g., US, UK, JP\n\n### Return Description:\n- `pagination`: Pagination info\n  - `page`: Current page\n  - `size`: Items per page\n  - `total`: Total count\n  - `has_more`: Whether there are more items\n- `sound_list`: Music list\n  - `author`: Music author\n  - `clip_id`: Clip ID\n  - `cml_mid`: Commercial music ID\n  - `country_code`: Country code\n  - `cover`: Cover image URL\n  - `duration`: Duration in seconds\n  - `if_cml`: Whether commercial music\n  - `is_search`: Whether search result\n  - `link`: Music link\n  - `music_url`: Music playback URL\n  - `on_list_times`: Times on list (may be null)\n  - `promoted`: Whether promoted\n  - `rank`: Ranking\n  - `rank_diff`: Rank difference\n  - `rank_diff_type`: Rank difference type\n  - `related_items`: Related video list\n    - `item_id`: Video ID\n    - `cover_uri`: Cover URI\n  - `song_id`: Song ID\n  - `title`: Music title\n  - `trend`: Trend data\n    - `time`: Timestamp\n    - `value`: Value at that time point\n  - `url_title`: URL title\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_sound_rank_list\",\n  \"params\": {\n    \"period\": \"30\",\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"rank_type\": \"popular\",\n    \"new_on_board\": \"false\",\n    \"commercial_music\": \"false\",\n    \"country_code\": \"US\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 99,\n        \"has_more\": true\n      },\n      \"sound_list\": [\n        {\n          \"author\": \"CYRIL & MOONLGHT & The La's\",\n          \"clip_id\": \"7424014547218565904\",\n          \"cml_mid\": \"7512350022513852432\",\n          \"country_code\": \"US\",\n          \"cover\": \"https://p16-sg.tiktokcdn.com/aweme/720x720/tos-alisg-v-2774/osxQt9H6AFAPAzveAQL4SQgGreoyVe6IDaCCXQ.jpeg\",\n          \"duration\": 22,\n          \"if_cml\": true,\n          \"is_search\": false,\n          \"link\": \"https://www.tiktok.com/music/x-7424014547218565904\",\n          \"music_url\": \"https://sf16-ies-music-sg.tiktokcdn.com/obj/tos-alisg-ve-2774/o0W7XTIwoABiiicgwksz8EfQKFBPAA1M4Oq0kj\",\n          \"on_list_times\": null,\n          \"promoted\": false,\n          \"rank\": 1,\n          \"rank_diff\": 0,\n          \"rank_diff_type\": 2,\n          \"related_items\": [\n            {\n              \"item_id\": 7512619474084711723,\n              \"cover_uri\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068c799-us/osLDIJAZvBbnB4E0gCiaBbHnigExB8CUIGvI4~tplv-noop.image\"\n            }\n          ],\n          \"song_id\": \"7503950818010335233\",\n          \"title\": \"There She Goes\",\n          \"trend\": [\n            {\n              \"time\": 1740787200,\n              \"value\": 0.15\n            }\n          ],\n          \"url_title\": \"There She Goes (CYRIL Remix)\"\n        }\n      ]\n    }\n  }\n}\n```","operationId":"get_sound_rank_list_api_v1_tiktok_ads_get_sound_rank_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间范围（天）/Time period (days)","default":30,"title":"Period"},"description":"时间范围（天）/Time period (days)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"rank_type","in":"query","required":false,"schema":{"type":"string","description":"排行类型/Rank type (popular, surging)","default":"popular","title":"Rank Type"},"description":"排行类型/Rank type (popular, surging)"},{"name":"new_on_board","in":"query","required":false,"schema":{"type":"boolean","description":"是否只看新上榜/Only new on board","default":false,"title":"New On Board"},"description":"是否只看新上榜/Only new on board"},{"name":"commercial_music","in":"query","required":false,"schema":{"type":"boolean","description":"是否商业音乐/Commercial music only","default":false,"title":"Commercial Music"},"description":"是否商业音乐/Commercial music only"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_keyword_list":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取关键词列表/Get keyword list","description":"# [中文]\n### 用途:\n- 获取特定关键词的广告投放数据，了解关键词在TikTok广告中的使用情况\n- 分析关键词的发布量趋势、相关视频等信息\n- 帮助广告主发现有效的广告关键词\n\n### 参数:\n- keyword: 搜索关键词，必填参数\n- period: 时间范围（天），如7、30、120天\n- page: 页码，默认1\n- limit: 每页数量，默认6\n- country_code: 国家代码，如US、UK、JP等\n- industry: 行业ID列表，多个ID用逗号分隔\n\n### 返回内容说明:\n- `keyword_info_list`: 关键词信息列表\n  - `keyword`: 关键词文本\n  - `post`: 使用该关键词的广告发布数量\n  - `video_list`: 使用该关键词的示例视频ID列表\n- `pagination`: 分页信息\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_keyword_list\",\n  \"params\": {\n    \"keyword\": \"cat toy\",\n    \"period\": 120,\n    \"page\": 1,\n    \"limit\": 6\n  },\n  \"data\": {\n    \"keyword_info_list\": [\n      {\n        \"keyword\": \"cat toy\",\n        \"post\": 12345,\n        \"video_list\": [\"7213258221116751874\", \"7213258221116751875\"]\n      }\n    ],\n    \"pagination\": {\n      \"page\": 1,\n      \"limit\": 6,\n      \"total\": 50,\n      \"has_more\": true\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get ad placement data for specific keywords to understand keyword usage in TikTok ads\n- Analyze keyword post trends, related videos, and other information\n- Help advertisers discover effective ad keywords\n\n### Parameters:\n- keyword: Search keyword, required parameter\n- period: Time period in days, e.g., 7, 30, 120 days\n- page: Page number, default 1\n- limit: Items per page, default 6\n- country_code: Country code, e.g., US, UK, JP\n- industry: Industry ID list, multiple IDs separated by commas\n\n### Return Description:\n- `keyword_info_list`: Keyword information list\n  - `keyword`: Keyword text\n  - `post`: Number of ads using this keyword\n  - `video_list`: List of example video IDs using this keyword\n- `pagination`: Pagination info\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_keyword_list\",\n  \"params\": {\n    \"keyword\": \"cat toy\",\n    \"period\": 120,\n    \"page\": 1,\n    \"limit\": 6\n  },\n  \"data\": {\n    \"keyword_info_list\": [\n      {\n        \"keyword\": \"cat toy\",\n        \"post\": 12345,\n        \"video_list\": [\"7213258221116751874\", \"7213258221116751875\"]\n      }\n    ],\n    \"pagination\": {\n      \"page\": 1,\n      \"limit\": 6,\n      \"total\": 50,\n      \"has_more\": true\n    }\n  }\n}\n```","operationId":"get_keyword_list_api_v1_tiktok_ads_get_keyword_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"关键词/Keyword","default":"cat toy","title":"Keyword"},"description":"关键词/Keyword"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间范围（天）/Time period (days)","default":120,"title":"Period"},"description":"时间范围（天）/Time period (days)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":6,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"},{"name":"industry","in":"query","required":false,"schema":{"type":"string","description":"行业ID列表，逗号分隔/Industry IDs, comma separated","default":"","title":"Industry"},"description":"行业ID列表，逗号分隔/Industry IDs, comma separated"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_top_ads_spotlight":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取热门广告聚光灯/Get top ads spotlight","description":"# [中文]\n### 用途:\n- 获取特定行业的热门广告聚光灯，展示行业内最受关注的广告案例\n- 分析行业内的广告创意趋势和优秀案例\n- 为广告创意制作提供灵感和参考\n\n### 参数:\n- industry: 行业ID，必填参数，如教育行业：25000000000\n- page: 页码，默认1\n- limit: 每页数量，默认20\n\n### 返回内容说明:\n- `materials`: 广告素材列表\n  - `cost`: 花费等级\n  - `ctr`: 点击率\n  - `highlight`: 亮点描述\n  - `id`: 广告ID\n  - `like`: 点赞数\n  - `video_info`: 视频信息\n    - `vid`: 视频ID\n    - `duration`: 时长（秒）\n    - `cover`: 封面图片URL\n    - `video_url`: 多种画质的视频播放URL\n      - `360p`: 360p画质视频URL\n      - `480p`: 480p画质视频URL\n      - `540p`: 540p画质视频URL\n      - `720p`: 720p画质视频URL\n    - `width`: 视频宽度\n    - `height`: 视频高度\n- `pagination`: 分页信息\n  - `page`: 当前页\n  - `size`: 每页数量\n  - `total`: 总数量\n  - `has_more`: 是否有更多\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_top_ads_spotlight\",\n  \"params\": {\n    \"industry\": \"25000000000\",\n    \"page\": \"1\",\n    \"limit\": \"20\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"materials\": [\n        {\n          \"cost\": 2,\n          \"ctr\": 0.14,\n          \"highlight\": \"Through the lens of a real person talking his way through the game, the video appears credible with commentary that sounds trustworthy.\",\n          \"id\": \"7165768841499066370\",\n          \"like\": 377333,\n          \"video_info\": {\n            \"vid\": \"v0911dg40001cdo7ukjc77ua0r66rqqg\",\n            \"duration\": 19.156,\n            \"cover\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-v-2c3654-us/1c87385bed544878bb94b61816a653a1~tplv-noop.image\",\n            \"video_url\": {\n              \"360p\": \"https://v16m-default.tiktokcdn.com/9e086e91176219d756e9c875fb739dc4/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oIQcoRBNNpXbALnjIeLgbKfwWPDDDDIgQ9l6BF\",\n              \"480p\": \"https://v16m-default.tiktokcdn.com/2f304931bd351dad0e43e9771364bd78/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/o8lIsnPILWelBwDbDgDuwQj9UlNebAYdDUXBKS\",\n              \"540p\": \"https://v16m-default.tiktokcdn.com/351ae3acb3121d42db8a5091811b2340/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oQwpeXyWjDBg7KXcBDeDgPnDDbANoISoQIb9Ql\",\n              \"720p\": \"https://v16m-default.tiktokcdn.com/a04bacceb906e5336a68158479f5eac5/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oQQnWCmCDfpgIxegjrKAXZlbIPDNBDDbZQBHw9\"\n            },\n            \"width\": 720,\n            \"height\": 1280\n          }\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 100,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get top ads spotlight for specific industries, showcasing the most popular ad cases\n- Analyze creative trends and excellent cases within the industry\n- Provide inspiration and reference for ad creative production\n\n### Parameters:\n- industry: Industry ID, required parameter, e.g., Education: 25000000000\n- page: Page number, default 1\n- limit: Items per page, default 20\n\n### Return Description:\n- `materials`: Ad materials list\n  - `cost`: Cost level\n  - `ctr`: Click-through rate\n  - `highlight`: Highlight description\n  - `id`: Ad ID\n  - `like`: Like count\n  - `video_info`: Video information\n    - `vid`: Video ID\n    - `duration`: Duration in seconds\n    - `cover`: Cover image URL\n    - `video_url`: Video playback URLs in multiple qualities\n      - `360p`: 360p quality video URL\n      - `480p`: 480p quality video URL\n      - `540p`: 540p quality video URL\n      - `720p`: 720p quality video URL\n    - `width`: Video width\n    - `height`: Video height\n- `pagination`: Pagination info\n  - `page`: Current page\n  - `size`: Items per page\n  - `total`: Total count\n  - `has_more`: Whether there are more items\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_top_ads_spotlight\",\n  \"params\": {\n    \"industry\": \"25000000000\",\n    \"page\": \"1\",\n    \"limit\": \"20\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"materials\": [\n        {\n          \"cost\": 2,\n          \"ctr\": 0.14,\n          \"highlight\": \"Through the lens of a real person talking his way through the game, the video appears credible with commentary that sounds trustworthy.\",\n          \"id\": \"7165768841499066370\",\n          \"like\": 377333,\n          \"video_info\": {\n            \"vid\": \"v0911dg40001cdo7ukjc77ua0r66rqqg\",\n            \"duration\": 19.156,\n            \"cover\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-v-2c3654-us/1c87385bed544878bb94b61816a653a1~tplv-noop.image\",\n            \"video_url\": {\n              \"360p\": \"https://v16m-default.tiktokcdn.com/9e086e91176219d756e9c875fb739dc4/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oIQcoRBNNpXbALnjIeLgbKfwWPDDDDIgQ9l6BF\",\n              \"480p\": \"https://v16m-default.tiktokcdn.com/2f304931bd351dad0e43e9771364bd78/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/o8lIsnPILWelBwDbDgDuwQj9UlNebAYdDUXBKS\",\n              \"540p\": \"https://v16m-default.tiktokcdn.com/351ae3acb3121d42db8a5091811b2340/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oQwpeXyWjDBg7KXcBDeDgPnDDbANoISoQIb9Ql\",\n              \"720p\": \"https://v16m-default.tiktokcdn.com/a04bacceb906e5336a68158479f5eac5/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oQQnWCmCDfpgIxegjrKAXZlbIPDNBDDbZQBHw9\"\n            },\n            \"width\": 720,\n            \"height\": 1280\n          }\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 100,\n      \"has_more\": true\n    }\n  }\n}\n```","operationId":"get_top_ads_spotlight_api_v1_tiktok_ads_get_top_ads_spotlight_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"industry","in":"query","required":false,"schema":{"type":"string","description":"行业ID/Industry ID","default":"25000000000","title":"Industry"},"description":"行业ID/Industry ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_ad_keyframe_analysis":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取广告关键帧分析/Get ad keyframe analysis","description":"# [中文]\n### 用途:\n- 获取广告视频的关键帧分析，了解视频在不同时间点的观众留存情况\n- 分析哪些时间点最吸引观众，哪些时间点观众流失最多\n- 帮助优化广告视频结构，提高观看完成率\n\n### 参数:\n- material_id: 广告素材ID，必填参数\n- metric: 分析指标，可选值：\n  - retain_ctr: 留存点击率（默认）\n  - retain_cvr: 留存转化率\n  - click_cnt: 点击次数\n  - convert_cnt: 转化次数\n  - play_retain_cnt: 播放留存量\n\n### 返回内容说明:\n- `keyframe_data`: 关键帧数据\n  - `time_points`: 时间点列表（秒）\n  - `retention_rates`: 对应时间点的留存率（百分比）\n  - `drop_points`: 流失率较高的时间点\n  - `highlight_points`: 观众兴趣较高的时间点\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_ad_keyframe_analysis\",\n  \"params\": {\n    \"material_id\": \"7213258221116751874\"\n  },\n  \"data\": {\n    \"keyframe_data\": {\n      \"time_points\": [0, 1, 2, 3, 4, 5],\n      \"retention_rates\": [100, 95, 88, 82, 78, 75],\n      \"drop_points\": [2, 4],\n      \"highlight_points\": [1, 5]\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get keyframe analysis of ad videos to understand audience retention at different time points\n- Analyze which time points attract viewers most and where viewers drop off\n- Help optimize ad video structure to improve completion rates\n\n### Parameters:\n- material_id: Ad material ID, required parameter\n- metric: Analysis metric, options:\n  - retain_ctr: Retention CTR (default)\n  - retain_cvr: Retention CVR\n  - click_cnt: Click count\n  - convert_cnt: Conversion count\n  - play_retain_cnt: Play retention count\n\n### Return Description:\n- `keyframe_data`: Keyframe data\n  - `time_points`: List of time points (seconds)\n  - `retention_rates`: Retention rates at corresponding time points (percentage)\n  - `drop_points`: Time points with high drop-off rates\n  - `highlight_points`: Time points with high viewer interest\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_ad_keyframe_analysis\",\n  \"params\": {\n    \"material_id\": \"7213258221116751874\"\n  },\n  \"data\": {\n    \"keyframe_data\": {\n      \"time_points\": [0, 1, 2, 3, 4, 5],\n      \"retention_rates\": [100, 95, 88, 82, 78, 75],\n      \"drop_points\": [2, 4],\n      \"highlight_points\": [1, 5]\n    }\n  }\n}\n```","operationId":"get_ad_keyframe_analysis_api_v1_tiktok_ads_get_ad_keyframe_analysis_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"material_id","in":"query","required":true,"schema":{"type":"string","description":"广告素材ID/Ad material ID","title":"Material Id"},"description":"广告素材ID/Ad material ID","example":"7213258221116751874"},{"name":"metric","in":"query","required":false,"schema":{"type":"string","description":"分析指标/Analysis metric (retain_ctr, retain_cvr, click_cnt, convert_cnt, play_retain_cnt)","default":"retain_ctr","title":"Metric"},"description":"分析指标/Analysis metric (retain_ctr, retain_cvr, click_cnt, convert_cnt, play_retain_cnt)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_ad_percentile":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取广告百分位数据/Get ad percentile data","description":"# [中文]\n### 用途:\n- 获取广告在同行业中的百分位排名数据\n- 了解广告在各项指标上相对于同行的表现水平\n- 帮助评估广告效果并制定优化策略\n\n### 参数:\n- material_id: 广告素材ID，必填参数\n- metric: 分析指标，可选值：\n  - ctr_percentile: 点击率百分位（默认）\n  - time_attr_conversion_rate_percentile: 时间归因转化率百分位\n  - click_cnt_percentile: 点击次数百分位\n  - time_attr_convert_cnt_percentile: 时间归因转化次数百分位\n  - show_cnt_percentile: 展示次数百分位\n- period_type: 时间范围(天)，默认180天\n\n### 返回内容说明:\n- `percentile_data`: 百分位数据\n  - `ctr_percentile`: 点击率百分位（0-100）\n  - `cvr_percentile`: 转化率百分位\n  - `engagement_percentile`: 互动率百分位\n  - `view_percentile`: 观看量百分位\n  - `industry_average`: 行业平均值对比\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_ad_percentile\",\n  \"params\": {\n    \"material_id\": \"7213258221116751874\"\n  },\n  \"data\": {\n    \"percentile_data\": {\n      \"ctr_percentile\": 85,\n      \"cvr_percentile\": 72,\n      \"engagement_percentile\": 90,\n      \"view_percentile\": 88,\n      \"industry_average\": {\n        \"ctr\": 2.5,\n        \"cvr\": 1.2,\n        \"engagement\": 5.8\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get ad percentile ranking data within the industry\n- Understand ad performance levels relative to peers across various metrics\n- Help evaluate ad effectiveness and develop optimization strategies\n\n### Parameters:\n- material_id: Ad material ID, required parameter\n- metric: Analysis metric, options:\n  - ctr_percentile: CTR percentile (default)\n  - time_attr_conversion_rate_percentile: Time-attributed conversion rate percentile\n  - click_cnt_percentile: Click count percentile\n  - time_attr_convert_cnt_percentile: Time-attributed conversion count percentile\n  - show_cnt_percentile: Impression count percentile\n- period_type: Time period in days, default 180\n\n### Return Description:\n- `percentile_data`: Percentile data\n  - `ctr_percentile`: Click-through rate percentile (0-100)\n  - `cvr_percentile`: Conversion rate percentile\n  - `engagement_percentile`: Engagement rate percentile\n  - `view_percentile`: View count percentile\n  - `industry_average`: Industry average comparison\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_ad_percentile\",\n  \"params\": {\n    \"material_id\": \"7213258221116751874\"\n  },\n  \"data\": {\n    \"percentile_data\": {\n      \"ctr_percentile\": 85,\n      \"cvr_percentile\": 72,\n      \"engagement_percentile\": 90,\n      \"view_percentile\": 88,\n      \"industry_average\": {\n        \"ctr\": 2.5,\n        \"cvr\": 1.2,\n        \"engagement\": 5.8\n      }\n    }\n  }\n}\n```","operationId":"get_ad_percentile_api_v1_tiktok_ads_get_ad_percentile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"material_id","in":"query","required":true,"schema":{"type":"string","description":"广告素材ID/Ad material ID","title":"Material Id"},"description":"广告素材ID/Ad material ID","example":"7213258221116751874"},{"name":"metric","in":"query","required":false,"schema":{"type":"string","description":"分析指标/Analysis metric (ctr_percentile, time_attr_conversion_rate_percentile, click_cnt_percentile, time_attr_convert_cnt_percentile, show_cnt_percentile)","default":"ctr_percentile","title":"Metric"},"description":"分析指标/Analysis metric (ctr_percentile, time_attr_conversion_rate_percentile, click_cnt_percentile, time_attr_convert_cnt_percentile, show_cnt_percentile)"},{"name":"period_type","in":"query","required":false,"schema":{"type":"integer","description":"时间范围(天)/Time period (days)","default":180,"title":"Period Type"},"description":"时间范围(天)/Time period (days)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_ad_interactive_analysis":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取广告互动分析/Get ad interactive analysis","description":"# [中文]\n### 用途:\n- 获取广告的互动时间分析，了解观众在视频不同时间点的留存和互动情况\n- 分析广告视频的吸引力曲线，找出最佳时长和关键互动点\n- 优化广告内容结构，提高整体效果\n\n### 参数:\n- material_id: 广告素材ID，必填参数\n- metric_type: 分析类型\n    - ctr: 点击率分析\n    - cvr: 转化率分析\n    - clicks: 点击次数分析\n    - conversion: 转化次数分析\n    - remain: 留存率分析 (默认)\n- period_type: 时间范围，默认180天\n\n### 返回内容说明:\n- `interactive_data`: 互动分析数据\n  - `time_series`: 时间序列数据\n    - `time`: 视频播放时间点（秒）\n    - `value`: 对应的指标值（如留存率）\n  - `average_watch_time`: 平均观看时长\n  - `completion_rate`: 完播率\n  - `peak_interaction_time`: 互动高峰时间点\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_ad_interactive_analysis\",\n  \"params\": {\n    \"material_id\": \"7213258221116751874\",\n    \"metric_type\": \"remain\",\n    \"period_type\": 180\n  },\n  \"data\": {\n    \"interactive_data\": {\n      \"time_series\": [\n        {\"time\": 0, \"value\": 100},\n        {\"time\": 1, \"value\": 95},\n        {\"time\": 2, \"value\": 88}\n      ],\n      \"average_watch_time\": 8.5,\n      \"completion_rate\": 65.2,\n      \"peak_interaction_time\": 3\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get ad interactive time analysis to understand audience retention and engagement at different video time points\n- Analyze ad video attractiveness curve to find optimal duration and key interaction points\n- Optimize ad content structure to improve overall effectiveness\n\n### Parameters:\n- material_id: Ad material ID, required parameter\n- metric_type: Analysis type\n    - ctr: Click-through rate analysis\n    - cvr: Conversion rate analysis\n    - clicks: Click count analysis\n    - conversion: Conversion count analysis\n    - remain: Retention rate analysis (default)\n- period_type: Time range, default 180 days\n\n### Return Description:\n- `interactive_data`: Interactive analysis data\n  - `time_series`: Time series data\n    - `time`: Video playback time point (seconds)\n    - `value`: Corresponding metric value (e.g., retention rate)\n  - `average_watch_time`: Average watch time\n  - `completion_rate`: Completion rate\n  - `peak_interaction_time`: Peak interaction time point\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_ad_interactive_analysis\",\n  \"params\": {\n    \"material_id\": \"7213258221116751874\",\n    \"metric_type\": \"remain\",\n    \"period_type\": 180\n  },\n  \"data\": {\n    \"interactive_data\": {\n      \"time_series\": [\n        {\"time\": 0, \"value\": 100},\n        {\"time\": 1, \"value\": 95},\n        {\"time\": 2, \"value\": 88}\n      ],\n      \"average_watch_time\": 8.5,\n      \"completion_rate\": 65.2,\n      \"peak_interaction_time\": 3\n    }\n  }\n}\n```","operationId":"get_ad_interactive_analysis_api_v1_tiktok_ads_get_ad_interactive_analysis_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"material_id","in":"query","required":true,"schema":{"type":"string","description":"广告素材ID/Ad material ID","title":"Material Id"},"description":"广告素材ID/Ad material ID","example":"7213258221116751874"},{"name":"metric_type","in":"query","required":false,"schema":{"type":"string","description":"分析类型/Analysis type (ctr, cvr, clicks, conversion, remain)","default":"remain","title":"Metric Type"},"description":"分析类型/Analysis type (ctr, cvr, clicks, conversion, remain)"},{"name":"period_type","in":"query","required":false,"schema":{"type":"integer","description":"时间范围(天)/Period type (days)","default":180,"title":"Period Type"},"description":"时间范围(天)/Period type (days)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_recommended_ads":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取推荐广告/Get recommended ads","description":"# [中文]\n### 用途:\n- 基于指定广告获取相似的推荐广告列表\n- 发现同行业或相似风格的优秀广告案例\n- 为广告创意提供更多参考和灵感\n\n### 参数:\n- material_id: 参考广告素材ID，必填参数\n- industry: 行业ID，如游戏行业：25308000000\n- country_code: 国家代码，如US、UK、JP等\n\n### 返回内容说明:\n- `materials`: 推荐广告素材列表\n  - `ad_title`: 广告标题\n  - `brand_name`: 品牌名称\n  - `cost`: 花费等级\n  - `ctr`: 点击率\n  - `favorite`: 是否收藏\n  - `id`: 广告ID\n  - `industry_key`: 行业键值\n  - `is_search`: 是否搜索结果\n  - `like`: 点赞数\n  - `objective_key`: 广告目标键值\n  - `tag`: 标签\n  - `video_info`: 视频信息\n    - `vid`: 视频ID\n    - `duration`: 时长（秒）\n    - `cover`: 封面图URL\n    - `video_url`: 视频播放地址\n      - `360p`: 360p画质\n      - `480p`: 480p画质\n      - `540p`: 540p画质\n      - `720p`: 720p画质\n    - `width`: 视频宽度\n    - `height`: 视频高度\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_recommended_ads\",\n  \"params\": {\n    \"material_id\": \"7213258221116751874\",\n    \"industry\": \"25308000000\",\n    \"country_code\": \"US\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"materials\": [\n        {\n          \"ad_title\": \"What will you decide?\",\n          \"brand_name\": \"Eatventure\",\n          \"cost\": 2,\n          \"ctr\": 0.07,\n          \"favorite\": false,\n          \"id\": \"7164756134804979714\",\n          \"industry_key\": \"label_25308000000\",\n          \"is_search\": false,\n          \"like\": 1009024,\n          \"objective_key\": \"campaign_objective_conversion\",\n          \"tag\": 3,\n          \"video_info\": {\n            \"vid\": \"v10033g50000ctgjtl7og65ivnpdo87g\",\n            \"duration\": 30.016,\n            \"cover\": \"https://p16-sign-sg.tiktokcdn.com/v0201/ogKcNlWrjIQwDVBDpBbeR7PDQXnAIeA9Dgbb4w~tplv-noop.image\",\n            \"video_url\": {\n              \"360p\": \"https://v16m-default.tiktokcdn.com/9e086e91176219d756e9c875fb739dc4/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oIQcoRBNNpXbALnjIeLgbKfwWPDDDDIgQ9l6BF\",\n              \"480p\": \"https://v16m-default.tiktokcdn.com/2f304931bd351dad0e43e9771364bd78/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/o8lIsnPILWelBwDbDgDuwQj9UlNebAYdDUXBKS\",\n              \"540p\": \"https://v16m-default.tiktokcdn.com/351ae3acb3121d42db8a5091811b2340/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oQwpeXyWjDBg7KXcBDeDgPnDDbANoISoQIb9Ql\",\n              \"720p\": \"https://v16m-default.tiktokcdn.com/a04bacceb906e5336a68158479f5eac5/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oQQnWCmCDfpgIxegjrKAXZlbIPDNBDDbZQBHw9\"\n            },\n            \"width\": 720,\n            \"height\": 1280\n          }\n        }\n      ]\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get similar recommended ads based on a specified ad\n- Discover excellent ad cases in the same industry or with similar styles\n- Provide more references and inspiration for ad creativity\n\n### Parameters:\n- material_id: Reference ad material ID, required parameter\n- industry: Industry ID, e.g., Games: 25308000000\n- country_code: Country code, e.g., US, UK, JP\n\n### Return Description:\n- `materials`: Recommended ad materials list\n  - `ad_title`: Ad title\n  - `brand_name`: Brand name\n  - `cost`: Cost level\n  - `ctr`: Click-through rate\n  - `favorite`: Whether favorited\n  - `id`: Ad ID\n  - `industry_key`: Industry key\n  - `is_search`: Whether search result\n  - `like`: Like count\n  - `objective_key`: Ad objective key\n  - `tag`: Tag\n  - `video_info`: Video information\n    - `vid`: Video ID\n    - `duration`: Duration in seconds\n    - `cover`: Cover image URL\n    - `video_url`: Video playback URLs\n      - `360p`: 360p quality\n      - `480p`: 480p quality\n      - `540p`: 540p quality\n      - `720p`: 720p quality\n    - `width`: Video width\n    - `height`: Video height\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_recommended_ads\",\n  \"params\": {\n    \"material_id\": \"7213258221116751874\",\n    \"industry\": \"25308000000\",\n    \"country_code\": \"US\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"materials\": [\n        {\n          \"ad_title\": \"What will you decide?\",\n          \"brand_name\": \"Eatventure\",\n          \"cost\": 2,\n          \"ctr\": 0.07,\n          \"favorite\": false,\n          \"id\": \"7164756134804979714\",\n          \"industry_key\": \"label_25308000000\",\n          \"is_search\": false,\n          \"like\": 1009024,\n          \"objective_key\": \"campaign_objective_conversion\",\n          \"tag\": 3,\n          \"video_info\": {\n            \"vid\": \"v10033g50000ctgjtl7og65ivnpdo87g\",\n            \"duration\": 30.016,\n            \"cover\": \"https://p16-sign-sg.tiktokcdn.com/v0201/ogKcNlWrjIQwDVBDpBbeR7PDQXnAIeA9Dgbb4w~tplv-noop.image\",\n            \"video_url\": {\n              \"360p\": \"https://v16m-default.tiktokcdn.com/9e086e91176219d756e9c875fb739dc4/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oIQcoRBNNpXbALnjIeLgbKfwWPDDDDIgQ9l6BF\",\n              \"480p\": \"https://v16m-default.tiktokcdn.com/2f304931bd351dad0e43e9771364bd78/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/o8lIsnPILWelBwDbDgDuwQj9UlNebAYdDUXBKS\",\n              \"540p\": \"https://v16m-default.tiktokcdn.com/351ae3acb3121d42db8a5091811b2340/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oQwpeXyWjDBg7KXcBDeDgPnDDbANoISoQIb9Ql\",\n              \"720p\": \"https://v16m-default.tiktokcdn.com/a04bacceb906e5336a68158479f5eac5/684d7e29/video/tos/useast2a/tos-useast2a-ve-0051c799-euttp/oQQnWCmCDfpgIxegjrKAXZlbIPDNBDDbZQBHw9\"\n            },\n            \"width\": 720,\n            \"height\": 1280\n          }\n        }\n      ]\n    }\n  }\n}\n```","operationId":"get_recommended_ads_api_v1_tiktok_ads_get_recommended_ads_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"material_id","in":"query","required":true,"schema":{"type":"string","description":"广告素材ID/Ad material ID","title":"Material Id"},"description":"广告素材ID/Ad material ID","example":"7213258221116751874"},{"name":"industry","in":"query","required":false,"schema":{"type":"string","description":"行业ID/Industry ID","default":"25308000000","title":"Industry"},"description":"行业ID/Industry ID"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_query_suggestions":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取查询建议/Get query suggestions","description":"# [中文]\n### 用途:\n- 获取广告搜索的热门查询建议\n- 了解当前流行的广告搜索关键词和趋势\n- 帮助发现新的广告创意方向和热点话题\n\n### 参数:\n- count: 返回的建议数量，默认50\n- scenario: 场景类型，默认1\n\n### 返回内容说明:\n- `query`: 查询建议列表（字符串数组）\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_query_suggestions\",\n  \"params\": {\n    \"count\": \"50\",\n    \"scenario\": \"1\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"query\": [\n        \"shop now\",\n        \"50% off\"\n      ]\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get popular query suggestions for ad search\n- Understand current popular ad search keywords and trends\n- Help discover new creative directions and hot topics\n\n### Parameters:\n- count: Number of suggestions to return, default 50\n- scenario: Scenario type, default 1\n\n### Return Description:\n- `query`: Query suggestions list (string array)\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_query_suggestions\",\n  \"params\": {\n    \"count\": \"50\",\n    \"scenario\": \"1\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"query\": [\n        \"shop now\",\n        \"50% off\"\n      ]\n    }\n  }\n}\n```","operationId":"get_query_suggestions_api_v1_tiktok_ads_get_query_suggestions_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"建议数量/Suggestion count","default":50,"title":"Count"},"description":"建议数量/Suggestion count"},{"name":"scenario","in":"query","required":false,"schema":{"type":"integer","description":"场景类型/Scenario type","default":1,"title":"Scenario"},"description":"场景类型/Scenario type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_keyword_filters":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取关键词筛选器/Get keyword filters","description":"# [中文]\n### 用途:\n- 获取关键词洞察功能的可用筛选选项\n- 了解支持的国家/地区、行业、关键词类型等筛选维度\n- 为关键词分析提供筛选参数参考\n\n### 返回内容说明:\n- `country_list`: 支持的国家/地区列表\n  - `id`: 国家代码\n  - `value`: 国家名称\n- `industry_list`: 支持的行业列表\n  - `id`: 行业ID\n  - `value`: 行业名称\n- `keyword_type`: 支持的关键词类型\n- `objective_list`: 支持的广告目标列表\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_keyword_filters\",\n  \"params\": {},\n  \"data\": {\n    \"country_list\": [\n      {\"id\": \"US\", \"value\": \"United States\"},\n      {\"id\": \"UK\", \"value\": \"United Kingdom\"}\n    ],\n    \"industry_list\": [\n      {\"id\": \"27000000000\", \"value\": \"Games\"},\n      {\"id\": \"19000000000\", \"value\": \"E-commerce\"}\n    ],\n    \"keyword_type\": [\"general\", \"brand\", \"product\"],\n    \"objective_list\": [\n      {\"id\": \"1\", \"value\": \"Traffic\"},\n      {\"id\": \"2\", \"value\": \"Conversions\"}\n    ]\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get available filter options for keyword insights functionality\n- Understand supported countries/regions, industries, keyword types and other filter dimensions\n- Provide filter parameter reference for keyword analysis\n\n### Return Description:\n- `country_list`: List of supported countries/regions\n  - `id`: Country code\n  - `value`: Country name\n- `industry_list`: List of supported industries\n  - `id`: Industry ID\n  - `value`: Industry name\n- `keyword_type`: Supported keyword types\n- `objective_list`: List of supported ad objectives\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_keyword_filters\",\n  \"params\": {},\n  \"data\": {\n    \"country_list\": [\n      {\"id\": \"US\", \"value\": \"United States\"},\n      {\"id\": \"UK\", \"value\": \"United Kingdom\"}\n    ],\n    \"industry_list\": [\n      {\"id\": \"27000000000\", \"value\": \"Games\"},\n      {\"id\": \"19000000000\", \"value\": \"E-commerce\"}\n    ],\n    \"keyword_type\": [\"general\", \"brand\", \"product\"],\n    \"objective_list\": [\n      {\"id\": \"1\", \"value\": \"Traffic\"},\n      {\"id\": \"2\", \"value\": \"Conversions\"}\n    ]\n  }\n}\n```","operationId":"get_keyword_filters_api_v1_tiktok_ads_get_keyword_filters_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/ads/get_related_keywords":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取相关关键词/Get related keywords","description":"# [中文]\n### 用途:\n- 获取与指定关键词相关的其他关键词或标签\n- 发现关键词的相关搜索词，扩展广告投放词库\n- 分析突破性关键词，抓住新兴趋势\n\n### 参数:\n- keyword: 主关键词，必填参数\n- period: 时间范围（天），如7、30天\n- country_code: 国家代码，如US、UK、JP等\n- rank_type: 排序类型，\"popular\"=热门，\"breakout\"=突破性\n- content_type: 内容类型，\"keyword\"=关键词，\"hashtag\"=标签\n\n### 返回内容说明:\n- `list`: 相关关键词列表\n  - `keyword`: 相关关键词文本\n  - `relevance_score`: 相关性评分\n  - `search_volume`: 搜索量级别\n  - `growth_rate`: 增长率（突破性关键词）\n  - `post_count`: 使用该词的广告数量\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_related_keywords\",\n  \"params\": {\n    \"keyword\": \"free shipping\",\n    \"period\": 7,\n    \"rank_type\": \"popular\"\n  },\n  \"data\": {\n    \"list\": [\n      {\n        \"keyword\": \"fast delivery\",\n        \"relevance_score\": 95,\n        \"search_volume\": \"high\",\n        \"post_count\": 8934\n      },\n      {\n        \"keyword\": \"discount code\",\n        \"relevance_score\": 88,\n        \"search_volume\": \"medium\",\n        \"post_count\": 5621\n      }\n    ]\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get other keywords or hashtags related to a specified keyword\n- Discover related search terms to expand ad keyword library\n- Analyze breakout keywords to capture emerging trends\n\n### Parameters:\n- keyword: Main keyword, required parameter\n- period: Time period in days, e.g., 7, 30 days\n- country_code: Country code, e.g., US, UK, JP\n- rank_type: Ranking type, \"popular\"=Popular, \"breakout\"=Breakout\n- content_type: Content type, \"keyword\"=Keywords, \"hashtag\"=Hashtags\n\n### Return Description:\n- `list`: Related keywords list\n  - `keyword`: Related keyword text\n  - `relevance_score`: Relevance score\n  - `search_volume`: Search volume level\n  - `growth_rate`: Growth rate (for breakout keywords)\n  - `post_count`: Number of ads using this term\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_related_keywords\",\n  \"params\": {\n    \"keyword\": \"free shipping\",\n    \"period\": 7,\n    \"rank_type\": \"popular\"\n  },\n  \"data\": {\n    \"list\": [\n      {\n        \"keyword\": \"fast delivery\",\n        \"relevance_score\": 95,\n        \"search_volume\": \"high\",\n        \"post_count\": 8934\n      },\n      {\n        \"keyword\": \"discount code\",\n        \"relevance_score\": 88,\n        \"search_volume\": \"medium\",\n        \"post_count\": 5621\n      }\n    ]\n  }\n}\n```","operationId":"get_related_keywords_api_v1_tiktok_ads_get_related_keywords_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"目标关键词/Target keyword","default":"free shipping","title":"Keyword"},"description":"目标关键词/Target keyword"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间段（天）/Time period (days, 7/30/120)","default":7,"title":"Period"},"description":"时间段（天）/Time period (days, 7/30/120)"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家/地区代码/Country code","default":"US","title":"Country Code"},"description":"国家/地区代码/Country code"},{"name":"rank_type","in":"query","required":false,"schema":{"type":"string","description":"排名类型/Rank type (popular: 热门, breakout: 突破性)","default":"popular","title":"Rank Type"},"description":"排名类型/Rank type (popular: 热门, breakout: 突破性)"},{"name":"content_type","in":"query","required":false,"schema":{"type":"string","description":"内容类型/Content type (keyword, hashtag)","default":"keyword","title":"Content Type"},"description":"内容类型/Content type (keyword, hashtag)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":50,"title":"Limit"},"description":"每页数量/Items per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_keyword_details":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取关键词详细信息/Get keyword details","description":"# [中文]\n### 用途:\n- 获取特定关键词的详细数据，包括发布量、示例视频等\n- 不提供关键词时，返回热门关键词排名列表\n- 深入分析关键词的使用情况和效果\n\n### 参数:\n- keyword: 关键词，可选。不提供时返回排名列表\n- page: 页码，默认1\n- limit: 每页数量，默认20\n- period: 时间范围（天），如7、30天\n- country_code: 国家代码，如US、UK、JP等\n- order_by: 排序字段，如\"post\"（发布量）\n- order_type: 排序方式，desc（降序）或asc（升序）\n\n### 返回内容说明:\n- `keyword_list`: 关键词详情列表\n  - `comment`: 评论数\n  - `cost`: 花费金额\n  - `cpa`: 每次转化成本\n  - `ctr`: 点击率\n  - `cvr`: 转化率\n  - `impression`: 展示量\n  - `keyword`: 关键词文本\n  - `like`: 点赞数\n  - `play_six_rate`: 6秒播放率\n  - `post`: 发布量\n  - `post_change`: 发布量变化率\n  - `share`: 分享数\n  - `video_list`: 视频ID列表\n- `pagination`: 分页信息\n  - `page`: 当前页\n  - `size`: 每页数量\n  - `total`: 总数量\n  - `has_more`: 是否有更多\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_keyword_details\",\n  \"params\": {\n    \"keyword\": \"\",\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"period\": \"7\",\n    \"country_code\": \"US\",\n    \"order_by\": \"post\",\n    \"order_type\": \"desc\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"keyword_list\": [\n        {\n          \"comment\": 4785,\n          \"cost\": 756000,\n          \"cpa\": 20.2,\n          \"ctr\": 0.53,\n          \"cvr\": 9.75,\n          \"impression\": 164000000,\n          \"keyword\": \"summer\",\n          \"like\": 475734,\n          \"play_six_rate\": 6.43,\n          \"post\": 14200,\n          \"post_change\": 111.21,\n          \"share\": 5754,\n          \"video_list\": [\n            \"7504060523021896977\",\n            \"7512164952346529031\"\n          ]\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 484,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get detailed data for specific keywords, including post volume, example videos, etc.\n- When no keyword is provided, returns a ranked list of popular keywords\n- Deep analysis of keyword usage and effectiveness\n\n### Parameters:\n- keyword: Keyword, optional. Returns ranking list when not provided\n- page: Page number, default 1\n- limit: Items per page, default 20\n- period: Time period in days, e.g., 7, 30 days\n- country_code: Country code, e.g., US, UK, JP\n- order_by: Sort field, e.g., \"post\" (post volume)\n- order_type: Sort order, desc (descending) or asc (ascending)\n\n### Return Description:\n- `keyword_list`: Keyword details list\n  - `comment`: Comment count\n  - `cost`: Cost amount\n  - `cpa`: Cost per acquisition\n  - `ctr`: Click-through rate\n  - `cvr`: Conversion rate\n  - `impression`: Impression count\n  - `keyword`: Keyword text\n  - `like`: Like count\n  - `play_six_rate`: 6-second play rate\n  - `post`: Post volume\n  - `post_change`: Post volume change rate\n  - `share`: Share count\n  - `video_list`: Video ID list\n- `pagination`: Pagination info\n  - `page`: Current page\n  - `size`: Items per page\n  - `total`: Total count\n  - `has_more`: Whether there are more items\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_keyword_details\",\n  \"params\": {\n    \"keyword\": \"\",\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"period\": \"7\",\n    \"country_code\": \"US\",\n    \"order_by\": \"post\",\n    \"order_type\": \"desc\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"keyword_list\": [\n        {\n          \"comment\": 4785,\n          \"cost\": 756000,\n          \"cpa\": 20.2,\n          \"ctr\": 0.53,\n          \"cvr\": 9.75,\n          \"impression\": 164000000,\n          \"keyword\": \"summer\",\n          \"like\": 475734,\n          \"play_six_rate\": 6.43,\n          \"post\": 14200,\n          \"post_change\": 111.21,\n          \"share\": 5754,\n          \"video_list\": [\n            \"7504060523021896977\",\n            \"7512164952346529031\"\n          ]\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 484,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```","operationId":"get_keyword_details_api_v1_tiktok_ads_get_keyword_details_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"关键词（可选）/Keyword (optional)","default":"","title":"Keyword"},"description":"关键词（可选）/Keyword (optional)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间范围（天）/Time period (days)","default":7,"title":"Period"},"description":"时间范围（天）/Time period (days)"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"排序字段/Sort field","default":"post","title":"Order By"},"description":"排序字段/Sort field"},{"name":"order_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort order (desc, asc)","default":"desc","title":"Order Type"},"description":"排序方式/Sort order (desc, asc)"},{"name":"industry","in":"query","required":false,"schema":{"type":"string","description":"行业ID/Industry ID","title":"Industry"},"description":"行业ID/Industry ID"},{"name":"objective","in":"query","required":false,"schema":{"type":"string","description":"广告目标/Ad objective","title":"Objective"},"description":"广告目标/Ad objective"},{"name":"keyword_type","in":"query","required":false,"schema":{"type":"string","description":"关键词类型/Keyword type","title":"Keyword Type"},"description":"关键词类型/Keyword type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_creative_patterns":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取创意模式排行榜/Get creative pattern rankings","description":"# [中文]\n### 用途:\n- 获取特定行业的创意模式排行榜，了解哪些创意模式效果最好\n- 分析不同创意模式的点击率、完播率等关键指标\n- 为广告创意制作提供数据支持的最佳实践\n\n### 参数:\n- first_industry_id: 行业ID，如游戏行业：25000000000\n- period_type: 时间类型，\"week\"=周数据，\"month\"=月数据\n- order_field: 排序字段，\"ctr\"=点击率，\"play_over_rate\"=播放完成率\n- order_type: 排序方式，desc（降序）或asc（升序）\n- week: 查看特定周的数据，格式：YYYY-MM-DD（可选）\n\n### 返回内容说明:\n- `list`: 创意模式列表\n  - `label_info`: 模式标签信息\n    - `value`: 模式名称\n    - `description`: 模式描述\n  - `ctr`: 点击率（百分比）\n  - `play_over_rate`: 播放完成率（百分比）\n  - `avg_watch_time`: 平均观看时长\n  - `example_count`: 示例数量\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_creative_patterns\",\n  \"params\": {\n    \"first_industry_id\": \"25000000000\",\n    \"period_type\": \"week\",\n    \"order_field\": \"ctr\"\n  },\n  \"data\": {\n    \"list\": [\n      {\n        \"label_info\": {\n          \"value\": \"Problem-Solution\",\n          \"description\": \"Present a problem and show the solution\"\n        },\n        \"ctr\": 4.5,\n        \"play_over_rate\": 68.2,\n        \"avg_watch_time\": 12.3,\n        \"example_count\": 234\n      }\n    ]\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get creative pattern rankings for specific industries to understand which patterns perform best\n- Analyze key metrics like CTR and completion rate for different creative patterns\n- Provide data-driven best practices for ad creative production\n\n### Parameters:\n- first_industry_id: Industry ID, e.g., Games: 25000000000\n- period_type: Period type, \"week\"=Weekly data, \"month\"=Monthly data\n- order_field: Sort field, \"ctr\"=Click-through rate, \"play_over_rate\"=Completion rate\n- order_type: Sort order, desc (descending) or asc (ascending)\n- week: View data for specific week, format: YYYY-MM-DD (optional)\n\n### Return Description:\n- `list`: Creative pattern list\n  - `label_info`: Pattern label information\n    - `value`: Pattern name\n    - `description`: Pattern description\n  - `ctr`: Click-through rate (percentage)\n  - `play_over_rate`: Play completion rate (percentage)\n  - `avg_watch_time`: Average watch time\n  - `example_count`: Number of examples\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_creative_patterns\",\n  \"params\": {\n    \"first_industry_id\": \"25000000000\",\n    \"period_type\": \"week\",\n    \"order_field\": \"ctr\"\n  },\n  \"data\": {\n    \"list\": [\n      {\n        \"label_info\": {\n          \"value\": \"Problem-Solution\",\n          \"description\": \"Present a problem and show the solution\"\n        },\n        \"ctr\": 4.5,\n        \"play_over_rate\": 68.2,\n        \"avg_watch_time\": 12.3,\n        \"example_count\": 234\n      }\n    ]\n  }\n}\n```","operationId":"get_creative_patterns_api_v1_tiktok_ads_get_creative_patterns_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"first_industry_id","in":"query","required":false,"schema":{"type":"string","description":"一级行业ID/First industry ID","default":"25000000000","title":"First Industry Id"},"description":"一级行业ID/First industry ID"},{"name":"period_type","in":"query","required":false,"schema":{"type":"string","description":"时间周期类型/Period type (week, month)","default":"week","title":"Period Type"},"description":"时间周期类型/Period type (week, month)"},{"name":"order_field","in":"query","required":false,"schema":{"type":"string","description":"排序字段/Order field (ctr, play_over_rate)","default":"ctr","title":"Order Field"},"description":"排序字段/Order field (ctr, play_over_rate)"},{"name":"order_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort order (desc, asc)","default":"desc","title":"Order Type"},"description":"排序方式/Sort order (desc, asc)"},{"name":"week","in":"query","required":false,"schema":{"type":"string","description":"特定周（可选）/Specific week (optional)","title":"Week"},"description":"特定周（可选）/Specific week (optional)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_product_filters":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取产品筛选器/Get product filters","description":"# [中文]\n### 用途:\n- 获取产品分析功能的可用筛选选项\n- 了解支持的电商类目、时间类型等筛选维度\n- 为产品数据分析提供筛选参数参考\n\n### 返回内容说明:\n- `country`: 国家列表\n  - `id`: 国家ID\n  - `value`: 国家名称\n  - `label`: 国家标签\n- `ecom_category`: 电商类目列表\n  - `id`: 类目ID\n  - `value`: 类目名称\n  - `label`: 类目标签\n- `latest_month`: 最新月份\n- `latest_week`: 最新周\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_product_filters\",\n  \"params\": {},\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"country\": [\n        {\n          \"id\": \"AR\",\n          \"value\": \"Argentina\",\n          \"label\": \"AR\"\n        },\n        {\n          \"id\": \"AU\",\n          \"value\": \"Australia\",\n          \"label\": \"AU\"\n        }\n      ],\n      \"ecom_category\": [\n        {\n          \"id\": 605196,\n          \"value\": \"Automotive & Motorbike\",\n          \"label\": \"category_605196\"\n        },\n        {\n          \"id\": 602284,\n          \"value\": \"Baby & Maternity\",\n          \"label\": \"category_602284\"\n        }\n      ],\n      \"latest_month\": \"2025-05\",\n      \"latest_week\": \"2025-06-07\"\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get available filter options for product analysis functionality\n- Understand supported e-commerce categories, time types and other filter dimensions\n- Provide filter parameter reference for product data analysis\n\n### Return Description:\n- `country`: Country list\n  - `id`: Country ID\n  - `value`: Country name\n  - `label`: Country label\n- `ecom_category`: E-commerce category list\n  - `id`: Category ID\n  - `value`: Category name\n  - `label`: Category label\n- `latest_month`: Latest month\n- `latest_week`: Latest week\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_product_filters\",\n  \"params\": {},\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"country\": [\n        {\n          \"id\": \"AR\",\n          \"value\": \"Argentina\",\n          \"label\": \"AR\"\n        },\n        {\n          \"id\": \"AU\",\n          \"value\": \"Australia\",\n          \"label\": \"AU\"\n        }\n      ],\n      \"ecom_category\": [\n        {\n          \"id\": 605196,\n          \"value\": \"Automotive & Motorbike\",\n          \"label\": \"category_605196\"\n        },\n        {\n          \"id\": 602284,\n          \"value\": \"Baby & Maternity\",\n          \"label\": \"category_602284\"\n        }\n      ],\n      \"latest_month\": \"2025-05\",\n      \"latest_week\": \"2025-06-07\"\n    }\n  }\n}\n```","operationId":"get_product_filters_api_v1_tiktok_ads_get_product_filters_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/ads/get_product_metrics":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取产品指标数据/Get product metrics","description":"# [中文]\n### 用途:\n- 获取特定产品类目的详细指标数据和时间趋势\n- 分析产品的发布量、点击率、转化率等核心指标变化\n- 帮助了解产品类目的市场表现和发展趋势\n\n### 参数:\n- id: 产品类目ID，如香水：601583\n- last: 最近天数，如7、30天\n- metrics: 指标类型，多个用逗号分隔，如\"post,ctr,cvr\"\n- ecom_type: 电商类型，默认\"l3\"\n- period_type: 时间类型，默认\"last\"\n\n### 返回内容说明:\n- `info`: 产品指标信息\n  - `comment`: 评论数\n  - `cost`: 花费金额\n  - `cover_url`: 封面图URL（可能为null）\n  - `cpa`: 每次转化成本\n  - `ctr`: 点击率\n  - `ctr_metrics`: 点击率时间序列数据\n    - `time`: 时间戳\n    - `value`: 对应时间的点击率\n  - `cvr`: 转化率\n  - `ecom_type`: 电商类型\n  - `first_ecom_category`: 一级电商类目\n  - `impression`: 展示量\n  - `like`: 点赞数\n  - `play_six_rate`: 6秒播放率\n  - `post`: 发布量\n  - `post_change`: 发布量变化率\n  - `post_metrics`: 发布量时间序列数据\n    - `time`: 时间戳\n    - `value`: 对应时间的发布量\n  - `second_ecom_category`: 二级电商类目\n  - `share`: 分享数\n  - `third_ecom_category`: 三级电商类目\n  - `url_title`: URL标题\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_product_metrics\",\n  \"params\": {\n    \"id\": \"601583\",\n    \"last\": \"30\",\n    \"metrics\": \"post,ctr\",\n    \"ecom_type\": \"l3\",\n    \"period_type\": \"last\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"info\": {\n        \"comment\": 13559,\n        \"cost\": 2330000,\n        \"cover_url\": null,\n        \"cpa\": 12.4,\n        \"ctr\": 1.04,\n        \"ctr_metrics\": [\n          {\n            \"time\": 1747267200,\n            \"value\": 0.88\n          },\n          {\n            \"time\": 1747353600,\n            \"value\": 0.99\n          }\n        ],\n        \"cvr\": 15.2,\n        \"ecom_type\": \"l3\",\n        \"post\": 52300,\n        \"post_change\": -8.12,\n        \"post_metrics\": [\n          {\n            \"time\": 1747267200,\n            \"value\": 1800\n          }\n        ]\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get detailed metric data and time trends for specific product categories\n- Analyze changes in core metrics like post volume, CTR, CVR for products\n- Help understand market performance and development trends of product categories\n\n### Parameters:\n- id: Product category ID, e.g., Perfume: 601583\n- last: Number of recent days, e.g., 7, 30 days\n- metrics: Metric types, multiple separated by commas, e.g., \"post,ctr,cvr\"\n- ecom_type: E-commerce type, default \"l3\"\n- period_type: Period type, default \"last\"\n\n### Return Description:\n- `info`: Product metric information\n  - `comment`: Comment count\n  - `cost`: Cost amount\n  - `cover_url`: Cover image URL (may be null)\n  - `cpa`: Cost per acquisition\n  - `ctr`: Click-through rate\n  - `ctr_metrics`: CTR time series data\n    - `time`: Timestamp\n    - `value`: CTR at that time\n  - `cvr`: Conversion rate\n  - `ecom_type`: E-commerce type\n  - `first_ecom_category`: First-level e-commerce category\n  - `impression`: Impression count\n  - `like`: Like count\n  - `play_six_rate`: 6-second play rate\n  - `post`: Post volume\n  - `post_change`: Post volume change rate\n  - `post_metrics`: Post volume time series data\n    - `time`: Timestamp\n    - `value`: Post volume at that time\n  - `second_ecom_category`: Second-level e-commerce category\n  - `share`: Share count\n  - `third_ecom_category`: Third-level e-commerce category\n  - `url_title`: URL title\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_product_metrics\",\n  \"params\": {\n    \"id\": \"601583\",\n    \"last\": \"30\",\n    \"metrics\": \"post,ctr\",\n    \"ecom_type\": \"l3\",\n    \"period_type\": \"last\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"info\": {\n        \"comment\": 13559,\n        \"cost\": 2330000,\n        \"cover_url\": null,\n        \"cpa\": 12.4,\n        \"ctr\": 1.04,\n        \"ctr_metrics\": [\n          {\n            \"time\": 1747267200,\n            \"value\": 0.88\n          },\n          {\n            \"time\": 1747353600,\n            \"value\": 0.99\n          }\n        ],\n        \"cvr\": 15.2,\n        \"ecom_type\": \"l3\",\n        \"post\": 52300,\n        \"post_change\": -8.12,\n        \"post_metrics\": [\n          {\n            \"time\": 1747267200,\n            \"value\": 1800\n          }\n        ]\n      }\n    }\n  }\n}\n```","operationId":"get_product_metrics_api_v1_tiktok_ads_get_product_metrics_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","description":"产品类目ID/Product category ID","title":"Id"},"description":"产品类目ID/Product category ID","example":"601583"},{"name":"last","in":"query","required":false,"schema":{"type":"integer","description":"最近天数/Last days","default":30,"title":"Last"},"description":"最近天数/Last days"},{"name":"metrics","in":"query","required":false,"schema":{"type":"string","description":"指标类型，逗号分隔/Metrics types, comma separated","default":"post,ctr","title":"Metrics"},"description":"指标类型，逗号分隔/Metrics types, comma separated"},{"name":"ecom_type","in":"query","required":false,"schema":{"type":"string","description":"电商类型/E-commerce type","default":"l3","title":"Ecom Type"},"description":"电商类型/E-commerce type"},{"name":"period_type","in":"query","required":false,"schema":{"type":"string","description":"时间类型/Period type","default":"last","title":"Period Type"},"description":"时间类型/Period type"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_product_detail":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取产品详细信息/Get product detail","description":"# [中文]\n### 用途:\n- 获取特定产品类目的完整详细信息\n- 包括受众分析、热门标签、相关帖子等多维度数据\n- 为产品营销策略提供全面的数据支持\n\n### 参数:\n- id: 产品类目ID，如香水：601583\n- last: 最近天数，如7、30天\n- ecom_type: 电商类型，默认\"l3\"\n- period_type: 时间类型，默认\"last\"\n\n### 返回内容说明:\n- `info`: 产品详细信息\n  - `audience_ages`: 受众年龄分布\n    - `age_level`: 年龄数值\n    - `score`: 占比分数\n  - `audience_interests`: 受众兴趣分布\n    - `interest_info`: 兴趣信息\n      - `id`: 兴趣ID\n      - `label`: 兴趣标签\n      - `value`: 兴趣名称\n    - `score`: 占比分数\n  - `cover_url`: 封面图URL（可能为null）\n  - `ecom_type`: 电商类型\n  - `first_ecom_category`: 一级电商类目\n    - `id`: 类目ID\n    - `label`: 类目标签\n    - `value`: 类目名称\n  - `hashtags`: 热门标签列表\n  - `posts`: 相关帖子列表\n  - `second_ecom_category`: 二级电商类目\n  - `third_ecom_category`: 三级电商类目\n  - `url_title`: URL标题\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_product_detail\",\n  \"params\": {\n    \"id\": \"601583\",\n    \"last\": \"30\",\n    \"ecom_type\": \"l3\",\n    \"period_type\": \"last\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"info\": {\n        \"audience_ages\": [\n          {\n            \"age_level\": 35,\n            \"score\": 27\n          },\n          {\n            \"age_level\": 25,\n            \"score\": 22\n          },\n          {\n            \"age_level\": 18,\n            \"score\": 22\n          },\n          {\n            \"age_level\": 45,\n            \"score\": 18\n          },\n          {\n            \"age_level\": 55,\n            \"score\": 11\n          }\n        ],\n        \"audience_interests\": [\n          {\n            \"interest_info\": {\n              \"id\": \"13105000000\",\n              \"label\": \"label_13105000000\",\n              \"value\": \"Pawn Shops\"\n            },\n            \"score\": 135\n          },\n          {\n            \"interest_info\": {\n              \"id\": \"24104000000\",\n              \"label\": \"label_24104000000\",\n              \"value\": \"Electronics & Electrical\"\n            },\n            \"score\": 127\n          }\n        ],\n        \"cover_url\": null,\n        \"ecom_type\": \"l3\",\n        \"first_ecom_category\": {\n          \"id\": \"601450\",\n          \"label\": \"category_601450\",\n          \"value\": \"Beauty & Personal Care\"\n        },\n        \"hashtags\": [\n          \"vlog\",\n          \"perfumetiktok\",\n          \"perfume\",\n          \"fragrance\",\n          \"fragrancetiktok\"\n        ],\n        \"posts\": [\n          \"7436474042036522248\",\n          \"7486253493716536584\",\n          \"7503974461725740295\"\n        ],\n        \"url_title\": \"Perfume\"\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get complete detailed information for specific product categories\n- Includes multi-dimensional data like audience analysis, popular hashtags, related posts\n- Provide comprehensive data support for product marketing strategies\n\n### Parameters:\n- id: Product category ID, e.g., Perfume: 601583\n- last: Number of recent days, e.g., 7, 30 days\n- ecom_type: E-commerce type, default \"l3\"\n- period_type: Period type, default \"last\"\n\n### Return Description:\n- `info`: Product detailed information\n  - `audience_ages`: Audience age distribution\n    - `age_level`: Age value\n    - `score`: Score value\n  - `audience_interests`: Audience interest distribution\n    - `interest_info`: Interest information\n      - `id`: Interest ID\n      - `label`: Interest label\n      - `value`: Interest name\n    - `score`: Score value\n  - `cover_url`: Cover image URL (may be null)\n  - `ecom_type`: E-commerce type\n  - `first_ecom_category`: First-level e-commerce category\n    - `id`: Category ID\n    - `label`: Category label\n    - `value`: Category name\n  - `hashtags`: Popular hashtags list\n  - `posts`: Related posts list\n  - `second_ecom_category`: Second-level e-commerce category\n  - `third_ecom_category`: Third-level e-commerce category\n  - `url_title`: URL title\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_product_detail\",\n  \"params\": {\n    \"id\": \"601583\",\n    \"last\": \"30\",\n    \"ecom_type\": \"l3\",\n    \"period_type\": \"last\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"info\": {\n        \"audience_ages\": [\n          {\n            \"age_level\": 35,\n            \"score\": 27\n          },\n          {\n            \"age_level\": 25,\n            \"score\": 22\n          },\n          {\n            \"age_level\": 18,\n            \"score\": 22\n          },\n          {\n            \"age_level\": 45,\n            \"score\": 18\n          },\n          {\n            \"age_level\": 55,\n            \"score\": 11\n          }\n        ],\n        \"audience_interests\": [\n          {\n            \"interest_info\": {\n              \"id\": \"13105000000\",\n              \"label\": \"label_13105000000\",\n              \"value\": \"Pawn Shops\"\n            },\n            \"score\": 135\n          },\n          {\n            \"interest_info\": {\n              \"id\": \"24104000000\",\n              \"label\": \"label_24104000000\",\n              \"value\": \"Electronics & Electrical\"\n            },\n            \"score\": 127\n          }\n        ],\n        \"cover_url\": null,\n        \"ecom_type\": \"l3\",\n        \"first_ecom_category\": {\n          \"id\": \"601450\",\n          \"label\": \"category_601450\",\n          \"value\": \"Beauty & Personal Care\"\n        },\n        \"hashtags\": [\n          \"vlog\",\n          \"perfumetiktok\",\n          \"perfume\",\n          \"fragrance\",\n          \"fragrancetiktok\"\n        ],\n        \"posts\": [\n          \"7436474042036522248\",\n          \"7486253493716536584\",\n          \"7503974461725740295\"\n        ],\n        \"url_title\": \"Perfume\"\n      }\n    }\n  }\n}\n```","operationId":"get_product_detail_api_v1_tiktok_ads_get_product_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","description":"产品类目ID/Product category ID","title":"Id"},"description":"产品类目ID/Product category ID","example":"601583"},{"name":"last","in":"query","required":false,"schema":{"type":"integer","description":"最近天数/Last days","default":30,"title":"Last"},"description":"最近天数/Last days"},{"name":"ecom_type","in":"query","required":false,"schema":{"type":"string","description":"电商类型/E-commerce type","default":"l3","title":"Ecom Type"},"description":"电商类型/E-commerce type"},{"name":"period_type","in":"query","required":false,"schema":{"type":"string","description":"时间类型/Period type","default":"last","title":"Period Type"},"description":"时间类型/Period type"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_hashtag_filters":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取标签筛选器/Get hashtag filters","description":"# [中文]\n### 用途:\n- 获取热门标签功能的可用筛选选项\n- 了解支持的国家/地区、行业等筛选维度\n- 为标签分析提供筛选参数参考\n\n### 返回内容说明:\n- `country`: 支持的国家/地区列表\n  - `id`: 国家代码\n  - `value`: 国家名称\n- `industry`: 支持的行业列表\n  - `id`: 行业ID\n  - `value`: 行业名称\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_hashtag_filters\",\n  \"params\": {},\n  \"data\": {\n    \"country\": [\n      {\"id\": \"US\", \"value\": \"United States\"},\n      {\"id\": \"UK\", \"value\": \"United Kingdom\"},\n      {\"id\": \"JP\", \"value\": \"Japan\"}\n    ],\n    \"industry\": [\n      {\"id\": \"27000000000\", \"value\": \"Games\"},\n      {\"id\": \"19000000000\", \"value\": \"E-commerce\"},\n      {\"id\": \"10000000000\", \"value\": \"Education\"}\n    ]\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get available filter options for popular hashtag functionality\n- Understand supported countries/regions, industries and other filter dimensions\n- Provide filter parameter reference for hashtag analysis\n\n### Return Description:\n- `country`: List of supported countries/regions\n  - `id`: Country code\n  - `value`: Country name\n- `industry`: List of supported industries\n  - `id`: Industry ID\n  - `value`: Industry name\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_hashtag_filters\",\n  \"params\": {},\n  \"data\": {\n    \"country\": [\n      {\"id\": \"US\", \"value\": \"United States\"},\n      {\"id\": \"UK\", \"value\": \"United Kingdom\"},\n      {\"id\": \"JP\", \"value\": \"Japan\"}\n    ],\n    \"industry\": [\n      {\"id\": \"27000000000\", \"value\": \"Games\"},\n      {\"id\": \"19000000000\", \"value\": \"E-commerce\"},\n      {\"id\": \"10000000000\", \"value\": \"Education\"}\n    ]\n  }\n}\n```","operationId":"get_hashtag_filters_api_v1_tiktok_ads_get_hashtag_filters_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/ads/get_hashtag_creator":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取标签创作者信息/Get hashtag creator info","description":"# [中文]\n### 用途:\n- 获取特定标签的创作者信息和相关数据\n- 了解标签的来源、创建者和使用情况\n- 分析标签的影响力和传播路径\n\n### 参数:\n- hashtag_name: 标签名称，不需要包含#号\n\n### 返回内容说明:\n- `creators`: 创作者列表\n  - `tcm_id`: TCM ID\n  - `user_id`: 用户ID\n  - `nick_name`: 昵称\n  - `avatar_url`: 头像URL\n  - `follower_cnt`: 粉丝数\n  - `liked_cnt`: 获赞总数\n  - `tt_link`: TikTok链接\n  - `tcm_link`: TCM链接\n  - `items`: 作品列表\n    - `item_id`: 作品ID\n    - `cover_url`: 封面URL\n    - `tt_link`: TikTok链接\n    - `vv`: 观看量\n    - `liked_cnt`: 点赞数\n    - `create_time`: 创建时间\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_hashtag_creator\",\n  \"params\": {\n    \"hashtag_name\": \"blowup\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"creators\": [\n        {\n          \"tcm_id\": \"7153957957875531782\",\n          \"user_id\": \"7137978712880088065\",\n          \"nick_name\": \"Ben🎧\",\n          \"avatar_url\": \"https://p16-sign-sg.tiktokcdn.com/tos-alisg-avt-0068/dee2b881a7833ba36ed8811f3116abb2~tplv-tiktokx-cropcenter:100:100.png\",\n          \"follower_cnt\": 1123490,\n          \"liked_cnt\": 45506383,\n          \"tt_link\": \"https://www.tiktok.com/@ur_localnpcs\",\n          \"tcm_link\": \"https://creatormarketplace.tiktok.com/ad#/author/7153957957875531782\",\n          \"items\": [\n            {\n              \"item_id\": \"7484029831462522119\",\n              \"cover_url\": \"https://p16-sign-sg.tiktokcdn.com/tos-alisg-p-0037/oY1c0nzeEOyJAF47RDUI4gBnysS3BVDiEIYfRk~tplv-noop.image\",\n              \"tt_link\": \"https://www.tiktok.com/@author/video/7484029831462522119\",\n              \"vv\": 1068946,\n              \"liked_cnt\": 124292,\n              \"create_time\": 1742511489\n            },\n            {\n              \"item_id\": \"7483385475252751623\",\n              \"cover_url\": \"https://p16-sign-sg.tiktokcdn.com/tos-alisg-p-0037/oUew2qzADECItXAWFYGeoPQftQEZYPjUKLyIuM~tplv-noop.image\",\n              \"tt_link\": \"https://www.tiktok.com/@author/video/7483385475252751623\",\n              \"vv\": 239239,\n              \"liked_cnt\": 16919,\n              \"create_time\": 1742361463\n            }\n          ]\n        }\n      ]\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get creator information and related data for specific hashtags\n- Understand hashtag origin, creator and usage\n- Analyze hashtag influence and spread path\n\n### Parameters:\n- hashtag_name: Hashtag name without # symbol\n\n### Return Description:\n- `creators`: Creator list\n  - `tcm_id`: TCM ID\n  - `user_id`: User ID\n  - `nick_name`: Nickname\n  - `avatar_url`: Avatar URL\n  - `follower_cnt`: Follower count\n  - `liked_cnt`: Total likes received\n  - `tt_link`: TikTok link\n  - `tcm_link`: TCM link\n  - `items`: Items list\n    - `item_id`: Item ID\n    - `cover_url`: Cover URL\n    - `tt_link`: TikTok link\n    - `vv`: View count\n    - `liked_cnt`: Like count\n    - `create_time`: Creation time\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_hashtag_creator\",\n  \"params\": {\n    \"hashtag_name\": \"blowup\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"creators\": [\n        {\n          \"tcm_id\": \"7153957957875531782\",\n          \"user_id\": \"7137978712880088065\",\n          \"nick_name\": \"Ben🎧\",\n          \"avatar_url\": \"https://p16-sign-sg.tiktokcdn.com/tos-alisg-avt-0068/dee2b881a7833ba36ed8811f3116abb2~tplv-tiktokx-cropcenter:100:100.png\",\n          \"follower_cnt\": 1123490,\n          \"liked_cnt\": 45506383,\n          \"tt_link\": \"https://www.tiktok.com/@ur_localnpcs\",\n          \"tcm_link\": \"https://creatormarketplace.tiktok.com/ad#/author/7153957957875531782\",\n          \"items\": [\n            {\n              \"item_id\": \"7484029831462522119\",\n              \"cover_url\": \"https://p16-sign-sg.tiktokcdn.com/tos-alisg-p-0037/oY1c0nzeEOyJAF47RDUI4gBnysS3BVDiEIYfRk~tplv-noop.image\",\n              \"tt_link\": \"https://www.tiktok.com/@author/video/7484029831462522119\",\n              \"vv\": 1068946,\n              \"liked_cnt\": 124292,\n              \"create_time\": 1742511489\n            }\n          ]\n        }\n      ]\n    }\n  }\n}\n```","operationId":"get_hashtag_creator_api_v1_tiktok_ads_get_hashtag_creator_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"hashtag","in":"query","required":true,"schema":{"type":"string","description":"标签名称，不包含#符号/Hashtag name (without # symbol)","title":"Hashtag"},"description":"标签名称，不包含#符号/Hashtag name (without # symbol)","example":"blowup"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_sound_filters":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取音乐筛选器/Get sound filters","description":"# [中文]\n### 用途:\n- 获取热门音乐功能的可用筛选选项\n- 了解不同排行类型下的筛选维度\n- 为音乐选择提供参数参考\n\n### 参数:\n- rank_type: 排行类型，\"popular\"=热门，\"surging\"=上升最快\n\n### 返回内容说明:\n- `country`: 国家列表\n  - `id`: 国家ID\n  - `value`: 国家名称\n  - `label`: 国家标签\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_sound_filters\",\n  \"params\": {\n    \"rank_type\": \"popular\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"country\": [\n        {\n          \"id\": \"AR\",\n          \"value\": \"Argentina\",\n          \"label\": \"AR\"\n        },\n        {\n          \"id\": \"AU\",\n          \"value\": \"Australia\",\n          \"label\": \"AU\"\n        }\n      ]\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get available filter options for popular music functionality\n- Understand filter dimensions for different ranking types\n- Provide parameter reference for music selection\n\n### Parameters:\n- rank_type: Ranking type, \"popular\"=Popular, \"surging\"=Fastest rising\n\n### Return Description:\n- `country`: Country list\n  - `id`: Country ID\n  - `value`: Country name\n  - `label`: Country label\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_sound_filters\",\n  \"params\": {\n    \"rank_type\": \"popular\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"country\": [\n        {\n          \"id\": \"AR\",\n          \"value\": \"Argentina\",\n          \"label\": \"AR\"\n        },\n        {\n          \"id\": \"AU\",\n          \"value\": \"Australia\",\n          \"label\": \"AU\"\n        }\n      ]\n    }\n  }\n}\n```","operationId":"get_sound_filters_api_v1_tiktok_ads_get_sound_filters_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"rank_type","in":"query","required":false,"schema":{"type":"string","description":"排行类型/Rank type (popular, surging)","default":"popular","title":"Rank Type"},"description":"排行类型/Rank type (popular, surging)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_sound_detail":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取音乐详情/Get sound detail","description":"# [中文]\n### 用途:\n- 获取特定音乐的详细信息和使用数据\n- 分析音乐的受众分布、使用趋势等多维度数据\n- 帮助选择合适的背景音乐提升广告效果\n\n### 参数:\n- clip_id: 音乐ID，必填参数\n- period: 时间范围（天），如7、30、120天\n- country_code: 国家代码，如US、UK、JP等\n\n### 返回内容说明:\n- `disliked`: 是否不喜欢（可能为null）\n- `like_count`: 点赞数（可能为null）\n- `liked`: 是否点赞（可能为null）\n- `sound`: 音乐详细信息\n  - `audience_ages`: 受众年龄分布\n    - `age_level`: 年龄级别\n    - `score`: 分数\n  - `audience_countries`: 受众国家分布\n    - `country_info`: 国家信息\n      - `id`: 国家ID\n      - `label`: 国家标签\n      - `value`: 国家名称\n    - `score`: 分数\n  - `audience_interests`: 受众兴趣分布\n    - `interest_info`: 兴趣信息\n    - `score`: 分数\n  - `author`: 音乐作者\n  - `clip_id`: 片段ID\n  - `country_code`: 国家代码\n  - `cover`: 封面图URL\n  - `duration`: 时长（秒）\n  - `if_cml`: 是否商业音乐\n  - `is_search`: 是否搜索结果\n  - `link`: 音乐链接\n  - `longevity`: 持久度信息\n    - `popular_days`: 流行天数\n    - `current_popularity`: 当前流行度\n  - `music_url`: 音乐播放URL（可能为null）\n  - `on_list_times`: 上榜次数（可能为null）\n  - `promoted`: 是否推广\n  - `rank`: 排名（可能为null）\n  - `rank_diff`: 排名变化（可能为null）\n  - `related_items`: 相关视频列表\n    - `item_id`: 视频ID\n    - `cover_uri`: 封面URI\n  - `song_id`: 歌曲ID\n  - `title`: 音乐标题\n  - `trend`: 趋势数据\n    - `time`: 时间戳\n    - `value`: 数值\n  - `url_title`: URL标题\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_sound_detail\",\n  \"params\": {\n    \"clip_id\": \"7251810329461147649\",\n    \"period\": 120,\n    \"country_code\": \"US\"\n  },\n  \"data\": {\n    \"sound\": {\n      \"title\": \"Upbeat Summer Vibes\",\n      \"author\": \"Music Producer\",\n      \"duration\": 30,\n      \"music_url\": \"https://music.tiktok.com/xxx\",\n      \"cover_url\": \"https://p16-sign-sg.tiktokcdn.com/xxx\",\n      \"audience_ages\": [\n        {\"age_level\": \"18-24\", \"percentage\": 45.2},\n        {\"age_level\": \"25-34\", \"percentage\": 32.8}\n      ],\n      \"audience_countries\": [\n        {\"country\": \"US\", \"percentage\": 35.6},\n        {\"country\": \"UK\", \"percentage\": 18.4}\n      ],\n      \"related_items\": [\"7213258221116751874\", \"7213258221116751875\"],\n      \"usage_trend\": [\n        {\"date\": \"2025-01-01\", \"count\": 1234},\n        {\"date\": \"2025-01-02\", \"count\": 1456}\n      ]\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get detailed information and usage data for specific music\n- Analyze multi-dimensional data like audience distribution and usage trends\n- Help select appropriate background music to enhance ad effectiveness\n\n### Parameters:\n- clip_id: Sound clip ID, required parameter\n- period: Time period in days, e.g., 7, 30, 120 days\n- country_code: Country code, e.g., US, UK, JP\n\n### Return Description:\n- `sound`: Sound detailed information\n  - `title`: Music title\n  - `author`: Music author/artist\n  - `duration`: Duration in seconds\n  - `music_url`: Music playback URL\n  - `cover_url`: Cover image URL\n  - `audience_ages`: Audience age distribution\n    - `age_level`: Age range\n    - `percentage`: Share percentage\n  - `audience_countries`: Audience country distribution\n    - `country`: Country code\n    - `percentage`: Share percentage\n  - `related_items`: List of popular video IDs using this music\n  - `usage_trend`: Usage trend data\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_sound_detail\",\n  \"params\": {\n    \"clip_id\": \"7251810329461147649\",\n    \"period\": 120,\n    \"country_code\": \"US\"\n  },\n  \"data\": {\n    \"sound\": {\n      \"title\": \"Upbeat Summer Vibes\",\n      \"author\": \"Music Producer\",\n      \"duration\": 30,\n      \"music_url\": \"https://music.tiktok.com/xxx\",\n      \"cover_url\": \"https://p16-sign-sg.tiktokcdn.com/xxx\",\n      \"audience_ages\": [\n        {\"age_level\": \"18-24\", \"percentage\": 45.2},\n        {\"age_level\": \"25-34\", \"percentage\": 32.8}\n      ],\n      \"audience_countries\": [\n        {\"country\": \"US\", \"percentage\": 35.6},\n        {\"country\": \"UK\", \"percentage\": 18.4}\n      ],\n      \"related_items\": [\"7213258221116751874\", \"7213258221116751875\"],\n      \"usage_trend\": [\n        {\"date\": \"2025-01-01\", \"count\": 1234},\n        {\"date\": \"2025-01-02\", \"count\": 1456}\n      ]\n    }\n  }\n}\n```","operationId":"get_sound_detail_api_v1_tiktok_ads_get_sound_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"clip_id","in":"query","required":true,"schema":{"type":"string","description":"音乐ID/Sound clip ID","title":"Clip Id"},"description":"音乐ID/Sound clip ID","example":"7251810329461147649"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间范围（天）/Time period (days)","default":120,"title":"Period"},"description":"时间范围（天）/Time period (days)"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/search_sound_hint":{"get":{"tags":["TikTok-Ads-API"],"summary":"搜索音乐提示/Search sound hints","description":"# [中文]\n### 用途:\n- 获取音乐搜索的自动完成提示和推荐\n- 帮助用户快速找到相关音乐\n- 提供搜索建议优化音乐选择\n\n### 参数:\n- keyword: 搜索关键词\n- period: 时间范围（天）\n- page: 页码，默认1\n- limit: 每页数量，默认5\n- rank_type: 排行类型，\"popular\"=热门，\"surging\"=上升最快\n- country_code: 国家代码\n- filter_by_checked: 是否只看已验证音乐\n- commercial_music: 是否只看商业音乐\n\n### 返回内容说明:\n- `sound_list`: 音乐提示列表\n  - `title`: 音乐标题\n  - `author`: 音乐作者\n  - `match_type`: 匹配类型（标题/作者/标签）\n  - `popularity`: 热度评分\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/search_sound_hint\",\n  \"params\": {\n    \"keyword\": \"taylor swift\",\n    \"limit\": 5\n  },\n  \"data\": {\n    \"sound_list\": [\n      {\n        \"title\": \"Anti-Hero\",\n        \"author\": \"Taylor Swift\",\n        \"match_type\": \"artist\",\n        \"popularity\": 98\n      },\n      {\n        \"title\": \"Blank Space\",\n        \"author\": \"Taylor Swift\",\n        \"match_type\": \"artist\",\n        \"popularity\": 95\n      }\n    ]\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get auto-complete hints and recommendations for music search\n- Help users quickly find relevant music\n- Provide search suggestions to optimize music selection\n\n### Parameters:\n- keyword: Search keyword\n- period: Time period in days\n- page: Page number, default 1\n- limit: Items per page, default 5\n- rank_type: Ranking type, \"popular\"=Popular, \"surging\"=Fastest rising\n- country_code: Country code\n- filter_by_checked: Only show verified music\n- commercial_music: Only show commercial music\n\n### Return Description:\n- `sound_list`: Music hint list\n  - `title`: Music title\n  - `author`: Music author\n  - `match_type`: Match type (title/artist/tag)\n  - `popularity`: Popularity score\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/search_sound_hint\",\n  \"params\": {\n    \"keyword\": \"taylor swift\",\n    \"limit\": 5\n  },\n  \"data\": {\n    \"sound_list\": [\n      {\n        \"title\": \"Anti-Hero\",\n        \"author\": \"Taylor Swift\",\n        \"match_type\": \"artist\",\n        \"popularity\": 98\n      },\n      {\n        \"title\": \"Blank Space\",\n        \"author\": \"Taylor Swift\",\n        \"match_type\": \"artist\",\n        \"popularity\": 95\n      }\n    ]\n  }\n}\n```","operationId":"search_sound_hint_api_v1_tiktok_ads_search_sound_hint_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"taylor swift"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间范围（天）/Time period (days)","default":7,"title":"Period"},"description":"时间范围（天）/Time period (days)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":5,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"rank_type","in":"query","required":false,"schema":{"type":"string","description":"排行类型/Rank type (popular, surging)","default":"popular","title":"Rank Type"},"description":"排行类型/Rank type (popular, surging)"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"},{"name":"filter_by_checked","in":"query","required":false,"schema":{"type":"boolean","description":"是否只看已验证/Only verified","default":false,"title":"Filter By Checked"},"description":"是否只看已验证/Only verified"},{"name":"commercial_music","in":"query","required":false,"schema":{"type":"boolean","description":"是否商业音乐/Commercial music only","default":false,"title":"Commercial Music"},"description":"是否商业音乐/Commercial music only"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/search_sound":{"get":{"tags":["TikTok-Ads-API"],"summary":"搜索音乐/Search sounds","description":"# [中文]\n### 用途:\n- 搜索符合条件的音乐列表\n- 支持按关键词、热度、商业类型等多维度筛选\n- 为广告配乐选择提供全面的搜索功能\n\n### 参数:\n- keyword: 搜索关键词\n- period: 时间范围（天），如7、30、120天\n- page: 页码，默认1\n- limit: 每页数量，默认20\n- rank_type: 排行类型，\"popular\"=热门，\"surging\"=上升最快\n- new_on_board: 是否只看新上榜音乐\n- commercial_music: 是否只看商业音乐\n- country_code: 国家代码\n\n### 返回内容说明:\n- `sound_list`: 音乐列表\n  - `id`: 音乐ID\n  - `title`: 音乐标题\n  - `author`: 音乐作者\n  - `duration`: 时长（秒）\n  - `trend`: 趋势数据\n  - `related_items`: 使用该音乐的视频数量\n  - `is_commercial`: 是否商业音乐\n- `pagination`: 分页信息\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/search_sound\",\n  \"params\": {\n    \"keyword\": \"taylor swift\",\n    \"period\": 7,\n    \"page\": 1\n  },\n  \"data\": {\n    \"sound_list\": [\n      {\n        \"id\": \"7156826385225353217\",\n        \"title\": \"Karma\",\n        \"author\": \"Taylor Swift\",\n        \"duration\": 30,\n        \"trend\": [\n          {\"time\": 1746000000, \"value\": 15000}\n        ],\n        \"related_items\": 5678,\n        \"is_commercial\": true\n      }\n    ],\n    \"pagination\": {\n      \"page\": 1,\n      \"size\": 20,\n      \"total\": 156,\n      \"has_more\": true\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Search for music lists matching criteria\n- Support multi-dimensional filtering by keyword, popularity, commercial type, etc.\n- Provide comprehensive search functionality for ad soundtrack selection\n\n### Parameters:\n- keyword: Search keyword\n- period: Time period in days, e.g., 7, 30, 120 days\n- page: Page number, default 1\n- limit: Items per page, default 20\n- rank_type: Ranking type, \"popular\"=Popular, \"surging\"=Fastest rising\n- new_on_board: Only show newly trending music\n- commercial_music: Only show commercial music\n- country_code: Country code\n\n### Return Description:\n- `sound_list`: Music list\n  - `id`: Music ID\n  - `title`: Music title\n  - `author`: Music author\n  - `duration`: Duration in seconds\n  - `trend`: Trend data\n  - `related_items`: Number of videos using this music\n  - `is_commercial`: Whether commercial music\n- `pagination`: Pagination info\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/search_sound\",\n  \"params\": {\n    \"keyword\": \"taylor swift\",\n    \"period\": 7,\n    \"page\": 1\n  },\n  \"data\": {\n    \"sound_list\": [\n      {\n        \"id\": \"7156826385225353217\",\n        \"title\": \"Karma\",\n        \"author\": \"Taylor Swift\",\n        \"duration\": 30,\n        \"trend\": [\n          {\"time\": 1746000000, \"value\": 15000}\n        ],\n        \"related_items\": 5678,\n        \"is_commercial\": true\n      }\n    ],\n    \"pagination\": {\n      \"page\": 1,\n      \"size\": 20,\n      \"total\": 156,\n      \"has_more\": true\n    }\n  }\n}\n```","operationId":"search_sound_api_v1_tiktok_ads_search_sound_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"taylor swift"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间范围（天）/Time period (days)","default":7,"title":"Period"},"description":"时间范围（天）/Time period (days)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"rank_type","in":"query","required":false,"schema":{"type":"string","description":"排行类型/Rank type (popular, surging)","default":"popular","title":"Rank Type"},"description":"排行类型/Rank type (popular, surging)"},{"name":"new_on_board","in":"query","required":false,"schema":{"type":"boolean","description":"是否只看新上榜/Only new on board","default":false,"title":"New On Board"},"description":"是否只看新上榜/Only new on board"},{"name":"commercial_music","in":"query","required":false,"schema":{"type":"boolean","description":"是否商业音乐/Commercial music only","default":false,"title":"Commercial Music"},"description":"是否商业音乐/Commercial music only"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_sound_recommendations":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取音乐推荐/Get sound recommendations","description":"# [中文]\n### 用途:\n- 基于指定音乐获取相似的推荐音乐\n- 发现风格相近或使用场景类似的音乐\n- 扩展音乐选择范围，找到更多合适的配乐\n\n### 参数:\n- clip_id: 参考音乐ID，必填参数\n- limit: 推荐数量，默认6\n\n### 返回内容说明:\n- `musics`: 推荐音乐列表\n  - `author`: 音乐作者\n  - `cover`: 封面图URL\n  - `music_id`: 音乐ID\n  - `music_url`: 音乐播放URL\n  - `title`: 音乐标题\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_sound_recommendations\",\n  \"params\": {\n    \"clip_id\": \"7156826385225353217\",\n    \"limit\": \"6\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"musics\": [\n        {\n          \"author\": \"zomap\",\n          \"cover\": \"https://p16-sg-default.akamaized.net/aweme/720x720/tiktok-obj/6f9903752958820d144fa90d54cb5f3a.png.jpeg\",\n          \"music_id\": \"6949146013727653889\",\n          \"music_url\": \"https://sf16-sg-default.akamaized.net/obj/tiktok-obj/d0d0dca4400886718099898494b7e31b.mp3\",\n          \"title\": \"Relaxed and gentle fashionable chillout(810161)\"\n        },\n        {\n          \"author\": \"zomap\",\n          \"cover\": \"https://p16-sg-default.akamaized.net/aweme/720x720/tiktok-obj/6f9903752958820d144fa90d54cb5f3a.png.jpeg\",\n          \"music_id\": \"6949294080044843010\",\n          \"music_url\": \"https://sf16-sg-default.akamaized.net/obj/tiktok-obj/451acbadd83a76748a99878ccfef2df5.mp3\",\n          \"title\": \"Relaxed and gentle fashionable chillout(816672)\"\n        }\n      ]\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get similar music recommendations based on specified music\n- Discover music with similar styles or usage scenarios\n- Expand music selection range to find more suitable soundtracks\n\n### Parameters:\n- clip_id: Reference sound clip ID, required parameter\n- limit: Number of recommendations, default 6\n\n### Return Description:\n- `musics`: Recommended music list\n  - `author`: Music author\n  - `cover`: Cover image URL\n  - `music_id`: Music ID\n  - `music_url`: Music playback URL\n  - `title`: Music title\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_sound_recommendations\",\n  \"params\": {\n    \"clip_id\": \"7156826385225353217\",\n    \"limit\": 6\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"musics\": [\n        {\n          \"author\": \"zomap\",\n          \"cover\": \"https://p16-sg-default.akamaized.net/aweme/720x720/tiktok-obj/6f9903752958820d144fa90d54cb5f3a.png.jpeg\",\n          \"music_id\": \"6949146013727653889\",\n          \"music_url\": \"https://sf16-sg-default.akamaized.net/obj/tiktok-obj/d0d0dca4400886718099898494b7e31b.mp3\",\n          \"title\": \"Relaxed and gentle fashionable chillout(810161)\"\n        },\n        {\n          \"author\": \"zomap\",\n          \"cover\": \"https://p16-sg-default.akamaized.net/aweme/720x720/tiktok-obj/6f9903752958820d144fa90d54cb5f3a.png.jpeg\",\n          \"music_id\": \"6949294080044843010\",\n          \"music_url\": \"https://sf16-sg-default.akamaized.net/obj/tiktok-obj/451acbadd83a76748a99878ccfef2df5.mp3\",\n          \"title\": \"Relaxed and gentle fashionable chillout(816672)\"\n        }\n      ]\n    }\n  }\n}\n```","operationId":"get_sound_recommendations_api_v1_tiktok_ads_get_sound_recommendations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"clip_id","in":"query","required":true,"schema":{"type":"string","description":"参考音乐ID/Reference sound clip ID","title":"Clip Id"},"description":"参考音乐ID/Reference sound clip ID","example":"7156826385225353217"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"推荐数量/Number of recommendations","default":6,"title":"Limit"},"description":"推荐数量/Number of recommendations"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_creator_filters":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取创作者筛选器/Get creator filters","description":"# [中文]\n### 用途:\n- 获取创作者搜索和筛选的可用选项\n- 了解支持的国家、排序方式等筛选维度\n- 为创作者分析提供参数参考\n\n### 返回内容说明:\n- `audience_country`: 受众国家列表\n  - `id`: 国家代码\n  - `value`: 国家名称\n- `creator_country`: 创作者所在国家列表\n- `sort_by`: 支持的排序方式\n  - follower: 按粉丝数排序\n  - engagement: 按互动率排序\n  - avg_views: 按平均观看量排序\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_creator_filters\",\n  \"params\": {},\n  \"data\": {\n    \"audience_country\": [\n      {\"id\": \"US\", \"value\": \"United States\"},\n      {\"id\": \"UK\", \"value\": \"United Kingdom\"}\n    ],\n    \"creator_country\": [\n      {\"id\": \"US\", \"value\": \"United States\"},\n      {\"id\": \"UK\", \"value\": \"United Kingdom\"}\n    ],\n    \"sort_by\": [\"follower\", \"engagement\", \"avg_views\"]\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get available options for creator search and filtering\n- Understand supported countries, sorting methods and other filter dimensions\n- Provide parameter reference for creator analysis\n\n### Return Description:\n- `audience_country`: Audience country list\n  - `id`: Country code\n  - `value`: Country name\n- `creator_country`: Creator country list\n- `sort_by`: Supported sorting methods\n  - follower: Sort by follower count\n  - engagement: Sort by engagement rate\n  - avg_views: Sort by average views\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_creator_filters\",\n  \"params\": {},\n  \"data\": {\n    \"audience_country\": [\n      {\"id\": \"US\", \"value\": \"United States\"},\n      {\"id\": \"UK\", \"value\": \"United Kingdom\"}\n    ],\n    \"creator_country\": [\n      {\"id\": \"US\", \"value\": \"United States\"},\n      {\"id\": \"UK\", \"value\": \"United Kingdom\"}\n    ],\n    \"sort_by\": [\"follower\", \"engagement\", \"avg_views\"]\n  }\n}\n```","operationId":"get_creator_filters_api_v1_tiktok_ads_get_creator_filters_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/ads/get_creator_list":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取创作者列表/Get creator list","description":"# [中文]\n### 用途:\n- 获取符合条件的创作者列表，包括粉丝数、互动率等数据\n- 发现高质量的广告合作创作者\n- 分析不同类型创作者的表现和特点\n\n### 参数:\n- page: 页码，默认1\n- limit: 每页数量，默认20\n- sort_by: 排序方式\n  - follower: 按粉丝数排序\n  - engagement: 按互动率排序\n  - avg_views: 按平均观看量排序\n- creator_country: 创作者所在国家\n- audience_country: 受众所在国家（可选）\n- audience_count: 受众数量筛选（可选）\n\n### 返回内容说明:\n- `creators`: 创作者列表\n  - `tcm_id`: TCM ID\n  - `user_id`: 用户ID\n  - `nick_name`: 昵称\n  - `avatar_url`: 头像URL\n  - `country_code`: 国家代码\n  - `follower_cnt`: 粉丝数\n  - `liked_cnt`: 获赞总数\n  - `tt_link`: TikTok链接\n  - `tcm_link`: TCM链接\n  - `items`: 作品列表\n    - `item_id`: 作品ID\n    - `cover_url`: 封面URL\n    - `tt_link`: TikTok链接\n    - `vv`: 观看量\n    - `liked_cnt`: 点赞数\n    - `create_time`: 创建时间\n- `pagination`: 分页信息\n  - `page`: 当前页\n  - `size`: 每页数量\n  - `total`: 总数量\n  - `has_more`: 是否有更多\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_creator_list\",\n  \"params\": {\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"sort_by\": \"follower\",\n    \"creator_country\": \"US\",\n    \"audience_country\": \"\",\n    \"audience_count\": \"0\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"creators\": [\n        {\n          \"tcm_id\": \"7414477993612935173\",\n          \"user_id\": \"62133858422239232\",\n          \"nick_name\": \"Fernanda\",\n          \"avatar_url\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/200b649d30f76f1238d771f4aff51ee1~tplv-tiktokx-cropcenter:100:100.png\",\n          \"country_code\": \"US\",\n          \"follower_cnt\": 9135515,\n          \"liked_cnt\": 668294555,\n          \"tt_link\": \"https://www.tiktok.com/@ferchugimenez\",\n          \"tcm_link\": \"https://creatormarketplace.tiktok.com/ad#/author/7414477993612935173\",\n          \"items\": [\n            {\n              \"item_id\": \"7444674312784645432\",\n              \"cover_url\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/oQIBhn2EeBMUWQR5wVQACFEBtlDxgUDdAfoB8J~tplv-noop.image\",\n              \"tt_link\": \"https://www.tiktok.com/@author/video/7444674312784645432\",\n              \"vv\": 13733332,\n              \"liked_cnt\": 516217,\n              \"create_time\": 1733348322\n            }\n          ]\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 459,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get a list of creators matching criteria, including follower count, engagement rate, etc.\n- Discover high-quality creators for ad collaboration\n- Analyze performance and characteristics of different creator types\n\n### Parameters:\n- page: Page number, default 1\n- limit: Items per page, default 20\n- sort_by: Sorting method\n  - follower: Sort by follower count\n  - engagement: Sort by engagement rate\n  - avg_views: Sort by average views\n- creator_country: Creator's country\n- audience_country: Audience country (optional)\n- audience_count: Audience count filter (optional)\n\n### Return Description:\n- `creators`: Creator list\n  - `tcm_id`: TikTok Creator Marketplace ID\n  - `user_id`: User ID\n  - `nick_name`: Nickname\n  - `avatar_url`: Avatar URL\n  - `country_code`: Country code\n  - `follower_cnt`: Follower count\n  - `liked_cnt`: Total likes count\n  - `tt_link`: TikTok profile link\n  - `tcm_link`: Creator marketplace link\n  - `items`: Video list\n    - `item_id`: Video ID\n    - `cover_url`: Cover image URL\n    - `tt_link`: Video link\n    - `vv`: View count\n    - `liked_cnt`: Like count\n    - `create_time`: Creation timestamp\n- `pagination`: Pagination info\n  - `page`: Current page\n  - `size`: Items per page\n  - `total`: Total count\n  - `has_more`: Has more pages\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_creator_list\",\n  \"params\": {\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"sort_by\": \"follower\",\n    \"creator_country\": \"US\",\n    \"audience_country\": \"\",\n    \"audience_count\": \"0\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"creators\": [\n        {\n          \"tcm_id\": \"7414477993612935173\",\n          \"user_id\": \"62133858422239232\",\n          \"nick_name\": \"Fernanda\",\n          \"avatar_url\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/200b649d30f76f1238d771f4aff51ee1~tplv-tiktokx-cropcenter:100:100.png\",\n          \"country_code\": \"US\",\n          \"follower_cnt\": 9135515,\n          \"liked_cnt\": 668294555,\n          \"tt_link\": \"https://www.tiktok.com/@ferchugimenez\",\n          \"tcm_link\": \"https://creatormarketplace.tiktok.com/ad#/author/7414477993612935173\",\n          \"items\": [\n            {\n              \"item_id\": \"7444674312784645432\",\n              \"cover_url\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/oQIBhn2EeBMUWQR5wVQACFEBtlDxgUDdAfoB8J~tplv-noop.image\",\n              \"tt_link\": \"https://www.tiktok.com/@author/video/7444674312784645432\",\n              \"vv\": 13733332,\n              \"liked_cnt\": 516217,\n              \"create_time\": 1733348322\n            }\n          ]\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 459,\n        \"has_more\": true\n      }\n    }\n  }\n}\n```","operationId":"get_creator_list_api_v1_tiktok_ads_get_creator_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort by (follower, engagement, avg_views)","default":"follower","title":"Sort By"},"description":"排序方式/Sort by (follower, engagement, avg_views)"},{"name":"creator_country","in":"query","required":false,"schema":{"type":"string","description":"创作者国家/Creator country","default":"US","title":"Creator Country"},"description":"创作者国家/Creator country"},{"name":"audience_country","in":"query","required":false,"schema":{"type":"string","description":"受众国家/Audience country","default":"","title":"Audience Country"},"description":"受众国家/Audience country"},{"name":"audience_count","in":"query","required":false,"schema":{"type":"integer","description":"受众数量筛选/Audience count filter","default":0,"title":"Audience Count"},"description":"受众数量筛选/Audience count filter"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/search_creators":{"get":{"tags":["TikTok-Ads-API"],"summary":"搜索创作者/Search creators","description":"# [中文]\n### 用途:\n- 通过关键词搜索创作者\n- 快速找到特定领域或名称的创作者\n- 支持按粉丝数或平均观看量排序\n\n### 参数:\n- keyword: 搜索关键词，可以是用户名、昵称的一部分\n- page: 页码，默认1\n- limit: 每页数量，默认20\n- sort_by: 排序方式\n  - follower: 按粉丝数排序\n  - avg_views: 按平均观看量排序\n- creator_country: 创作者所在国家\n\n### 返回内容说明:\n- `creators`: 创作者列表\n  - `tcm_id`: 创作者市场ID\n  - `user_id`: 用户ID\n  - `nick_name`: 昵称\n  - `avatar_url`: 头像URL\n  - `country_code`: 国家代码\n  - `follower_cnt`: 粉丝数\n  - `liked_cnt`: 总点赞数\n  - `tt_link`: TikTok个人主页链接\n  - `tcm_link`: 创作者市场链接\n  - `items`: 作品列表\n    - `item_id`: 作品ID\n    - `cover_url`: 封面URL\n    - `tt_link`: 作品链接\n    - `vv`: 观看量\n    - `liked_cnt`: 点赞数\n    - `create_time`: 创建时间戳\n- `pagination`: 分页信息\n  - `page`: 当前页码\n  - `size`: 每页数量\n  - `total`: 总数\n  - `has_more`: 是否有更多\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/search_creators\",\n  \"params\": {\n    \"keyword\": \"jo\",\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"sort_by\": \"follower\",\n    \"creator_country\": \"US\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"creators\": [\n        {\n          \"tcm_id\": \"6894787532572065797\",\n          \"user_id\": \"6684747467718820870\",\n          \"nick_name\": \"Josh Zilberberg\",\n          \"avatar_url\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/f11c960c637601225c29d6e7849069eb~tplv-tiktokx-cropcenter:100:100.png\",\n          \"country_code\": \"US\",\n          \"follower_cnt\": 3048368,\n          \"liked_cnt\": 130131619,\n          \"tt_link\": \"https://www.tiktok.com/@josh.zilberberg\",\n          \"tcm_link\": \"https://creatormarketplace.tiktok.com/ad#/author/6894787532572065797\",\n          \"items\": [\n            {\n              \"item_id\": \"7406005139112283397\",\n              \"cover_url\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/6e0c79311c2b49758674ae64721c495b_1724344961~tplv-noop.image\",\n              \"tt_link\": \"https://www.tiktok.com/@author/video/7406005139112283397\",\n              \"vv\": 3266905,\n              \"liked_cnt\": 4057,\n              \"create_time\": 1724344950\n            }\n          ]\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 6,\n        \"has_more\": false\n      }\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Search creators by keyword\n- Quickly find creators in specific fields or with specific names\n- Support sorting by follower count or average views\n\n### Parameters:\n- keyword: Search keyword, can be part of username or nickname\n- page: Page number, default 1\n- limit: Items per page, default 20\n- sort_by: Sorting method\n  - follower: Sort by follower count\n  - avg_views: Sort by average views\n- creator_country: Creator's country\n\n### Return Description:\n- `creators`: Creator list\n  - `tcm_id`: TikTok Creator Marketplace ID\n  - `user_id`: User ID\n  - `nick_name`: Nickname\n  - `avatar_url`: Avatar URL\n  - `country_code`: Country code\n  - `follower_cnt`: Follower count\n  - `liked_cnt`: Total likes count\n  - `tt_link`: TikTok profile link\n  - `tcm_link`: Creator marketplace link\n  - `items`: Video list\n    - `item_id`: Video ID\n    - `cover_url`: Cover image URL\n    - `tt_link`: Video link\n    - `vv`: View count\n    - `liked_cnt`: Like count\n    - `create_time`: Creation timestamp\n- `pagination`: Pagination info\n  - `page`: Current page\n  - `size`: Items per page\n  - `total`: Total count\n  - `has_more`: Has more pages\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/search_creators\",\n  \"params\": {\n    \"keyword\": \"jo\",\n    \"page\": \"1\",\n    \"limit\": \"20\",\n    \"sort_by\": \"follower\",\n    \"creator_country\": \"US\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"creators\": [\n        {\n          \"tcm_id\": \"6894787532572065797\",\n          \"user_id\": \"6684747467718820870\",\n          \"nick_name\": \"Josh Zilberberg\",\n          \"avatar_url\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/f11c960c637601225c29d6e7849069eb~tplv-tiktokx-cropcenter:100:100.png\",\n          \"country_code\": \"US\",\n          \"follower_cnt\": 3048368,\n          \"liked_cnt\": 130131619,\n          \"tt_link\": \"https://www.tiktok.com/@josh.zilberberg\",\n          \"tcm_link\": \"https://creatormarketplace.tiktok.com/ad#/author/6894787532572065797\",\n          \"items\": [\n            {\n              \"item_id\": \"7406005139112283397\",\n              \"cover_url\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068/6e0c79311c2b49758674ae64721c495b_1724344961~tplv-noop.image\",\n              \"tt_link\": \"https://www.tiktok.com/@author/video/7406005139112283397\",\n              \"vv\": 3266905,\n              \"liked_cnt\": 4057,\n              \"create_time\": 1724344950\n            }\n          ]\n        }\n      ],\n      \"pagination\": {\n        \"page\": 1,\n        \"size\": 20,\n        \"total\": 6,\n        \"has_more\": false\n      }\n    }\n  }\n}\n```","operationId":"search_creators_api_v1_tiktok_ads_search_creators_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"jo"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":20,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort by (follower, avg_views)","default":"follower","title":"Sort By"},"description":"排序方式/Sort by (follower, avg_views)"},{"name":"creator_country","in":"query","required":false,"schema":{"type":"string","description":"创作者国家/Creator country","default":"US","title":"Creator Country"},"description":"创作者国家/Creator country"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/ads/get_popular_trends":{"get":{"tags":["TikTok-Ads-API"],"summary":"获取流行趋势视频/Get popular trend videos","description":"# [中文]\n### 用途:\n- 获取指定时间段内的流行趋势视频\n- 了解当前热门内容的特点和趋势\n- 为广告创意提供灵感和参考\n\n### 参数:\n- period: 时间范围（天），如7、30天\n- page: 页码，默认1\n- limit: 每页数量，默认10\n- order_by: 排序字段\n  - vv: 按观看量排序\n  - like: 按点赞数排序\n  - comment: 按评论数排序\n  - repost: 按转发数排序\n- country_code: 国家代码\n\n### 返回内容说明:\n- `pagination`: 分页信息\n  - `has_more`: 是否有更多\n  - `limit`: 每页数量\n  - `page`: 当前页\n  - `total_count`: 总数量\n- `videos`: 趋势视频列表\n  - `country_code`: 国家代码\n  - `cover`: 封面图URL\n  - `duration`: 时长（秒）\n  - `id`: 视频ID\n  - `item_id`: 视频项目ID\n  - `item_url`: 视频链接\n  - `region`: 地区\n  - `title`: 视频标题\n\n### 示例响应:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_popular_trends\",\n  \"params\": {\n    \"period\": \"7\",\n    \"page\": \"1\",\n    \"limit\": \"10\",\n    \"order_by\": \"vv\",\n    \"country_code\": \"US\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"pagination\": {\n        \"has_more\": true,\n        \"limit\": 10,\n        \"page\": 1,\n        \"total_count\": 500\n      },\n      \"videos\": [\n        {\n          \"country_code\": \"US\",\n          \"cover\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068c799-us/osAmHI2QkEfCyjJI57DfCFPhVDQJqnImEusfHA~tplv-noop.image\",\n          \"duration\": 15,\n          \"id\": \"7512918118663081262\",\n          \"item_id\": \"7512918118663081262\",\n          \"item_url\": \"https://www.tiktok.com/@mnm_pipi/video/7512918118663081262\",\n          \"region\": \"United States\",\n          \"title\": \"We've lowered MSRP on Rogue and Pathfinder, because Nissan is here for you.\"\n        },\n        {\n          \"country_code\": \"US\",\n          \"cover\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068c799-us/ocQjW3QOfqt0seM0CA8gWfAqC5I2BO1LIkjQUI~tplv-noop.image\",\n          \"duration\": 15,\n          \"id\": \"7514018454932835615\",\n          \"item_id\": \"7514018454932835615\",\n          \"item_url\": \"https://www.tiktok.com/@mnm_pipi/video/7514018454932835615\",\n          \"region\": \"United States\",\n          \"title\": \"Wanna see something gorgeous? Apple's new look is coming soon. Learn more at www.apple.com/os/. #LiquidGlass #WWDC25 #Apple #iOS26 #macOS26\"\n        }\n      ]\n    }\n  }\n}\n```\n\n# [English]\n### Purpose:\n- Get popular trend videos for specified time period\n- Understand characteristics and trends of current hot content\n- Provide inspiration and reference for ad creativity\n\n### Parameters:\n- period: Time period in days, e.g., 7, 30 days\n- page: Page number, default 1\n- limit: Items per page, default 10\n- order_by: Sort field\n  - vv: Sort by view count\n  - like: Sort by like count\n  - comment: Sort by comment count\n  - repost: Sort by repost count\n- country_code: Country code\n\n### Return Description:\n- `pagination`: Pagination info\n  - `has_more`: Has more pages\n  - `limit`: Items per page\n  - `page`: Current page\n  - `total_count`: Total count\n- `videos`: Trend video list\n  - `country_code`: Country code\n  - `cover`: Cover image URL\n  - `duration`: Duration in seconds\n  - `id`: Video ID\n  - `item_id`: Video item ID\n  - `item_url`: Video link\n  - `region`: Region name\n  - `title`: Video title\n\n### Example Response:\n```json\n{\n  \"code\": 200,\n  \"router\": \"/api/v1/tiktok/ads/get_popular_trends\",\n  \"params\": {\n    \"period\": \"7\",\n    \"page\": \"1\",\n    \"limit\": \"10\",\n    \"order_by\": \"vv\",\n    \"country_code\": \"US\"\n  },\n  \"data\": {\n    \"code\": 0,\n    \"msg\": \"OK\",\n    \"data\": {\n      \"pagination\": {\n        \"has_more\": true,\n        \"limit\": 10,\n        \"page\": 1,\n        \"total_count\": 500\n      },\n      \"videos\": [\n        {\n          \"country_code\": \"US\",\n          \"cover\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068c799-us/osAmHI2QkEfCyjJI57DfCFPhVDQJqnImEusfHA~tplv-noop.image\",\n          \"duration\": 15,\n          \"id\": \"7512918118663081262\",\n          \"item_id\": \"7512918118663081262\",\n          \"item_url\": \"https://www.tiktok.com/@mnm_pipi/video/7512918118663081262\",\n          \"region\": \"United States\",\n          \"title\": \"We've lowered MSRP on Rogue and Pathfinder, because Nissan is here for you.\"\n        },\n        {\n          \"country_code\": \"US\",\n          \"cover\": \"https://p16-sign-va.tiktokcdn.com/tos-maliva-p-0068c799-us/ocQjW3QOfqt0seM0CA8gWfAqC5I2BO1LIkjQUI~tplv-noop.image\",\n          \"duration\": 15,\n          \"id\": \"7514018454932835615\",\n          \"item_id\": \"7514018454932835615\",\n          \"item_url\": \"https://www.tiktok.com/@mnm_pipi/video/7514018454932835615\",\n          \"region\": \"United States\",\n          \"title\": \"Wanna see something gorgeous? Apple's new look is coming soon. Learn more at www.apple.com/os/. #LiquidGlass #WWDC25 #Apple #iOS26 #macOS26\"\n        }\n      ]\n    }\n  }\n}\n```","operationId":"get_popular_trends_api_v1_tiktok_ads_get_popular_trends_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"时间范围（天）/Time period (days)","default":7,"title":"Period"},"description":"时间范围（天）/Time period (days)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":10,"title":"Limit"},"description":"每页数量/Items per page"},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"排序字段/Order by (vv, like, comment, repost)","default":"vv","title":"Order By"},"description":"排序字段/Order by (vv, like, comment, repost)"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"US","title":"Country Code"},"description":"国家代码/Country code"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_product_detail":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取商品详情V1(桌面端-数据完整)/Get product detail V1(Full data)","description":"# [中文]\n### 用途:\n- 获取TikTok Shop商品的详细信息\n- 包含商品基本信息、价格、库存、评价、推荐商品等完整数据\n- 某些特殊地区的商品可能无法获取到数据（如：泰国），如果遇到此情况请尝试使用 `fetch_product_detail_v3` 接口\n### 参数:\n- seller_id: 卖家ID (可传空字符串)\n- product_id: 商品ID (必填)\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"global_fe_config\": {},      // 全局前端配置\n        \"components_map\": [],         // 组件映射列表\n        \"global_data\": {              // 全局数据\n            \"product_info\": {},       // 商品信息\n            \"seller_info\": {},        // 卖家信息\n            \"shipping_info\": {},      // 物流信息\n            \"review_info\": {}         // 评价信息\n        }\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Get detailed information of TikTok Shop products\n- Contains complete data including basic info, price, stock, reviews, recommendations\n- Some products from specific regions may not be accessible (e.g., Thailand); if so, try using `fetch_product_detail_v3`\n### Parameters:\n- seller_id: Seller ID (can be empty string)\n- product_id: Product ID (required)\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"global_fe_config\": {},      // Global frontend config\n        \"components_map\": [],         // Component mapping list\n        \"global_data\": {              // Global data\n            \"product_info\": {},       // Product information\n            \"seller_info\": {},        // Seller information\n            \"shipping_info\": {},      // Shipping information\n            \"review_info\": {}         // Review information\n        }\n    }\n}\n```\n\n# [示例/Example]\nseller_id = \"7494629757824764402\"\nproduct_id = \"1729556436942358002\"\nregion = \"MY\"","operationId":"fetch_product_detail_api_v1_tiktok_shop_web_fetch_product_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"1729556436942358002"},{"name":"seller_id","in":"query","required":false,"schema":{"type":"string","description":"卖家ID(可选)/Seller ID (optional)","default":"","title":"Seller Id"},"description":"卖家ID(可选)/Seller ID (optional)","example":"7494629757824764402"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"MY","title":"Region"},"description":"地区代码/Region code","example":"MY"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_product_detail_v2":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取商品详情V2(移动端-数据少)/Get product detail V2 (Less Data)","description":"# [中文]\n### 用途:\n- 获取TikTok Shop商品详情(移动端接口)\n- 数据结构更精简，响应速度更快\n- 此接口返回的数据更少，如果需要更完整的数据请使用 `fetch_product_detail` 或 `fetch_product_detail_v3` 接口\n### 参数:\n- seller_id: 卖家ID (可传空字符串)\n- product_id: 商品ID (必填)\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"productDetailSchema\": {},    // 商品详细信息\n        \"productCategoryInfoSchema\": {}, // 分类信息\n        \"pdpRelatedKwSchema\": [],     // 相关关键词\n        \"productsForComponentListSchema\": [] // 推荐商品组件\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Get TikTok Shop product details (Mobile API)\n- More streamlined data structure with faster response\n- This API returns less data; for more complete data, use `fetch_product_detail` or `fetch_product_detail_v3`\n### Parameters:\n- seller_id: Seller ID (can be empty string)\n- product_id: Product ID (required)\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"productDetailSchema\": {},    // Product details\n        \"productCategoryInfoSchema\": {}, // Category info\n        \"pdpRelatedKwSchema\": [],     // Related keywords\n        \"productsForComponentListSchema\": [] // Recommended product components\n    }\n}\n```\n\n# [示例/Example]\nseller_id = \"7494629757824764402\"\nproduct_id = \"1729556436942358002\"\nregion = \"MY\"","operationId":"fetch_product_detail_v2_api_v1_tiktok_shop_web_fetch_product_detail_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"1729556436942358002"},{"name":"seller_id","in":"query","required":false,"schema":{"type":"string","description":"卖家ID(可选)/Seller ID (optional)","default":"","title":"Seller Id"},"description":"卖家ID(可选)/Seller ID (optional)","example":"7494629757824764402"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"MY","title":"Region"},"description":"地区代码/Region code","example":"MY"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_product_detail_v3":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取商品详情V3(移动端-数据完整)/Get product detail V3 (Full Data)","description":"# [中文]\n### 用途:\n- 获取TikTok Shop商品详情\n- 提供最完整的商品信息，包括推荐商品、相关视频、店铺信息等\n- 适用于所有地区的商品\n### 参数:\n- product_id: 商品ID (必填)\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- **请务必确保 `product_id` 对应的 `region` 是正确的，否则接口将不会返回数据。**\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 200,\n    \"data\": {\n        \"productInfo\": {},                           // 商品详细信息\n        \"frequentlyBoughtTogether\": [],              // 经常一起购买的商品\n        \"similarProductsInCategory\": [],             // 同类别相似商品\n        \"exploreMoreFromShop\": [],                   // 店铺更多商品\n        \"brandInCategoryRecommendedProducts\": [],    // 品牌分类推荐商品\n        \"customersAlsoBought\": [],                   // 顾客还购买了\n        \"moreInThisColorStyle\": [],                  // 更多颜色款式\n        \"relatedVideos\": [],                         // 相关视频\n        \"shopPerformance\": {},                       // 店铺表现\n        \"categoryInfo\": {},                          // 分类信息\n        \"searchRecommendWords\": [],                  // 搜索推荐词\n        \"randomSearchWord\": \"\",                      // 随机搜索词\n        \"shopInfo\": {},                              // 店铺信息\n        \"shopHotReviews\": []                         // 店铺热门评论\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Get TikTok Shop product details\n- Provides the most complete product information including recommendations, videos, shop info, etc.\n- Suitable for products from all regions\n### Parameters:\n- product_id: Product ID (required)\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- **Please ensure that the `region` matches the actual region of the `product_id`, otherwise the API will not return any data.**\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 200,\n    \"data\": {\n        \"productInfo\": {},                           // Product details\n        \"frequentlyBoughtTogether\": [],              // Frequently bought together\n        \"similarProductsInCategory\": [],             // Similar products in category\n        \"exploreMoreFromShop\": [],                   // More from shop\n        \"brandInCategoryRecommendedProducts\": [],    // Brand category recommendations\n        \"customersAlsoBought\": [],                   // Customers also bought\n        \"moreInThisColorStyle\": [],                  // More colors/styles\n        \"relatedVideos\": [],                         // Related videos\n        \"shopPerformance\": {},                       // Shop performance\n        \"categoryInfo\": {},                          // Category info\n        \"searchRecommendWords\": [],                  // Search recommendation words\n        \"randomSearchWord\": \"\",                      // Random search word\n        \"shopInfo\": {},                              // Shop information\n        \"shopHotReviews\": []                         // Shop hot reviews\n    }\n}\n```\n\n# [示例/Example]\nproduct_id = \"1732108663255959373\"\nregion = \"SG\"","operationId":"fetch_product_detail_v3_api_v1_tiktok_shop_web_fetch_product_detail_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"1732108663255959373"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"SG","title":"Region"},"description":"地区代码/Region code","example":"SG"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_product_reviews_v1":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取商品评论V1/Get product reviews V1","description":"# [中文]\n### 用途:\n- 获取TikTok Shop商品的评论列表（支持所有国家区域的商品，无需指定地区代码）\n- 支持按相关性或时间排序\n- 支持评论筛选和分页加载\n### 参数:\n- product_id: 商品ID (必填)\n- sort_type: 排序方式\n    - 1: 按相关性排序\n    - 2: 按时间排序(最新)，默认值\n- filter_id: 评论筛选ID (可选)\n    - 可从首次响应的 review_filters 列表中获取\n- offset: 分页偏移量，默认1\n    - 如果响应中 has_more=1，使用 next_cursor 值进行下一页请求\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 200,\n    \"data\": {\n        \"reviews\": [                      // 评论列表(每页20条)\n            {\n                \"review_id\": \"xxx\",\n                \"user_info\": {},          // 用户信息\n                \"rating\": 5,              // 评分(1-5星)\n                \"review_content\": \"...\",  // 评论内容\n                \"images\": [],             // 评论图片\n                \"videos\": [],             // 评论视频\n                \"create_time\": 0,         // 创建时间戳\n                \"is_verified_buyer\": true // 是否认证买家\n            }\n        ],\n        \"has_more\": 1,                    // 是否有更多: 1=有, 0=无\n        \"next_cursor\": \"xxx\",             // 下一页游标\n        \"review_filters\": [               // 可用的筛选器\n            {\n                \"filter_id\": \"xxx\",\n                \"filter_name\": \"所有评论\"\n            }\n        ],\n        \"statistics\": {                   // 统计信息\n            \"total_count\": 1000,\n            \"average_rating\": 4.5,\n            \"rating_distribution\": {}     // 星级分布\n        }\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Get TikTok Shop product reviews list (supports products from all countries/regions without specifying region code)\n- Support sorting by relevance or time\n- Support review filtering and pagination\n### Parameters:\n- product_id: Product ID (required)\n- sort_type: Sort type\n    - 1: Sort by relevance\n    - 2: Sort by recent (default)\n- filter_id: Review filter ID (optional)\n    - Can be obtained from review_filters list in first response\n- offset: Offset for pagination, default 1\n    - If has_more=1 in response, use next_cursor value for next page\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 200,\n    \"data\": {\n        \"reviews\": [                      // Review list (20 per page)\n            {\n                \"review_id\": \"xxx\",\n                \"user_info\": {},          // User info\n                \"rating\": 5,              // Rating (1-5 stars)\n                \"review_content\": \"...\",  // Review content\n                \"images\": [],             // Review images\n                \"videos\": [],             // Review videos\n                \"create_time\": 0,         // Create timestamp\n                \"is_verified_buyer\": true // Is verified buyer\n            }\n        ],\n        \"has_more\": 1,                    // Has more: 1=yes, 0=no\n        \"next_cursor\": \"xxx\",             // Next page cursor\n        \"review_filters\": [               // Available filters\n            {\n                \"filter_id\": \"xxx\",\n                \"filter_name\": \"All reviews\"\n            }\n        ],\n        \"statistics\": {                   // Statistics\n            \"total_count\": 1000,\n            \"average_rating\": 4.5,\n            \"rating_distribution\": {}     // Rating distribution\n        }\n    }\n}\n```\n\n# [示例/Example]\nproduct_id = \"1731677627342753961\"\nsort_type = 2","operationId":"fetch_product_reviews_v1_api_v1_tiktok_shop_web_fetch_product_reviews_v1_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"1731677627342753961"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序方式/Sort type: 1=相关性/Relevance, 2=最新/Recent","default":2,"title":"Sort Type"},"description":"排序方式/Sort type: 1=相关性/Relevance, 2=最新/Recent","example":2},{"name":"filter_id","in":"query","required":false,"schema":{"type":"string","description":"筛选ID/Filter ID","title":"Filter Id"},"description":"筛选ID/Filter ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"分页偏移量/Offset for pagination","default":1,"title":"Offset"},"description":"分页偏移量/Offset for pagination","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_product_reviews_v2":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取商品评论V2/Get product reviews V2","description":"# [中文]\n### 用途:\n- 获取TikTok Shop商品评论（仅支持美洲，欧洲，地区的商品，东南亚地区商品请使用 `fetch_product_reviews_v1` 接口）\n- 支持多种筛选和排序方式\n- 数据结构更完整，包含更多评论详情\n### 参数:\n- product_id: 商品ID (必填)\n- page_start: 起始页码，默认1\n    - 当响应中 has_more=1 时，使用当前页码 +1 进行下一页请求\n- sort_rule: 排序规则，默认2\n- filter_type: 筛选类型\n    - 1: 默认不选择任何过滤\n    - 2: 包含图片或视频\n    - 3: 真实购买过滤\n- filter_value: 星级筛选\n    - 6: 所有星级的评论(默认)\n    - 5: 5星评价\n    - 4: 4星评价\n    - 3: 3星评价\n    - 2: 2星评价\n    - 1: 1星评价\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"reviews\": [                      // 评论列表(每页20条)\n            {\n                \"review_id\": \"xxx\",\n                \"user\": {                 // 用户信息\n                    \"user_id\": \"xxx\",\n                    \"nickname\": \"用户昵称\",\n                    \"avatar\": \"头像URL\"\n                },\n                \"rating\": 5,              // 评分(1-5星)\n                \"content\": \"评论内容\",\n                \"medias\": [               // 媒体文件(图片/视频)\n                    {\n                        \"type\": \"image\",\n                        \"url\": \"媒体URL\"\n                    }\n                ],\n                \"create_time\": 0,         // 创建时间戳\n                \"verified_purchase\": true, // 是否认证购买\n                \"product_info\": {},       // 商品信息\n                \"likes_count\": 10,        // 点赞数\n                \"seller_reply\": {}        // 卖家回复\n            }\n        ],\n        \"has_more\": 1,                    // 是否有更多: 1=有, 0=无\n        \"page_start\": 1,                  // 当前页码\n        \"total_count\": 500,               // 总评论数\n        \"review_summary\": {               // 评论摘要\n            \"average_rating\": 4.8,\n            \"star_distribution\": {        // 星级分布\n                \"5\": 400,\n                \"4\": 80,\n                \"3\": 15,\n                \"2\": 3,\n                \"1\": 2\n            }\n        }\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Get TikTok Shop product reviews (only supports products from Americas, Europe; for Southeast Asia products, use `fetch_product_reviews_v1`)\n- Support multiple filtering and sorting options\n- More complete data structure with detailed review information\n### Parameters:\n- product_id: Product ID (required)\n- page_start: Starting page number, default 1\n    - When has_more=1 in response, use current page +1 for next page\n- sort_rule: Sort rule, default 2\n- filter_type: Filter type\n    - 1: Default, no filter\n    - 2: Contains images or videos\n    - 3: Verified purchase filter\n- filter_value: Star filter\n    - 6: All star ratings (default)\n    - 5: 5-star reviews\n    - 4: 4-star reviews\n    - 3: 3-star reviews\n    - 2: 2-star reviews\n    - 1: 1-star reviews\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"reviews\": [                      // Review list (20 per page)\n            {\n                \"review_id\": \"xxx\",\n                \"user\": {                 // User info\n                    \"user_id\": \"xxx\",\n                    \"nickname\": \"Username\",\n                    \"avatar\": \"Avatar URL\"\n                },\n                \"rating\": 5,              // Rating (1-5 stars)\n                \"content\": \"Review content\",\n                \"medias\": [               // Media files (images/videos)\n                    {\n                        \"type\": \"image\",\n                        \"url\": \"Media URL\"\n                    }\n                ],\n                \"create_time\": 0,         // Create timestamp\n                \"verified_purchase\": true, // Is verified purchase\n                \"product_info\": {},       // Product info\n                \"likes_count\": 10,        // Likes count\n                \"seller_reply\": {}        // Seller reply\n            }\n        ],\n        \"has_more\": 1,                    // Has more: 1=yes, 0=no\n        \"page_start\": 1,                  // Current page\n        \"total_count\": 500,               // Total review count\n        \"review_summary\": {               // Review summary\n            \"average_rating\": 4.8,\n            \"star_distribution\": {        // Star distribution\n                \"5\": 400,\n                \"4\": 80,\n                \"3\": 15,\n                \"2\": 3,\n                \"1\": 2\n            }\n        }\n    }\n}\n```\n\n# [示例/Example]\nproduct_id = \"1729556436942358002\"\npage_start = 1\nsort_rule = 2\nfilter_type = 1\nfilter_value = 6\nregion = \"MY\"","operationId":"fetch_product_reviews_v2_api_v1_tiktok_shop_web_fetch_product_reviews_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"1729556436942358002"},{"name":"page_start","in":"query","required":false,"schema":{"type":"integer","description":"起始页码/Page start","default":1,"title":"Page Start"},"description":"起始页码/Page start","example":1},{"name":"sort_rule","in":"query","required":false,"schema":{"type":"integer","description":"排序规则/Sort rule","default":2,"title":"Sort Rule"},"description":"排序规则/Sort rule","example":2},{"name":"filter_type","in":"query","required":false,"schema":{"type":"integer","description":"筛选类型/Filter type: 1=默认, 2=有图片/视频, 3=真实购买","default":1,"title":"Filter Type"},"description":"筛选类型/Filter type: 1=默认, 2=有图片/视频, 3=真实购买","example":1},{"name":"filter_value","in":"query","required":false,"schema":{"type":"integer","description":"星级筛选/Star filter: 6=全部, 5-1=对应星级","default":6,"title":"Filter Value"},"description":"星级筛选/Star filter: 6=全部, 5-1=对应星级","example":6},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"MY","title":"Region"},"description":"地区代码/Region code","example":"MY"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_seller_products_list":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取商家商品列表V1/Get seller products list V1","description":"# [中文]\n### 用途:\n- 获取指定商家的商品列表\n- 支持分页加载更多商品\n### 参数:\n- seller_id: 卖家ID (必填)\n- search_params: 搜索参数，用于分页加载(可选)\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [                // 商品列表(每页30个)\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"商品标题\",\n                \"image\": \"商品图片URL\",\n                \"product_price_info\": {},  // 价格信息\n                \"rate_info\": {},           // 评分信息\n                \"sold_info\": {},           // 销量信息\n                \"seller_info\": {},         // 卖家信息\n                \"seo_url\": \"商品SEO链接\"\n            }\n        ],\n        \"has_more\": true,             // 是否有更多商品\n        \"load_more_params\": {}        // 加载更多参数(用于下一页)\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Get product list from specified seller\n- Support pagination to load more products\n### Parameters:\n- seller_id: Seller ID (required)\n- search_params: Search parameters for pagination (optional)\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [                // Product list (30 per page)\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"Product title\",\n                \"image\": \"Product image URL\",\n                \"product_price_info\": {},  // Price info\n                \"rate_info\": {},           // Rating info\n                \"sold_info\": {},           // Sales info\n                \"seller_info\": {},         // Seller info\n                \"seo_url\": \"Product SEO URL\"\n            }\n        ],\n        \"has_more\": true,             // Has more products\n        \"load_more_params\": {}        // Load more params (for next page)\n    }\n}\n```\n\n# [示例/Example]\nseller_id = \"7495150558072178725\"\nsearch_params = \"\"\nregion = \"US\"","operationId":"fetch_seller_products_list_api_v1_tiktok_shop_web_fetch_seller_products_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"seller_id","in":"query","required":true,"schema":{"type":"string","description":"卖家ID/Seller ID","title":"Seller Id"},"description":"卖家ID/Seller ID","example":"7495150558072178725"},{"name":"search_params","in":"query","required":false,"schema":{"type":"string","description":"搜索参数(用于分页)/Search params (for pagination)","default":"","title":"Search Params"},"description":"搜索参数(用于分页)/Search params (for pagination)","example":"30_WzQzOSwzOTAwMDAwMCwxNzIzMDU4NTY3NTM5LCIxNzI5NTc3OTc3OTI0Nzg0MTY1Il0="},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"US","title":"Region"},"description":"地区代码/Region code","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_seller_products_list_v2":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取商家商品列表V2(移动端)/Get seller products list V2 (Mobile)","description":"# [中文]\n### 用途:\n- 获取商家商品列表(移动端接口)\n- 数据结构更精简\n### 参数:\n- seller_id: 卖家ID (必填)\n- searchParams: 搜索参数(可选)\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [...],            // 商品列表\n        \"has_more\": true,             // 是否有更多\n        \"load_more_params\": {}        // 加载更多参数\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Get seller product list (Mobile API)\n- More streamlined data structure\n### Parameters:\n- seller_id: Seller ID (required)\n- searchParams: Search parameters (optional)\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [...],            // Product list\n        \"has_more\": true,             // Has more\n        \"load_more_params\": {}        // Load more params\n    }\n}\n```\n\n# [示例/Example]\nseller_id = \"7495150558072178725\"\nsearchParams = \"\"\nregion = \"US\"","operationId":"fetch_seller_products_list_v2_api_v1_tiktok_shop_web_fetch_seller_products_list_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"seller_id","in":"query","required":true,"schema":{"type":"string","description":"卖家ID/Seller ID","title":"Seller Id"},"description":"卖家ID/Seller ID","example":"7495150558072178725"},{"name":"searchParams","in":"query","required":false,"schema":{"type":"string","description":"搜索参数/Search params","default":"","title":"Searchparams"},"description":"搜索参数/Search params","example":""},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"US","title":"Region"},"description":"地区代码/Region code","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_search_word_suggestion":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取搜索关键词建议V1/Get search keyword suggestions V1","description":"# [中文]\n### 用途:\n- 获取搜索关键词的自动补全建议\n- 用于搜索框的智能提示功能\n### 参数:\n- search_word: 搜索关键词 (必填)\n- lang: 语言代码 (en-US/zh-CN等)\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"\",\n    \"data\": [                        // 建议列表(最多50个)\n        \"phone case\",\n        \"phone mount\",\n        \"phone holder for car\",\n        \"...\"\n    ]\n}\n```\n\n# [English]\n### Purpose:\n- Get auto-complete suggestions for search keywords\n- Used for search box smart suggestions\n### Parameters:\n- search_word: Search keyword (required)\n- lang: Language code (en-US/zh-CN etc.)\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"\",\n    \"data\": [                        // Suggestion list (up to 50)\n        \"phone case\",\n        \"phone mount\",\n        \"phone holder for car\",\n        \"...\"\n    ]\n}\n```\n\n# [示例/Example]\nsearch_word = \"labubu\"\nlang = \"en-US\"\nregion = \"US\"","operationId":"fetch_search_word_suggestion_api_v1_tiktok_shop_web_fetch_search_word_suggestion_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search_word","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Search Word"},"description":"搜索关键词/Search keyword","example":"labubu"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","description":"语言/Language","default":"en-US","title":"Lang"},"description":"语言/Language","example":"en-US"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"US","title":"Region"},"description":"地区代码/Region code","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_search_word_suggestion_v2":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取搜索关键词建议V2(移动端)/Get search keyword suggestions V2 (Mobile)","description":"# [中文]\n### 用途:\n- 获取搜索关键词建议(移动端接口)\n- 专为电商搜索结果优化\n### 参数:\n- search_word: 搜索关键词 (必填)\n- lang: 语言代码 (en-US/zh-CN等)\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"\",\n    \"data\": [                        // 建议列表(最多50个)\n        \"关键词1\",\n        \"关键词2\",\n        \"...\"\n    ]\n}\n```\n\n# [English]\n### Purpose:\n- Get search keyword suggestions (Mobile API)\n- Optimized for e-commerce search results\n### Parameters:\n- search_word: Search keyword (required)\n- lang: Language code (en-US/zh-CN etc.)\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"\",\n    \"data\": [                        // Suggestion list (up to 50)\n        \"keyword1\",\n        \"keyword2\",\n        \"...\"\n    ]\n}\n```\n\n# [示例/Example]\nsearch_word = \"labubu\"\nlang = \"en-US\"\nregion = \"US\"","operationId":"fetch_search_word_suggestion_v2_api_v1_tiktok_shop_web_fetch_search_word_suggestion_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search_word","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Search Word"},"description":"搜索关键词/Search keyword","example":"labubu"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","description":"语言/Language","default":"en-US","title":"Lang"},"description":"语言/Language","example":"en-US"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"US","title":"Region"},"description":"地区代码/Region code","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_search_products_list":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"搜索商品列表V1/Search products list V1","description":"# [中文]\n### 用途:\n- 根据关键词搜索商品\n- 支持分页加载更多结果\n### 参数:\n- search_word: 搜索关键词 (必填)\n- offset: 偏移量，用于分页 (默认0)\n- page_token: 分页标记，用于获取下一页\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [                // 商品列表(每页30个)\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"商品标题\",\n                \"image\": \"商品图片URL\",\n                \"product_price_info\": {},  // 价格信息\n                \"rate_info\": {},           // 评分信息\n                \"sold_info\": {},           // 销量信息\n                \"seller_info\": {},         // 卖家信息\n                \"seo_url\": \"商品SEO链接\",\n                \"product_marketing_info\": {} // 营销信息\n            }\n        ],\n        \"has_more\": true,             // 是否有更多\n        \"load_more_params\": {         // 分页参数\n            \"offset\": 30,\n            \"page_token\": \"xxx\",\n            \"api_source\": 2\n        }\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Search products by keyword\n- Support pagination to load more results\n### Parameters:\n- search_word: Search keyword (required)\n- offset: Offset for pagination (default 0)\n- page_token: Page token for next page\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [                // Product list (30 per page)\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"Product title\",\n                \"image\": \"Product image URL\",\n                \"product_price_info\": {},  // Price info\n                \"rate_info\": {},           // Rating info\n                \"sold_info\": {},           // Sales info\n                \"seller_info\": {},         // Seller info\n                \"seo_url\": \"Product SEO URL\",\n                \"product_marketing_info\": {} // Marketing info\n            }\n        ],\n        \"has_more\": true,             // Has more\n        \"load_more_params\": {         // Pagination params\n            \"offset\": 30,\n            \"page_token\": \"xxx\",\n            \"api_source\": 2\n        }\n    }\n}\n```\n\n# [示例/Example]\nsearch_word = \"labubu\"\noffset = 0\npage_token = \"\"\nregion = \"US\"","operationId":"fetch_search_products_list_api_v1_tiktok_shop_web_fetch_search_products_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search_word","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Search Word"},"description":"搜索关键词/Search keyword","example":"labubu"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset","example":0},{"name":"page_token","in":"query","required":false,"schema":{"type":"string","description":"分页标记/Page token","default":"","title":"Page Token"},"description":"分页标记/Page token","example":""},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"US","title":"Region"},"description":"地区代码/Region code","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_search_products_list_v2":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"搜索商品列表V2(移动端)/Search products list V2 (Mobile)","description":"# [中文]\n### 用途:\n- 搜索商品(移动端接口)\n- 数据结构更精简，响应更快\n### 参数:\n- search_word: 搜索关键词 (必填)\n- offset: 偏移量 (默认0)\n- page_token: 分页标记\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [...],            // 商品列表\n        \"has_more\": true,             // 是否有更多\n        \"load_more_params\": {}        // 加载更多参数\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Search products (Mobile API)\n- More streamlined data, faster response\n### Parameters:\n- search_word: Search keyword (required)\n- offset: Offset (default 0)\n- page_token: Page token\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [...],            // Product list\n        \"has_more\": true,             // Has more\n        \"load_more_params\": {}        // Load more params\n    }\n}\n```\n\n# [示例/Example]\nsearch_word = \"labubu\"\noffset = 0\npage_token = \"\"\nregion = \"US\"","operationId":"fetch_search_products_list_v2_api_v1_tiktok_shop_web_fetch_search_products_list_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search_word","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Search Word"},"description":"搜索关键词/Search keyword","example":"labubu"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset","example":0},{"name":"page_token","in":"query","required":false,"schema":{"type":"string","description":"分页标记/Page token","default":"","title":"Page Token"},"description":"分页标记/Page token","example":""},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"US","title":"Region"},"description":"地区代码/Region code","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_search_products_list_v3":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"搜索商品列表V3/Search products list V3","description":"# [中文]\n### 用途:\n- 搜索TikTok Shop商品，支持高级筛选和排序\n- 提供更多的筛选选项和排序方式\n- 适合需要精细化筛选的场景\n### 参数:\n- keyword: 搜索关键词 (必填)\n- offset: 分页偏移量，默认0\n    - 每页固定返回20个商品\n    - 如果响应中 has_more=1，使用 cursor 值进行下一页请求\n- region: 地区代码，Alpha-2 国家代码 (必填)\n- sort_by: 排序方式，默认 RELEVANCE\n    - RELEVANCE: 按相关性排序（默认）\n    - PRICE_ASC: 价格从低到高\n    - PRICE_DESC: 价格从高到低\n    - BEST_SELLERS: 最畅销\n- filters_data: 筛选数据，JSON数组格式字符串（可选）\n    - 可从首次响应的 filter_groups 字段获取可用筛选器\n    - 格式示例：\n        - 简单筛选按钮: {\"type\": 2, \"value\": \"true\"}\n        - 范围/多选: {\"type\": 8, \"value_list\": [\"1,1000\"]}\n        - 完整示例（价格和4星及以上）: [{\"type\": 2, \"value\": \"true\"},{\"type\": 8, \"value_list\": [\"1,1000\"]}]\n### 重要提示:\n- 每页固定返回20个商品\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 200,\n    \"data\": {\n        \"products\": [                  // 商品列表\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"商品标题\",\n                \"image\": \"商品图片URL\",\n                \"price\": {             // 价格信息\n                    \"current_price\": 19.99,\n                    \"original_price\": 29.99,\n                    \"discount\": \"33% OFF\"\n                },\n                \"rating\": {            // 评分信息\n                    \"average\": 4.8,\n                    \"count\": 1234\n                },\n                \"sales\": 5000,         // 销量\n                \"seller_info\": {},     // 卖家信息\n                \"url\": \"商品链接\"\n            }\n        ],\n        \"has_more\": 1,                 // 是否有更多: 1=有, 0=无\n        \"cursor\": \"xxx\",               // 下一页游标\n        \"filter_groups\": [             // 可用的筛选器组\n            {\n                \"group_name\": \"价格\",\n                \"filters\": [\n                    {\n                        \"type\": 8,\n                        \"name\": \"价格区间\",\n                        \"options\": [...]\n                    }\n                ]\n            },\n            {\n                \"group_name\": \"评分\",\n                \"filters\": [\n                    {\n                        \"type\": 2,\n                        \"name\": \"4星及以上\",\n                        \"value\": \"true\"\n                    }\n                ]\n            }\n        ],\n        \"total_count\": 10000           // 总商品数\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Search TikTok Shop products with advanced filtering and sorting\n- Provides more filter options and sort methods\n- Suitable for scenarios requiring fine-grained filtering\n### Parameters:\n- keyword: Search keyword (required)\n- offset: Offset for pagination, default 0\n    - Fixed 20 products per page\n    - If has_more=1 in response, use cursor value for next page\n- region: Region code, Alpha-2 country code (required)\n- sort_by: Sort method, default RELEVANCE\n    - RELEVANCE: Sort by relevance (default)\n    - PRICE_ASC: Price low to high\n    - PRICE_DESC: Price high to low\n    - BEST_SELLERS: Best sellers\n- filters_data: Filter data, JSON array format string (optional)\n    - Available filters can be obtained from filter_groups field in first response\n    - Format examples:\n        - Simple filter button: {\"type\": 2, \"value\": \"true\"}\n        - Range/multiple select: {\"type\": 8, \"value_list\": [\"1,1000\"]}\n        - Complete example (price and 4+ stars): [{\"type\": 2, \"value\": \"true\"},{\"type\": 8, \"value_list\": [\"1,1000\"]}]\n### Important Notice:\n- Fixed 20 products per page\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 200,\n    \"data\": {\n        \"products\": [                  // Product list\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"Product title\",\n                \"image\": \"Product image URL\",\n                \"price\": {             // Price info\n                    \"current_price\": 19.99,\n                    \"original_price\": 29.99,\n                    \"discount\": \"33% OFF\"\n                },\n                \"rating\": {            // Rating info\n                    \"average\": 4.8,\n                    \"count\": 1234\n                },\n                \"sales\": 5000,         // Sales count\n                \"seller_info\": {},     // Seller info\n                \"url\": \"Product URL\"\n            }\n        ],\n        \"has_more\": 1,                 // Has more: 1=yes, 0=no\n        \"cursor\": \"xxx\",               // Next page cursor\n        \"filter_groups\": [             // Available filter groups\n            {\n                \"group_name\": \"Price\",\n                \"filters\": [\n                    {\n                        \"type\": 8,\n                        \"name\": \"Price range\",\n                        \"options\": [...]\n                    }\n                ]\n            },\n            {\n                \"group_name\": \"Rating\",\n                \"filters\": [\n                    {\n                        \"type\": 2,\n                        \"name\": \"4 Stars & Up\",\n                        \"value\": \"true\"\n                    }\n                ]\n            }\n        ],\n        \"total_count\": 10000           // Total product count\n    }\n}\n```\n\n# [示例/Example]\nkeyword = \"baby\"\noffset = 0\nregion = \"US\"\nsort_by = \"PRICE_ASC\"\nfilters_data = '[{\"type\": 2, \"value\": \"true\"},{\"type\": 8, \"value_list\": [\"1,1000\"]}]'","operationId":"fetch_search_products_list_v3_api_v1_tiktok_shop_web_fetch_search_products_list_v3_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"Labubu"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset","example":0},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code (Alpha-2)","default":"US","title":"Region"},"description":"地区代码/Region code (Alpha-2)","example":"US"},{"name":"sort_by","in":"query","required":false,"schema":{"enum":["RELEVANCE","PRICE_ASC","PRICE_DESC","BEST_SELLERS"],"type":"string","description":"排序方式/Sort by","default":"RELEVANCE","title":"Sort By"},"description":"排序方式/Sort by","example":"RELEVANCE"},{"name":"filters_data","in":"query","required":false,"schema":{"type":"string","description":"筛选数据JSON/Filters data JSON","title":"Filters Data"},"description":"筛选数据JSON/Filters data JSON"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_products_category_list":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取商品分类列表/Get product category list","description":"# [中文]\n### 用途:\n- 获取TikTok Shop的商品分类目录\n- 返回完整的分类树结构\n### 参数:\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 返回数据结构:\n```json\n[\n    {\n        \"self\": {                     // 分类自身信息\n            \"category_id\": \"xxx\",\n            \"category_level\": 1,\n            \"is_leaf\": false,\n            \"parent_category_id\": \"0\",\n            \"category_name\": \"分类名称\",\n            \"category_name_en\": \"Category Name\",\n            \"image_url\": \"分类图片URL\"\n        },\n        \"children\": [                 // 子分类列表\n            {\n                \"self\": {...},\n                \"children\": [...]\n            }\n        ]\n    }\n]\n```\n- 总共约28个主分类\n\n# [English]\n### Purpose:\n- Get TikTok Shop product category directory\n- Returns complete category tree structure\n### Parameters:\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Response Structure:\n```json\n[\n    {\n        \"self\": {                     // Category info\n            \"category_id\": \"xxx\",\n            \"category_level\": 1,\n            \"is_leaf\": false,\n            \"parent_category_id\": \"0\",\n            \"category_name\": \"Category Name\",\n            \"category_name_en\": \"Category Name\",\n            \"image_url\": \"Category image URL\"\n        },\n        \"children\": [                 // Sub-categories\n            {\n                \"self\": {...},\n                \"children\": [...]\n            }\n        ]\n    }\n]\n```\n- Total about 28 main categories\n\n# [示例/Example]\nregion = \"US\"","operationId":"fetch_products_category_list_api_v1_tiktok_shop_web_fetch_products_category_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"US","title":"Region"},"description":"地区代码/Region code","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_products_by_category_id":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"根据分类ID获取商品列表/Get products by category ID","description":"# [中文]\n### 用途:\n- 根据商品分类ID获取该分类下的商品列表\n- 可用于构建分类浏览功能\n### 参数:\n- category_id: 分类ID (必填，从fetch_products_category_list接口获取)\n- offset: 翻页偏移量 (默认0)\n    - 每页默认20个商品，每次请求增加20，当响应中的 `hasMore` 为true时可继续请求下一页，否则已到最后一页。\n    - 例如: 第1页offset=0，第2页offset=20，第3页offset=40，以此类推。\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n### 重要提示:\n- 由于接口风控原因，请务必将请求timeout设置为30秒\n- 如遇到400错误代码，请重试请求3次\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [                // 商品列表(最多20个)\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"商品标题\",\n                \"image\": \"商品图片\",\n                \"price\": {},              // 价格信息\n                \"rating\": {},             // 评分信息\n                \"sales\": {}               // 销量信息\n            }\n        ]\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Get product list by category ID\n- Can be used to build category browsing feature\n### Parameters:\n- category_id: Category ID (required, from fetch_products_category_list API)\n- offset: Offset for pagination (default 0)\n    - Default 20 products per page, increase by 20 for each request. If `hasMore` in response is true, can request next page, otherwise reached last page.\n    - Example: Page 1 offset=0, Page 2 offset=20, Page 3 offset=40, and so on.\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n### Important Notice:\n- Due to API rate limiting, please set request timeout to 30 seconds\n- If you encounter error code 400, please retry the request 3 times\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [                // Product list (up to 20)\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"Product title\",\n                \"image\": \"Product image\",\n                \"price\": {},              // Price info\n                \"rating\": {},             // Rating info\n                \"sales\": {}               // Sales info\n            }\n        ]\n    }\n}\n```\n\n# [示例/Example]\ncategory_id = 963976\nregion = \"US\"","operationId":"fetch_products_by_category_id_api_v1_tiktok_shop_web_fetch_products_by_category_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category_id","in":"query","required":true,"schema":{"type":"integer","description":"分类ID/Category ID","title":"Category Id"},"description":"分类ID/Category ID","example":963976},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"翻页偏移量/Offset for pagination","default":0,"title":"Offset"},"description":"翻页偏移量/Offset for pagination","example":0},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"US","title":"Region"},"description":"地区代码/Region code","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/shop/web/fetch_hot_selling_products_list":{"get":{"tags":["TikTok-Shop-Web-API"],"summary":"获取热卖商品列表/Get hot selling products list","description":"# [中文]\n### 用途:\n- 获取TikTok Shop的热卖商品列表\n- 返回当前最受欢迎的商品\n### 参数:\n- region: 地区代码 (US/GB/SG/MY/PH/TH/VN/ID)\n- count: 返回商品数量，默认100 (可选)\n### 返回数据结构:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [                // 热卖商品列表(最多1000个)\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"商品标题\",\n                \"image\": \"商品图片\",\n                \"price\": {},              // 价格信息\n                \"rating\": {},             // 评分信息\n                \"sales\": {},              // 销量信息\n                \"rank\": 1                 // 热卖排名\n            }\n        ]\n    }\n}\n```\n\n# [English]\n### Purpose:\n- Get TikTok Shop hot selling products list\n- Returns currently most popular products\n### Parameters:\n- region: Region code (US/GB/SG/MY/PH/TH/VN/ID)\n- count: Number of products to return, default 100 (optional)\n### Response Structure:\n```json\n{\n    \"code\": 0,\n    \"message\": \"success\",\n    \"data\": {\n        \"products\": [                // Hot selling products (up to 1000)\n            {\n                \"product_id\": \"xxx\",\n                \"title\": \"Product title\",\n                \"image\": \"Product image\",\n                \"price\": {},              // Price info\n                \"rating\": {},             // Rating info\n                \"sales\": {},              // Sales info\n                \"rank\": 1                 // Hot selling rank\n            }\n        ]\n    }\n}\n```\n\n# [示例/Example]\nregion = \"US\"","operationId":"fetch_hot_selling_products_list_api_v1_tiktok_shop_web_fetch_hot_selling_products_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code","default":"US","title":"Region"},"description":"地区代码/Region code","example":"US"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"返回商品数量/Number of products to return","default":100,"title":"Count"},"description":"返回商品数量/Number of products to return","example":100}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/interaction/apply":{"get":{"tags":["TikTok-Interaction-API"],"summary":"申请使用TikTok交互API权限（Scope）/Apply for TikTok Interaction API permission (Scope)","description":"# [通知]\n- 此接口已经废弃，用户现在无需手动申请调用权限，只需要在用户后台更新API Key的对应权限即可，即API Key对应的的Scope。\n# [中文]\n### 接口用途:\n- 申请使用TikTok交互API的接口权限（Scope），请在使用交互类接口之前申请，否则将无法正常请求。\n### 申请流程:\n- 申请接口权限需要邀请码，如果你没有邀请码，可以在Discord服务器中联系管理员获取。\n- Discord服务器链接: [TikHub Discord](https://discord.gg/aMEAS8Xsvz)\n### 申请须知:\n- 此权限仅限于当前提交的API Key，不可跨API Key使用。\n- 用户需要使用美国地区注册且有效的的TikTok账号进行登录，否则保证将无法正常请求。\n- 用户需要使用美国地区的代理IP进行获取Cookie，否则将保证无法正常请求。\n- 用户需要使用美国地区的代理IP进行请求，否则将无法保证正常请求。\n### 用户守则以及责任:\n- 请不要使用交互类接口对他人造成骚扰，或进行违法违规的操作，否则我们将会停止对你的服务，并且所有责任由你自己承担。\n- 请不要将接口权限分享给他人，否则我们将会停止对你的服务。\n- 接口请求目前暂时定为每秒5次请求。\n### 返回:\n- 申请结果以及申请的邀请码，请自行保留邀请码，以便后续使用。\n\n# [Notice]\n- This interface has been deprecated, users no longer need to apply for permission to call the API, just update the corresponding permission of the API Key in the user background, that is, the Scope corresponding to the API Key.\n# [English]\n### Purpose:\n- Apply for the interface permission (Scope) of TikTok Interaction API, please apply before using the interactive interface, otherwise the request will not be made normally.\n### Application process:\n- Applying for interface permissions requires an invitation code, if you do not have an invitation code, you can contact the administrator on the Discord server.\n- Discord server link: [TikHub Discord](https://discord.gg/aMEAS8Xsvz)\n### Application notes:\n- This permission is limited to the API Key submitted, and cannot be used across API Keys.\n- Users need to log in with a registered and valid TikTok account in the United States, otherwise the request will not be made normally.\n- Users need to use a proxy IP in the United States to obtain cookies, otherwise the request will not be made normally.\n- Users need to use a proxy IP in the United States for requests, otherwise the request will not be made normally.\n### User guidelines and responsibilities:\n- Please do not use interactive interfaces to harass others, or engage in illegal or irregular operations, otherwise we will stop providing services to you, and all responsibilities will be borne by you.\n- Please do not share the interface permission with others, otherwise we will stop providing services to you.\n- The interface request is currently set to 5 requests per second.\n### Return:\n- Application results and the invitation code applied for, please keep the invitation code for subsequent use.\n\n# [示例/Example]\n```python\n# Python Code\ninvite_code = \"Your_Invite_Code\"\n```","operationId":"apply_for_scope_api_v1_tiktok_interaction_apply_get","deprecated":true,"parameters":[{"name":"api_key","in":"query","required":true,"schema":{"type":"string","title":"你的API Key/Your API Key"}},{"name":"invite_code","in":"query","required":true,"schema":{"type":"string","title":"邀请码/Invite Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tiktok/interaction/post_comment":{"post":{"tags":["TikTok-Interaction-API"],"summary":"发送评论/Post comment","description":"# [中文]\n### 用途:\n- 使用用户Cookie发送评论到指定视频，当前请尽可能使用美国地区的TikTok账号，并且在获取Cookie时请使用美国地区的代理IP。\n### 注意:\n- 交互类接口都需要使用用户的Cookie，因此请确保你的Cookie是有效的，否则将无法正常请求。\n- 交互类的接口可能会导致账号异常或封禁，因此请谨慎使用，建议使用代理IP进行请求。\n- 交互类接口的最终结果可能会受到TikTok风控系统的影响，大多数情况跟你所使用的账号有关，比如新注册的账号可能无法关注用户或点赞视频，我们无法处理基于账号的风控问题。\n- 请不要使用交互类接口对他人造成骚扰，或进行违法违规的操作，否则我们将会停止对你的服务，并且所有责任由你自己承担。\n### 参数:\n- aweme_id: 视频id，可以从分享链接中获取，例如：https://www.tiktok.com/@username/video/7419966340443819295\n- text: 评论内容，TikTok评论内容需要符合规范，不要带有违规的关键词，否则即使请求成功也会被系统判定为垃圾评论从而不被展示，提交时请使用URL编码评论字符串。\n- cookie: 用户Cookie，可以从浏览器中登录自己的TikTok账号，然后复制Cookie信息，提交时请使用URL编码Cookie字符串。\n- device_id: 设备id，可选，如果不填写则会自动生成，如果需要自定义设备id，请使用设备信息接口获取设备id。\n- iid: 设备安装id，可选，如果不填写则会自动生成，如果需要自定义设备iid，请使用设备信息接口获取设备iid。\n- proxy: 代理IP，可选，如果不填写则会使用服务器IP进行请求（不推荐），建议使用代理IP进行请求防止账号异常获被封禁，支持格式如下：\n    - 代理IP:端口\n    - 用户名:密码@代理IP:端口\n### 返回:\n- 发送评论结果以及评论数据和设备信息，请自行保留设备信息，如请求时使用的`device_id`以及`iid`，以便后续调用接口时使用，频繁更换设备信息可能会导致账号异常或封禁。\n\n# [English]\n### Purpose:\n- Post comments to the specified video using user cookies, please try to use TikTok accounts in the United States as much as possible, and use proxy IPs in the United States when obtaining cookies.\n### Note:\n- Interactive interfaces all need to use the user's Cookie, so please make sure that your Cookie is valid, otherwise the request will not be made normally.\n- Interactive interfaces may cause account exceptions or bans, so please use them with caution, and it is recommended to use proxy IPs for requests.\n- The final result of the interactive interface may be affected by the TikTok risk control system, and in most cases it is related to the account you are using, for example, a newly registered account may not be able to follow users or like videos, and we cannot handle risk control issues based on accounts.\n- Please do not use interactive interfaces to harass others, or engage in illegal or irregular operations, otherwise we will stop providing services to you, and all responsibilities will be borne by you.\n### Parameters:\n- aweme_id: Video id, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295\n- text: Comment content, TikTok comment content needs to comply with the specifications, do not contain illegal keywords, otherwise, even if the request is successful, it will be judged as spam comments by the system and will not be displayed, please use URL-encoded comment string when submitting.\n- cookie: User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.\n- device_id: Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.\n- iid: Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.\n- proxy: Proxy IP, optional, if not filled in, the server IP will be used for the request (not recommended), it is recommended to use a proxy IP for the request to prevent account exceptions or bans, support the following formats:\n    - Proxy IP:Port\n    - Username:Password@Proxy IP:Port\n### Return:\n- Post comment results, comment data and device information, please keep the device information, such as the `device_id` and `iid` used when requesting, for subsequent calls to the interface, frequent replacement of device information may cause account exceptions or bans.\n\n# [示例/Example]\n```python\n# Python Code\ntext = urllib.parse.quote(\"Hello, TikTok!\")\ncookie = urllib.parse.quote(\"Your_Cookie_From_Browser\")\npayload = {\n    \"aweme_id\": \"7419966340443819295\",\n    \"text\": text,\n    \"cookie\": cookie,\n    \"proxy\": \"\",\n}\n```","operationId":"post_comment_api_v1_tiktok_interaction_post_comment_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostCommentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/interaction/reply_comment":{"post":{"tags":["TikTok-Interaction-API"],"summary":"回复评论/Reply to comment","description":"# [中文]\n### 用途:\n- 使用用户Cookie回复指定视频的一个评论，当前请尽可能使用美国地区的TikTok账号，并且在获取Cookie时请使用美国地区的代理IP。\n### 注意:\n- 交互类接口都需要使用用户的Cookie，因此请确保你的Cookie是有效的，否则将无法正常请求。\n- 交互类的接口可能会导致账号异常或封禁，因此请谨慎使用，建议使用代理IP进行请求。\n- 交互类接口的最终结果可能会受到TikTok风控系统的影响，大多数情况跟你所使用的账号有关，比如新注册的账号可能无法关注用户或点赞视频，我们无法处理基于账号的风控问题。\n- 请不要使用交互类接口对他人造成骚扰，或进行违法违规的操作，否则我们将会停止对你的服务，并且所有责任由你自己承担。\n### 参数:\n- aweme_id: 视频id，可以从分享链接中获取，例如：https://www.tiktok.com/@username/video/7419966340443819295\n- reply_id: 要回复的目标评论ID，可以从指定视频的评论数据接口中获取，通常关键字为`cid`或`comment_id`或`reply_id`。\n- text: 评论内容，TikTok评论内容需要符合规范，不要带有违规的关键词，否则即使请求成功也会被系统判定为垃圾评论从而不被展示，提交时请使用URL编码评论字符串。\n- cookie: 用户Cookie，可以从浏览器中登录自己的TikTok账号，然后复制Cookie信息，提交时请使用URL编码Cookie字符串。\n- device_id: 设备id，可选，如果不填写则会自动生成，如果需要自定义设备id，请使用设备信息接口获取设备id。\n- iid: 设备安装id，可选，如果不填写则会自动生成，如果需要自定义设备iid，请使用设备信息接口获取设备iid。\n- proxy: 代理IP，可选，如果不填写则会使用服务器IP进行请求（不推荐），建议使用代理IP进行请求防止账号异常获被封禁，支持格式如下：\n    - 代理IP:端口\n    - 用户名:密码@代理IP:端口\n### 返回:\n- 回复评论结果以及评论数据和设备信息，请自行保留设备信息，如请求时使用的`device_id`以及`iid`，以便后续调用接口时使用，频繁更换设备信息可能会导致账号异常或封禁。\n\n# [English]\n### Purpose:\n- Reply to a comment on a specified video using user cookies, please try to use TikTok accounts in the United States as much as possible, and use proxy IPs in the United States when obtaining cookies.\n### Note:\n- Interactive interfaces all need to use the user's Cookie, so please make sure that your Cookie is valid, otherwise the request will not be made normally.\n- Interactive interfaces may cause account exceptions or bans, so please use them with caution, and it is recommended to use proxy IPs for requests.\n- The final result of the interactive interface may be affected by the TikTok risk control system, and in most cases it is related to the account you are using, for example, a newly registered account may not be able to follow users or like videos, and we cannot handle risk control issues based on accounts.\n- Please do not use interactive interfaces to harass others, or engage in illegal or irregular operations, otherwise we will stop providing services to you, and all responsibilities will be borne by you.\n### Parameters:\n- aweme_id: Video id, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295\n- reply_id: The target comment ID to reply to, which can be obtained from the comment data interface of the specified video, usually the keyword is `cid` or `comment_id` or `reply_id`.\n- text: Comment content, TikTok comment content needs to comply with the specifications, do not contain illegal keywords, otherwise, even if the request is successful, it will be judged as spam comments by the system and will not be displayed, please use URL-encoded comment string when submitting.\n- cookie: User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.\n- device_id: Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.\n- iid: Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.\n- proxy: Proxy IP, optional, if not filled in, the server IP will be used for the request (not recommended), it is recommended to use a proxy IP for the request to prevent account exceptions or bans, support the following formats:\n    - Proxy IP:Port\n    - Username:Password@Proxy IP:Port\n### Return:\n- Reply comment results, comment data and device information, please keep the device information, such as the `device_id` and `iid` used when requesting, for subsequent calls to the interface, frequent replacement of device information may cause account exceptions or bans.\n\n# [示例/Example]\n```python\n# Python Code\ntext = urllib.parse.quote(\"Hello, TikTok!\")\ncookie = urllib.parse.quote(\"Your_Cookie_From_Browser\")\npayload = {\n    \"aweme_id\": \"7419966340443819295\",\n    \"reply_id\": \"7420673787547419435\",\n    \"text\": text,\n    \"cookie\": cookie,\n    \"proxy\": \"\",\n}\n```","operationId":"reply_comment_api_v1_tiktok_interaction_reply_comment_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplyCommentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/interaction/like":{"post":{"tags":["TikTok-Interaction-API"],"summary":"点赞/Like","description":"# [中文]\n### 用途:\n- 使用用户Cookie点赞指定视频，当前请尽可能使用美国地区的TikTok账号，并且在获取Cookie时请使用美国地区的代理IP。\n### 注意:\n- 交互类接口都需要使用用户的Cookie，因此请确保你的Cookie是有效的，否则将无法正常请求。\n- 交互类的接口可能会导致账号异常或封禁，因此请谨慎使用，建议使用代理IP进行请求。\n- 交互类接口的最终结果可能会受到TikTok风控系统的影响，大多数情况跟你所使用的账号有关，比如新注册的账号可能无法关注用户或点赞视频，我们无法处理基于账号的风控问题。\n- 请不要使用交互类接口对他人造成骚扰，或进行违法违规的操作，否则我们将会停止对你的服务，并且所有责任由你自己承担。\n### 参数:\n- aweme_id: 视频id，可以从分享链接中获取，例如：https://www.tiktok.com/@username/video/7419966340443819295\n- cookie: 用户Cookie，可以从浏览器中登录自己的TikTok账号，然后复制Cookie信息，提交时请使用URL编码Cookie字符串。\n- device_id: 设备id，可选，如果不填写则会自动生成，如果需要自定义设备id，请使用设备信息接口获取设备id。\n- iid: 设备安装id，可选，如果不填写则会自动生成，如果需要自定义设备iid，请使用设备信息接口获取设备iid。\n- proxy: 代理IP，可选，如果不填写则会使用服务器IP进行请求（不推荐），建议使用代理IP进行请求防止账号异常获被封禁，支持格式如下：\n    - 代理IP:端口\n    - 用户名:密码@代理IP:端口\n### 返回:\n- 点赞结果以及评论数据和设备信息，请自行保留设备信息，如请求时使用的`device_id`以及`iid`，以便后续调用接口时使用，频繁更换设备信息可能会导致账号异常或封禁。\n\n# [English]\n### Purpose:\n- Like a specified video using user cookies, please try to use TikTok accounts in the United States as much as possible, and use proxy IPs in the United States when obtaining cookies.\n### Note:\n- Interactive interfaces all need to use the user's Cookie, so please make sure that your Cookie is valid, otherwise the request will not be made normally.\n- Interactive interfaces may cause account exceptions or bans, so please use them with caution, and it is recommended to use proxy IPs for requests.\n- The final result of the interactive interface may be affected by the TikTok risk control system, and in most cases it is related to the account you are using, for example, a newly registered account may not be able to follow users or like videos, and we cannot handle risk control issues based on accounts.\n- Please do not use interactive interfaces to harass others, or engage in illegal or irregular operations, otherwise we will stop providing services to you, and all responsibilities will be borne by you.\n### Parameters:\n- aweme_id: Video id, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295\n- cookie: User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.\n- device_id: Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.\n- iid: Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.\n- proxy: Proxy IP, optional, if not filled in, the server IP will be used for the request (not recommended), it is recommended to use a proxy IP for the request to prevent account exceptions or bans, support the following formats:\n    - Proxy IP:Port\n    - Username:Password@Proxy IP:Port\n### Return:\n- Like results, comment data and device information, please keep the device information, such as the `device_id` and `iid` used when requesting, for subsequent calls to the interface, frequent replacement of device information may cause account exceptions or bans.\n\n# [示例/Example]\n```python\n# Python Code\ncookie = urllib.parse.quote(\"Your_Cookie_From_Browser\")\npayload = {\n    \"aweme_id\": \"7419966340443819295\",\n    \"cookie\": cookie,\n    \"proxy\": \"\",\n}\n```","operationId":"like_api_v1_tiktok_interaction_like_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LikeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/interaction/follow":{"post":{"tags":["TikTok-Interaction-API"],"summary":"关注/Follow","description":"# [中文]\n### 用途:\n- 使用用户Cookie关注指定用户，当前请尽可能使用美国地区的TikTok账号，并且在获取Cookie时请使用美国地区的代理IP。\n### 注意:\n- 交互类接口都需要使用用户的Cookie，因此请确保你的Cookie是有效的，否则将无法正常请求。\n- 交互类的接口可能会导致账号异常或封禁，因此请谨慎使用，建议使用代理IP进行请求。\n- 交互类接口的最终结果可能会受到TikTok风控系统的影响，大多数情况跟你所使用的账号有关，比如新注册的账号可能无法关注用户或点赞视频，我们无法处理基于账号的风控问题。\n- 请不要使用交互类接口对他人造成骚扰，或进行违法违规的操作，否则我们将会停止对你的服务，并且所有责任由你自己承担。\n### 参数:\n- user_id: 用户id，可以从接口`/api/v1/tiktok/app/v3/handler_user_profile`获取。\n- sec_user_id: 用户sec_id，可以从分接口`/api/v1/tiktok/web/get_sec_user_id`获取。\n- cookie: 用户Cookie，可以从浏览器中登录自己的TikTok账号，然后复制Cookie信息，提交时请使用URL编码Cookie字符串。\n- device_id: 设备id，可选，如果不填写则会自动生成，如果需要自定义设备id，请使用设备信息接口获取设备id。\n- iid: 设备安装id，可选，如果不填写则会自动生成，如果需要自定义设备iid，请使用设备信息接口获取设备iid。\n- proxy: 代理IP，可选，如果不填写则会使用服务器IP进行请求（不推荐），建议使用代理IP进行请求防止账号异常获被封禁，支持格式如下：\n    - 代理IP:端口\n    - 用户名:密码@代理IP:端口\n### 返回:\n- 关注结果以及评论数据和设备信息，请自行保留设备信息，如请求时使用的`device_id`以及`iid`，以便后续调用接口时使用，频繁更换设备信息可能会导致账号异常或封禁。\n\n# [English]\n### Purpose:\n- Follow a specified user using user cookies, please try to use TikTok accounts in the United States as much as possible, and use proxy IPs in the United States when obtaining cookies.\n### Note:\n- Interactive interfaces all need to use the user's Cookie, so please make sure that your Cookie is valid, otherwise the request will not be made normally.\n- Interactive interfaces may cause account exceptions or bans, so please use them with caution, and it is recommended to use proxy IPs for requests.\n- The final result of the interactive interface may be affected by the TikTok risk control system, and in most cases it is related to the account you are using, for example, a newly registered account may not be able to follow users or like videos, and we cannot handle risk control issues based on accounts.\n- Please do not use interactive interfaces to harass others, or engage in illegal or irregular operations, otherwise we will stop providing services to you, and all responsibilities will be borne by you.\n### Parameters:\n- user_id: User id, which can be obtained from the sub-interface `/api/v1/tiktok/app/v3/handler_user_profile`.\n- sec_user_id: User sec_id, which can be obtained from the sub-interface `/api/v1/tiktok/web/get_sec_user_id`.\n- cookie: User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.\n- device_id: Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.\n- iid: Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.\n- proxy: Proxy IP, optional, if not filled in, the server IP will be used for the request (not recommended), it is recommended to use a proxy IP for the request to prevent account exceptions or bans, support the following formats:\n    - Proxy IP:Port\n    - Username:Password@Proxy IP:Port\n### Return:\n- Follow results, comment data and device information, please keep the device information, such as the `device_id` and `iid` used when requesting, for subsequent calls to the interface, frequent replacement of device information may cause account exceptions or bans.\n\n# [示例/Example]\n```python\n# Python Code\ncookie = urllib.parse.quote(\"Your_Cookie_From_Browser\")\npayload = {\n    \"user_id\": \"6881290705605477381\",\n    \"sec_user_id\": \"MS4wLjABAAAAqB08cUbXaDWqbD6MCga2RbGTuhfO2EsHayBYx08NDrN7IE3jQuRDNNN6YwyfH6_6\",\n    \"cookie\": cookie,\n    \"proxy\": \"\",\n}\n```","operationId":"follow_api_v1_tiktok_interaction_follow_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/interaction/collect":{"post":{"tags":["TikTok-Interaction-API"],"summary":"收藏/Collect","description":"# [中文]\n### 用途:\n- 使用用户Cookie收藏指定视频，当前请尽可能使用美国地区的TikTok账号，并且在获取Cookie时请使用美国地区的代理IP。\n### 注意:\n- 交互类接口都需要使用用户的Cookie，因此请确保你的Cookie是有效的，否则将无法正常请求。\n- 交互类的接口可能会导致账号异常或封禁，因此请谨慎使用，建议使用代理IP进行请求。\n- 交互类接口的最终结果可能会受到TikTok风控系统的影响，大多数情况跟你所使用的账号有关，比如新注册的账号可能无法关注用户或点赞视频，我们无法处理基于账号的风控问题。\n- 请不要使用交互类接口对他人造成骚扰，或进行违法违规的操作，否则我们将会停止对你的服务，并且所有责任由你自己承担。\n### 参数:\n- aweme_id: 视频id，可以从分享链接中获取，例如：https://www.tiktok.com/@username/video/7419966340443819295\n- cookie: 用户Cookie，可以从浏览器中登录自己的TikTok账号，然后复制Cookie信息，提交时请使用URL编码Cookie字符串。\n- device_id: 设备id，可选，如果不填写则会自动生成，如果需要自定义设备id，请使用设备信息接口获取设备id。\n- iid: 设备安装id，可选，如果不填写则会自动生成，如果需要自定义设备iid，请使用设备信息接口获取设备iid。\n- proxy: 代理IP，可选，如果不填写则会使用服务器IP进行请求（不推荐），建议使用代理IP进行请求防止账号异常获被封禁，支持格式如下：\n    - 代理IP:端口\n    - 用户名:密码@代理IP:端口\n### 返回:\n- 点赞结果以及评论数据和设备信息，请自行保留设备信息，如请求时使用的`device_id`以及`iid`，以便后续调用接口时使用，频繁更换设备信息可能会导致账号异常或封禁。\n\n# [English]\n### Purpose:\n- Collect a specified video using user cookies, please try to use TikTok accounts in the United States as much as possible, and use proxy IPs in the United States when obtaining cookies.\n### Note:\n- Interactive interfaces all need to use the user's Cookie, so please make sure that your Cookie is valid, otherwise the request will not be made normally.\n- Interactive interfaces may cause account exceptions or bans, so please use them with caution, and it is recommended to use proxy IPs for requests.\n- The final result of the interactive interface may be affected by the TikTok risk control system, and in most cases it is related to the account you are using, for example, a newly registered account may not be able to follow users or like videos, and we cannot handle risk control issues based on accounts.\n- Please do not use interactive interfaces to harass others, or engage in illegal or irregular operations, otherwise we will stop providing services to you, and all responsibilities will be borne by you.\n### Parameters:\n- aweme_id: Video id, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295\n- cookie: User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.\n- device_id: Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.\n- iid: Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.\n- proxy: Proxy IP, optional, if not filled in, the server IP will be used for the request (not recommended), it is recommended to use a proxy IP for the request to prevent account exceptions or bans, support the following formats:\n    - Proxy IP:Port\n    - Username:Password@Proxy IP:Port\n### Return:\n- Like results, comment data and device information, please keep the device information, such as the `device_id` and `iid` used when requesting, for subsequent calls to the interface, frequent replacement of device information may cause account exceptions or bans.\n\n# [示例/Example]\n```python\n# Python Code\ncookie = urllib.parse.quote(\"Your_Cookie_From_Browser\")\npayload = {\n    \"aweme_id\": \"7419966340443819295\",\n    \"cookie\": cookie,\n    \"proxy\": \"\",\n}\n```","operationId":"collect_api_v1_tiktok_interaction_collect_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"HTTPBearer":[]}]}},"/api/v1/tiktok/interaction/forward":{"post":{"tags":["TikTok-Interaction-API"],"summary":"转发/Forward","description":"# [中文]\n### 用途:\n- 使用用户Cookie转发指定作品，当前请尽可能使用美国地区的TikTok账号，并且在获取Cookie时请使用美国地区的代理IP。\n### 注意:\n- 交互类接口都需要使用用户的Cookie，因此请确保你的Cookie是有效的，否则将无法正常请求。\n- 交互类的接口可能会导致账号异常或封禁，因此请谨慎使用，建议使用代理IP进行请求。\n- 交互类接口的最终结果可能会受到TikTok风控系统的影响，大多数情况跟你所使用的账号有关，比如新注册的账号可能无法关注用户或点赞视频，我们无法处理基于账号的风控问题。\n- 请不要使用交互类接口对他人造成骚扰，或进行违法违规的操作，否则我们将会停止对你的服务，并且所有责任由你自己承担。\n### 参数:\n- aweme_id: 视频id，可以从分享链接中获取，例如：https://www.tiktok.com/@username/video/7419966340443819295\n- cookie: 用户Cookie，可以从浏览器中登录自己的TikTok账号，然后复制Cookie信息，提交时请使用URL编码Cookie字符串。\n- device_id: 设备id，可选，如果不填写则会自动生成，如果需要自定义设备id，请使用设备信息接口获取设备id。\n- iid: 设备安装id，可选，如果不填写则会自动生成，如果需要自定义设备iid，请使用设备信息接口获取设备iid。\n- proxy: 代理IP，可选，如果不填写则会使用服务器IP进行请求（不推荐），建议使用代理IP进行请求防止账号异常获被封禁，支持格式如下：\n    - 代理IP:端口\n    - 用户名:密码@代理IP:端口\n### 返回:\n- 关注结果以及评论数据和设备信息，请自行保留设备信息，如请求时使用的`device_id`以及`iid`，以便后续调用接口时使用，频繁更换设备信息可能会导致账号异常或封禁。\n\n# [English]\n### Purpose:\n- Forward a specified post using user cookies, please try to use TikTok accounts in the United States as much as possible, and use proxy IPs in the United States when obtaining cookies.\n### Note:\n- Interactive interfaces all need to use the user's Cookie, so please make sure that your Cookie is valid, otherwise the request will not be made normally.\n- Interactive interfaces may cause account exceptions or bans, so please use them with caution, and it is recommended to use proxy IPs for requests.\n- The final result of the interactive interface may be affected by the TikTok risk control system, and in most cases it is related to the account you are using, for example, a newly registered account may not be able to follow users or like videos, and we cannot handle risk control issues based on accounts.\n- Please do not use interactive interfaces to harass others, or engage in illegal or irregular operations, otherwise we will stop providing services to you, and all responsibilities will be borne by you.\n### Parameters:\n- aweme_id: Video id, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295\n- sec_user_id: User sec_id, which can be obtained from the sub-interface `/api/v1/tiktok/web/get_sec_user_id`.\n- cookie: User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.\n- device_id: Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.\n- iid: Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.\n- proxy: Proxy IP, optional, if not filled in, the server IP will be used for the request (not recommended), it is recommended to use a proxy IP for the request to prevent account exceptions or bans, support the following formats:\n    - Proxy IP:Port\n    - Username:Password@Proxy IP:Port\n### Return:\n- Follow results, comment data and device information, please keep the device information, such as the `device_id` and `iid` used when requesting, for subsequent calls to the interface, frequent replacement of device information may cause account exceptions or bans.\n\n# [示例/Example]\n```python\n# Python Code\ncookie = urllib.parse.quote(\"Your_Cookie_From_Browser\")\npayload = {\n    \"user_id\": \"6881290705605477381\",\n    \"sec_user_id\": \"MS4wLjABAAAAqB08cUbXaDWqbD6MCga2RbGTuhfO2EsHayBYx08NDrN7IE3jQuRDNNN6YwyfH6_6\",\n    \"cookie\": cookie,\n    \"proxy\": \"\",\n}\n```","operationId":"forward_api_v1_tiktok_interaction_forward_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwardRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/fetch_one_video":{"get":{"tags":["Douyin-Web-API"],"summary":"获取单个作品数据/Get single video data","description":"# [中文]\n### 用途:\n- 获取单个作品数据 V1，若此接口失效，请使用 `/fetch_one_video_v2` 接口，或使用APP接口。\n### 参数:\n- aweme_id: 作品id\n- need_anchor_info: 是否需要锚点信息，默认为False，开启后会看到一些有关视频的锚点信息，如地理位置，商户信息，商品橱窗等，可能会增加接口响应时间。\n- 如果不需要锚点信息，建议保持默认值False，如果接口报错，可以尝试关闭此参数。\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data V1, if this interface fails, please use the `/fetch_one_video_v2` interface, or use the APP interface.\n### Parameters:\n- aweme_id: Video id\n- need_anchor_info: Whether anchor information is needed, default is False, enabling it will show some anchor information about the video, such as location, merchant information, product showcase, etc., which may increase the interface response time.\n- If anchor information is not needed, it is recommended to keep the default value False, if the interface reports an error, you can try to turn off this parameter.\n### Return:\n- Video data\n\n# [示例/Example]\naweme_id = \"7372484719365098803\"\nneed_anchor_info = False","operationId":"fetch_one_video_api_v1_douyin_web_fetch_one_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7372484719365098803"},{"name":"need_anchor_info","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要锚点信息/Whether anchor information is needed","default":false,"title":"Need Anchor Info"},"description":"是否需要锚点信息/Whether anchor information is needed","example":false}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_one_video_v2":{"get":{"tags":["Douyin-Web-API"],"summary":"获取单个作品数据 V2/Get single video data V2","description":"# [中文]\n### 用途:\n- 获取单个作品数据 V2，若此接口失效，请使用 `/fetch_one_video` 接口，或使用APP接口。\n### 参数:\n- aweme_id: 作品id\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data V2, if this interface fails, please use the `/fetch_one_video` interface, or use the APP interface.\n### Parameters:\n- aweme_id: Video id\n### Return:\n- Video data\n\n# [示例/Example]\naweme_id = \"7372484719365098803\"","operationId":"fetch_one_video_api_v1_douyin_web_fetch_one_video_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7372484719365098803"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_one_video_by_share_url":{"get":{"tags":["Douyin-Web-API"],"summary":"根据分享链接获取单个作品数据/Get single video data by sharing link","description":"# [中文]\n### 用途:\n- 根据分享链接获取单个作品数据 （本质上基于 `/fetch_one_video` 接口实现，建议有能力自行获取视频ID以提升接口响应速度）\n- 返回的视频画质比APP接口高一些，但是响应字段没有APP接口多。\n### 参数:\n- share_url: 分享链接\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data by sharing link (Essentially implemented based on the `/fetch_one_video` interface, it is recommended to obtain the video ID by yourself to improve the interface response speed)\n- The returned video quality is higher than the APP interface, but the response fields are not as many as the APP interface.\n### Parameters:\n- share_url: Share link\n### Return:\n- Video data\n\n# [示例/Example]\nshare_url = \"https://v.douyin.com/e3x2fjE/\"","operationId":"fetch_one_video_by_share_url_api_v1_douyin_web_fetch_one_video_by_share_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_url","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Url"},"description":"分享链接/Share link","example":"https://v.douyin.com/e3x2fjE/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_video_high_quality_play_url":{"get":{"tags":["Douyin-Web-API"],"summary":"获取视频的最高画质播放链接/Get the highest quality play URL of the video","description":"# [中文]\n### 用途:\n- 价格：0.005$ 一次。\n- 获取视频的最高画质(原始上传画质)播放链接\n- 该接口会返回最高画质的播放链接，原始上传画质是指用户上传视频时的画质，通常最高画质视频无压缩码率并且文件头包含元数据。\n- 最高画质的视频链接无法从抖音APP或网页版直接获取，需要通过此接口获取。\n- 此接口非常适合用于获取高清无水印视频链接，适用于需要高质量视频的场景，如视频编辑、存档、训练模型等。\n- 一般情况都可以在线播放，如果不行，可以尝试使用IDM或浏览器下载后播放。\n### 参数:\n- aweme_id: 作品id，优先使用aweme_id，如果没有则使用share_url。\n- share_url: 可选，分享链接，如果提供了作品id，则此参数可以不传。\n### 返回:\n- video_id： 作品id\n- original_video_url： 最高画质(原始上传画质)播放链接\n- video_data： 视频数据，包含视频的元数据，如时长、大小等。\n\n# [English]\n### Purpose:\n- Price: 0.005$ each time.\n- Get the highest quality (original upload quality) play URL of the video\n- This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata.\n- The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface.\n- This interface is very suitable for obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc.\n- Generally, it can be played online, if not, you can try to download it using IDM or a browser and then play it.\n### Parameters:\n- aweme_id: Video id, prefer to use aweme_id, if not available, use share_url.\n- share_url: Optional, share link, if the video id is provided, this parameter can be omitted.\n### Return:\n- video_id: Video id\n- original_video_url: Highest quality (original upload quality) play URL\n- video_data: Video data, including metadata such as duration, size, etc.\n# [示例/Example]\naweme_id = \"7512756548356492544\"\nshare_url = \"https://www.douyin.com/video/7512756548356492544\"","operationId":"fetch_video_high_quality_play_url_api_v1_douyin_web_fetch_video_high_quality_play_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":false,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7512756548356492544"},{"name":"share_url","in":"query","required":false,"schema":{"type":"string","description":"可选，分享链接/Optional, share link","title":"Share Url"},"description":"可选，分享链接/Optional, share link","example":"https://www.douyin.com/video/7512756548356492544"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_multi_video_high_quality_play_url":{"post":{"tags":["Douyin-Web-API"],"summary":"批量获取视频的最高画质播放链接/Batch get the highest quality play URL of videos","description":"# [中文]\n### 用途:\n- 此接口目前优惠活动价为$0.25，活动结束后恢复原价$0.5。不足50个视频按50个视频收费。\n- 批量获取视频的最高画质(原始上传画质)播放链接\n- 该接口会返回最高画质的播放链接，原始上传画质是指用户上传视频时的画质，通常最高画质视频无压缩码率并且文件头包含元数据。\n- 最高画质的视频链接无法从抖音APP或网页版直接获取，需要通过此接口获取。\n- 此接口非常适合用于批量获取高清无水印视频链接，适用于需要高质量视频的场景，如视频编辑、存档、训练模型等。\n- 使用并发请求，提高批量获取效率。\n- 最多支持50个视频ID。\n### 参数:\n- aweme_ids: 作品id列表，用逗号分隔，例如: \"123,456,789\"，最多50个。\n### 返回:\n- total: 总数\n- success_count: 成功数量\n- failed_count: 失败数量\n- videos: 视频列表，每个视频包含以下字段：\n    - video_id: 作品id\n    - original_video_url: 最高画质(原始上传画质)播放链接\n    - file_size: 文件大小（字节）\n    - file_size_in_mb: 文件大小（MB）\n    - content_type: 内容类型\n    - success: 是否成功\n    - error: 错误信息（如果失败）\n### 备注:\n- 由于数量较多，处理时间可能会稍长，请增加等待时间。\n\n# [English]\n### Purpose:\n- This interface is currently on sale for $0.25, and will return to the original price of $0.5 after the event ends. If there are less than 50 videos, they will be charged as 50 videos.\n- Batch get the highest quality (original upload quality) play URL of videos\n- This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata.\n- The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface.\n- This interface is very suitable for batch obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc.\n- Use concurrent requests to improve batch acquisition efficiency.\n- Support up to 50 video IDs.\n### Parameters:\n- aweme_ids: Video id list, separated by commas, for example: \"123,456,789\", up to 50.\n### Return:\n- total: Total count\n- success_count: Success count\n- failed_count: Failed count\n- videos: Video list, each video contains the following fields:\n    - video_id: Video id\n    - original_video_url: Highest quality (original upload quality) play URL\n    - file_size: File size (bytes)\n    - file_size_in_mb: File size (MB)\n    - content_type: Content type\n    - success: Whether successful\n    - error: Error message (if failed)\n### Note:\n- Due to the large number, the processing time may be slightly longer, please increase the waiting time.\n# [示例/Example]\naweme_ids = \"7512756548356492544,7448118827402972455,7126745726494821640\"","operationId":"fetch_multi_video_high_quality_play_url_api_v1_douyin_web_fetch_multi_video_high_quality_play_url_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchMultiVideoHighQualityPlayUrlRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/fetch_multi_video":{"post":{"tags":["Douyin-Web-API"],"summary":"批量获取视频信息/Batch Get Video Information","description":"# [中文]\n### 用途:\n- 批量获取视频信息，支持图文、视频等，一次性最多支持50个视频，此接口收费固定价格为0.001$ * 50 = 0.05$一次。\n- 若此接口失效，请使用APP接口替代。\n### 参数:\n- aweme_ids: 作品id列表，最多支持50个作品id。\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Batch Get Video Information, support photo, video, etc., up to 50 videos at a time, this interface charges a fixed price of 0.001$ * 50 = 0.05$ each time.\n- If this interface fails, please use the APP interface instead.\n### Parameters:\n- aweme_ids: List of video ids, up to 50 video ids are supported.\n### Return:\n- Video data\n\n# [示例/Example]\naweme_ids = [\"7372484719365098803\", \"7126745726494821640\", \"7372484719365098803\", \"7126745726494821640\", \"7372484719365098803\", \"7126745726494821640\", \"7372484719365098803\", \"7126745726494821640\", \"7372484719365098803\", \"7126745726494821640\"]","operationId":"fetch_multi_video_api_v1_douyin_web_fetch_multi_video_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Aweme Ids"},"example":["7372484719365098803","7126745726494821640","7372484719365098803","7126745726494821640","7372484719365098803","7126745726494821640","7372484719365098803","7126745726494821640","7372484719365098803","7126745726494821640"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/fetch_one_video_danmaku":{"get":{"tags":["Douyin-Web-API"],"summary":"获取单个作品视频弹幕数据/Get single video danmaku data","description":"# [中文]\n### 用途:\n- 获取单个作品视频弹幕数据\n### 参数:\n- item_id: 作品id\n- duration: 视频总时长\n- end_time: 结束时间\n- start_time: 开始时间\n### 返回:\n- 视频弹幕数据\n\n# [English]\n### Purpose:\n- Get single video danmaku data\n### Parameters:\n- item_id: Video id\n- duration: Video total duration\n- end_time: End time\n- start_time: Start time\n### Return:\n- Video danmaku data\n\n# [示例/Example]\nitem_id = \"7355433624046472498\"\nduration = 15134\nend_time = 15133\nstart_time = 0","operationId":"fetch_one_video_danmaku_api_v1_douyin_web_fetch_one_video_danmaku_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7355433624046472498"},{"name":"duration","in":"query","required":true,"schema":{"type":"integer","description":"视频总时长/Video total duration","title":"Duration"},"description":"视频总时长/Video total duration","example":15134},{"name":"end_time","in":"query","required":true,"schema":{"type":"integer","description":"结束时间/End time","title":"End Time"},"description":"结束时间/End time","example":15133},{"name":"start_time","in":"query","required":true,"schema":{"type":"integer","description":"开始时间/Start time","title":"Start Time"},"description":"开始时间/Start time","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_home_feed":{"get":{"tags":["Douyin-Web-API"],"summary":"获取首页推荐数据/Get home feed data","description":"# [中文]\n### 用途:\n- 获取首页推荐数据\n### 参数:\n- count: 数量，默认为10，建议保持不变。\n- refresh_index: 翻页索引，默认为0，然后每次增加1用于翻页。\n### 返回:\n- Feed数据\n\n# [English]\n### Purpose:\n- Get home feed data\n### Parameters:\n- count: Number, default is 10, it is recommended to keep it unchanged.\n- refresh_index: Paging index, default is 0, then increase by 1 each time for paging.\n### Return:\n- Feed data\n\n# [示例/Example]\ncount = 10\nrefresh_index = 0","operationId":"fetch_home_feed_api_v1_douyin_web_fetch_home_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":10,"title":"Count"},"description":"数量/Number"},{"name":"refresh_index","in":"query","required":false,"schema":{"type":"integer","description":"翻页索引/Paging index","default":0,"title":"Refresh Index"},"description":"翻页索引/Paging index"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_related_posts":{"get":{"tags":["Douyin-Web-API"],"summary":"获取相关作品推荐数据/Get related posts recommendation data","description":"# [中文]\n### 用途:\n- 获取相关作品推荐数据\n### 参数:\n- aweme_id: 作品id\n- refresh_index: 翻页索引，默认为1，然后每次增加1用于翻页。\n- count: 数量，默认为20，建议保持不变。\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get related posts recommendation data\n### Parameters:\n- aweme_id: Video id\n- refresh_index: Paging index, default is 1, then increase by 1 each time for paging.\n- count: Number, default is 20, it is recommended to keep it unchanged.\n### Return:\n- Video data\n\n# [示例/Example]\naweme_id = \"7393365489105358132\"\nrefresh_index = 1\ncount = 20","operationId":"fetch_related_posts_api_v1_douyin_web_fetch_related_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7393365489105358132"},{"name":"refresh_index","in":"query","required":false,"schema":{"type":"integer","description":"翻页索引/Paging index","default":1,"title":"Refresh Index"},"description":"翻页索引/Paging index"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_post_videos":{"get":{"tags":["Douyin-Web-API"],"summary":"获取用户主页作品数据/Get user homepage video data","description":"# [中文]\n### 用途:\n- 获取用户主页作品数据\n- 注意：请尽量使用APP的接口而不是WEB的接口，因为WEB的接口可能会被不稳定。\n### 参数:\n- sec_user_id: 用户sec_user_id\n- max_cursor: 翻页游标，第一次请求传0，然后每次请求传上一次请求返回的max_cursor进行翻页。\n- count: 最大数量，建议不要超过20\n- filter_type: 过滤类型，可选参数如下：\n    - 0: 默认排序\n    - 3: 热度排序\n- cookie: 用户网页版抖音Cookie(此接口可以接受用户提供自己的Cookie)\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user homepage video data\n- Note: Please try to use the APP interface instead of the WEB API, because the WEB API may be unstable.\n### Parameters:\n- sec_user_id: User sec_user_id\n- max_cursor: Paging cursor, pass 0 for the first request, and then pass the max_cursor returned by the previous request for paging each time.\n- count: Maximum count number, it is recommended not to exceed 20\n- filter_type: Filter type, optional parameters are as follows:\n    - 0: Default sorting\n    - 3: Sort by popularity\n- cookie: User's web version of Douyin Cookie (This interface can accept users to provide their own Cookie)\n### Return:\n- User video data\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE\"\nmax_cursor = \"0\"\ncounts = 20\nfilter_type = \"0\"","operationId":"fetch_user_post_videos_api_v1_douyin_web_fetch_user_post_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":true,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE"},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"string","description":"最大游标/Maximum cursor","default":"0","title":"Max Cursor"},"description":"最大游标/Maximum cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"filter_type","in":"query","required":false,"schema":{"type":"string","description":"过滤类型/Filter type","default":"0","title":"Filter Type"},"description":"过滤类型/Filter type"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户网页版抖音Cookie/Your web version of Douyin Cookie","title":"Cookie"},"description":"用户网页版抖音Cookie/Your web version of Douyin Cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_like_videos":{"post":{"tags":["Douyin-Web-API"],"summary":"获取用户喜欢作品数据/Get user like video data","description":"# [中文]\n### 用途:\n- 获取用户喜欢作品数据\n### 参数:\n- sec_user_id: 用户sec_user_id\n- max_cursor: 最大游标\n- count: 最大数量\n- cookie: 用户网页版抖音Cookie(此接口需要用户提供自己的Cookie)\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user like video data\n### Parameters:\n- sec_user_id: User sec_user_id\n- max_cursor: Maximum cursor\n- count: Maximum count number\n- cookie: User's web version of Douyin Cookie (This interface requires users to provide their own Cookie)\n### Return:\n- User video data\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y\"\nmax_cursor = 0\ncounts = 20","operationId":"fetch_user_like_videos_api_v1_douyin_web_fetch_user_like_videos_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_user_like_videos_api_v1_douyin_web_fetch_user_like_videos_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/fetch_user_collection_videos":{"post":{"tags":["Douyin-Web-API"],"summary":"获取用户收藏作品数据/Get user collection video data","description":"# [中文]\n### 用途:\n- 获取用户收藏作品数据\n### 参数:\n- cookie: 用户网页版抖音Cookie(此接口需要用户提供自己的Cookie)\n- max_cursor: 最大游标\n- count: 最大数量\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user collection video data\n### Parameters:\n- cookie: User's web version of Douyin Cookie (This interface requires users to provide their own Cookie)\n- max_cursor: Maximum cursor\n- count: Maximum number\n### Return:\n- User video data\n\n# [示例/Example]\ncookie = \"YOUR_COOKIE\"\nmax_cursor = 0\ncounts = 20","operationId":"fetch_user_collection_videos_api_v1_douyin_web_fetch_user_collection_videos_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_user_collection_videos_api_v1_douyin_web_fetch_user_collection_videos_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/fetch_user_collects":{"post":{"tags":["Douyin-Web-API"],"summary":"获取用户收藏夹/Get user collection","description":"# [中文]\n### 用途:\n- 获取用户收藏夹\n### 参数:\n- max_cursor: 最大游标\n- count: 最大数量\n- cookie: 用户网页版抖音Cookie(此接口需要用户提供自己的Cookie)\n### 返回:\n- 用户收藏夹数据\n\n# [English]\n### Purpose:\n- Get user collection\n### Parameters:\n- max_cursor: Maximum cursor\n- count: Maximum number\n- cookie: User's web version of Douyin Cookie (This interface requires users to provide their own Cookie)\n### Return:\n- User collection data\n\n# [示例/Example]\ncookie = \"YOUR_COOKIE\"\nmax_cursor = 0\ncounts = 20","operationId":"fetch_user_collects_api_v1_douyin_web_fetch_user_collects_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_user_collects_api_v1_douyin_web_fetch_user_collects_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/fetch_user_collects_videos":{"get":{"tags":["Douyin-Web-API"],"summary":"获取用户收藏夹数据/Get user collection data","description":"# [中文]\n### 用途:\n- 获取用户收藏夹数据\n### 参数:\n- collects_id: 收藏夹id\n- max_cursor: 最大游标\n- count: 最大数量\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user collection data\n### Parameters:\n- collects_id: Collection id\n- max_cursor: Maximum cursor\n- count: Maximum number\n### Return:\n- User video data\n\n# [示例/Example]\ncollects_id = \"\"\nmax_cursor = 0\ncounts = 20","operationId":"fetch_user_collects_videos_api_v1_douyin_web_fetch_user_collects_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"collects_id","in":"query","required":true,"schema":{"type":"string","description":"收藏夹id/Collection id","title":"Collects Id"},"description":"收藏夹id/Collection id","example":""},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Maximum cursor","default":0,"title":"Max Cursor"},"description":"最大游标/Maximum cursor"},{"name":"counts","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Counts"},"description":"每页数量/Number per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_mix_videos":{"get":{"tags":["Douyin-Web-API"],"summary":"获取用户合辑作品数据/Get user mix video data","description":"# [中文]\n### 用途:\n- 获取用户合辑作品数据\n### 参数:\n- mix_id: 合辑id\n- max_cursor: 最大游标\n- count: 最大数量\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user mix video data\n### Parameters:\n- mix_id: Mix id\n- max_cursor: Maximum cursor\n- count: Maximum number\n### Return:\n- User video data\n\n# [示例/Example]\nurl = https://www.douyin.com/collection/7348687990509553679\nmix_id = \"7348687990509553679\"\nmax_cursor = 0\ncounts = 20","operationId":"fetch_user_mix_videos_api_v1_douyin_web_fetch_user_mix_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"mix_id","in":"query","required":true,"schema":{"type":"string","description":"合辑id/Mix id","title":"Mix Id"},"description":"合辑id/Mix id","example":"7348687990509553679"},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Maximum cursor","default":0,"title":"Max Cursor"},"description":"最大游标/Maximum cursor"},{"name":"counts","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Counts"},"description":"每页数量/Number per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_live_videos":{"get":{"tags":["Douyin-Web-API"],"summary":"获取用户直播流数据/Get user live video data","description":"# [中文]\n### 用途:\n- 获取用户直播流数据\n### 参数:\n- webcast_id: 直播间 webcast_id\n- 获取方法：\n    - 假设你的直播间链接为：https://www.douyin.com/root/live/376034101029\n    - 那么直播间webcast_id为：376034101029\n    - webcast_id为直播间链接的最后一段数字，与room_id不同。\n### 返回:\n- 直播流数据\n\n# [English]\n### Purpose:\n- Get user live video data\n### Parameters:\n- webcast_id: Room webcast_id\n- Acquisition method:\n    - Assuming your live room link is: https://www.douyin.com/root/live/376034101029\n    - Then the live room webcast_id is: 376034101029\n    - The webcast_id is the last number of the live room link, which is different from the room_id.\n### Return:\n- Live stream data\n\n# [示例/Example]\nwebcast_id = \"376034101029\"","operationId":"fetch_user_live_videos_api_v1_douyin_web_fetch_user_live_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"webcast_id","in":"query","required":true,"schema":{"type":"string","description":"直播间webcast_id/Room webcast_id","title":"Webcast Id"},"description":"直播间webcast_id/Room webcast_id","example":"376034101029"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_live_videos_by_sec_uid":{"get":{"tags":["Douyin-Web-API"],"summary":"通过sec_uid获取指定用户的直播流数据/Get live video data of specified user by sec_uid","description":"# [中文]\n### 用途:\n- 通过sec_uid获取指定用户的直播流数据\n### 参数:\n- sec_uid: 用户sec_uid，也叫 sec_user_id，可以在用户主页链接中找到。\n### 返回:\n- 直播流数据\n\n# [English]\n### Purpose\n- Get live video data of specified user by sec_uid\n### Parameters\n- sec_uid: User sec_uid, also called sec_user_id, can be found in the user's homepage link.\n### Return\n- Live stream data\n\n# [示例/Example]\nsec_uid = \"MS4wLjABAAAAAIKOBr_x6p2fPVKOAhqG8LrC1lwwdWChifKEsl-TXFS-kGSGqpMBRexJdzoAfvUF\"","operationId":"fetch_user_live_videos_by_sec_uid_api_v1_douyin_web_fetch_user_live_videos_by_sec_uid_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_uid/User sec_uid","title":"Sec Uid"},"description":"用户sec_uid/User sec_uid","example":"MS4wLjABAAAAAIKOBr_x6p2fPVKOAhqG8LrC1lwwdWChifKEsl-TXFS-kGSGqpMBRexJdzoAfvUF"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_live_videos_by_room_id":{"get":{"tags":["Douyin-Web-API"],"summary":"通过room_id获取指定用户的直播流数据 V1/Get live video data of specified user by room_id V1","description":"# [中文]\n### 用途:\n- 获取指定用户的直播流数据\n### 参数:\n- room_id: 直播间room_id\n### 返回:\n- 直播流数据\n\n# [English]\n### Purpose:\n- Get live video data of specified user\n### Parameters:\n- room_id: Room room_id\n### Return:\n- Live stream data\n\n# [示例/Example]\nroom_id = \"7318296342189919011\"","operationId":"fetch_user_live_videos_by_room_id_api_v1_douyin_web_fetch_user_live_videos_by_room_id_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间room_id/Room room_id","title":"Room Id"},"description":"直播间room_id/Room room_id","example":"7318296342189919011"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_live_videos_by_room_id_v2":{"get":{"tags":["Douyin-Web-API"],"summary":"通过room_id获取指定用户的直播流数据 V2/Gets the live stream data of the specified user by room_id V2","description":"# [中文]\n### 用途:\n- 获取指定用户的直播流数据V2\n### 参数:\n- room_id: 直播间room_id\n### 返回:\n- 直播流数据\n### 备注:\nmodify_time字段是直播间的最后更新时间，也就相当于开播时间，如果下播也不会重置回0，而是一直保持最后的更新时间。\n\n# [English]\n### Purpose:\n- Gets the live stream data of the specified user V2\n### Parameters:\n- room_id: Room room_id\n### Return:\n- Live stream data\n### Note:\nThe modify_time field is the last update time of the live room, which is equivalent to the start time. If the live stream is offline, it will not be reset to 0, but will always maintain the last update time.\n\n# [示例/Example]\nroom_id = \"7462723839303093032\"","operationId":"fetch_user_live_videos_by_room_id_v2_api_v1_douyin_web_fetch_user_live_videos_by_room_id_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间room_id/Room room_id","title":"Room Id"},"description":"直播间room_id/Room room_id","example":"7462723839303093032"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_live_gift_ranking":{"get":{"tags":["Douyin-Web-API"],"summary":"获取直播间送礼用户排行榜/Get live room gift user ranking","description":"# [中文]\n### 用途:\n- 获取直播间送礼用户排行榜\n### 参数:\n- room_id: 直播间room_id\n- rank_type: 排行类型，默认为30不用修改。\n### 返回:\n- 排行榜数据\n\n# [English]\n### Purpose:\n- Get live room gift user ranking\n### Parameters:\n- room_id: Room room_id\n- rank_type: Leaderboard type, default is 30, no need to modify.\n### Return:\n- Leaderboard data\n\n# [示例/Example]\nroom_id = \"7356585666190461731\"\nrank_type = 30","operationId":"fetch_live_gift_ranking_api_v1_douyin_web_fetch_live_gift_ranking_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间room_id/Room room_id","title":"Room Id"},"description":"直播间room_id/Room room_id","example":"7356585666190461731"},{"name":"rank_type","in":"query","required":false,"schema":{"type":"integer","description":"排行类型/Leaderboard type","default":30,"title":"Rank Type"},"description":"排行类型/Leaderboard type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_live_room_product_result":{"get":{"tags":["Douyin-Web-API"],"summary":"抖音直播间商品信息/Douyin live room product information","description":"# [中文]\n### 用途:\n- 抖音直播间商品信息\n### 参数:\n- cookie: 用户网页版抖音Cookie(此接口需要用户提供自己的Cookie，如获取失败请手动过一次验证码)\n- room_id: 直播间room_id\n- author_id: 作者id\n- offset: 偏移量\n- limit: 数量\n### 返回:\n- 商品信息\n### 备注:\nauthor_id的获取方法：\n    1. 通过用户的sec_user_id获取用户信息接口获取uid字段即为author_id。\n    2. 通过直播间room_id获取直播间信息接口获取author_id字段。\nroon_id不是固定不变的，每次开播都会变化。\n\n# [English]\n### Purpose:\n- Douyin live room product information\n### Parameters:\n- cookie: User's web version of Douyin Cookie (This interface requires users to provide their own Cookie, if the acquisition fails, please manually pass the captcha code once)\n- room_id: Room room_id\n- author_id: Author id\n- offset: Offset\n- limit: Number\n### Return:\n- Product information\n### Note:\nThe method to obtain author_id:\n    1. Obtain the uid field as author_id through the user information interface by sec_user_id.\n    2. Obtain the author_id field through the live room information interface by room_id.\nThe roon_id is not fixed, it changes every time the live broadcast starts.\n\n# [示例/Example]\ncookie = \"YOUR_COOKIE\"\nroom_id = \"7356742011975715619\"\nauthor_id = \"2207432981615527\"\noffset = 0\nlimit = 20","operationId":"fetch_live_room_product_result_api_v1_douyin_web_fetch_live_room_product_result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间room_id/Room room_id","title":"Room Id"},"description":"直播间room_id/Room room_id","example":"7360830184578091776"},{"name":"author_id","in":"query","required":true,"schema":{"type":"string","description":"作者id/Author id","title":"Author Id"},"description":"作者id/Author id","example":"1714858898241277"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Limit"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_product_detail":{"get":{"tags":["Douyin-Web-API"],"summary":"获取商品详情/Get product detail","description":"# [中文]\n### 用途:\n- 获取商品详情信息\n### 参数:\n- product_id: 商品ID（必填）\n- aweme_id: 作品ID（可选，如果商品来自某个视频）\n- room_id: 直播间ID（可选，如果商品来自直播间）\n- sec_user_id: 用户sec_user_id（可选，商品所属用户）\n### 返回:\n- 商品详细信息\n\n# [English]\n### Purpose:\n- Get product detail information\n### Parameters:\n- product_id: Product ID (required)\n- aweme_id: Video ID (optional, if product is from a video)\n- room_id: Room ID (optional, if product is from live room)\n- sec_user_id: User sec_user_id (optional, product owner)\n### Return:\n- Product detail information\n\n# [示例/Example]\nproduct_id = \"3654018325143066950\"\naweme_id = \"7546956331878501673\"  # 可选\nroom_id = \"\"  # 可选\nsec_user_id = \"MS4wLjABAAAALoWx-cZWuQVWWvvlE-HiKgm9jel_nmwMcjAMIaEAwFq25sskN1Zgqy_T3x4D0Goy\"  # 可选","operationId":"fetch_product_detail_api_v1_douyin_web_fetch_product_detail_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"3654018325143066950"},{"name":"aweme_id","in":"query","required":false,"schema":{"type":"string","description":"作品ID（可选）/Video ID (optional)","default":"7546956331878501673","title":"Aweme Id"},"description":"作品ID（可选）/Video ID (optional)"},{"name":"room_id","in":"query","required":false,"schema":{"type":"string","description":"直播间ID（可选）/Room ID (optional)","title":"Room Id"},"description":"直播间ID（可选）/Room ID (optional)"},{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id（可选）/User sec_user_id (optional)","default":"MS4wLjABAAAALoWx-cZWuQVWWvvlE-HiKgm9jel_nmwMcjAMIaEAwFq25sskN1Zgqy_T3x4D0Goy","title":"Sec User Id"},"description":"用户sec_user_id（可选）/User sec_user_id (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_product_sku_list":{"get":{"tags":["Douyin-Web-API"],"summary":"获取商品SKU列表/Get product SKU list","description":"# [中文]\n\n获取商品SKU列表\n\n# [English]\n\nGet product SKU list\n\n# [示例/Example]\n\nproduct_id = \"3770337983790711029\"\nauthor_id = \"3109048548866375\"","operationId":"fetch_product_sku_list_api_v1_douyin_web_fetch_product_sku_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"3770337983790711029"},{"name":"author_id","in":"query","required":true,"schema":{"type":"string","description":"作者ID/Author ID","title":"Author Id"},"description":"作者ID/Author ID","example":"3109048548866375"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_product_coupon":{"get":{"tags":["Douyin-Web-API"],"summary":"获取商品优惠券信息/Get product coupon information","description":"# [中文]\n\n获取商品优惠券相关信息\n\n# [English]\n\nGet product coupon information\n\n# [示例/Example]\n\nproduct_id = \"3770337983790711029\"\nshop_id = \"129508461\"\nprice = \"1490\"\nauthor_id = \"3109048548866375\"\nsec_user_id = \"MS4wLjABAAAALoWx-cZWuQVWWvvlE-HiKgm9jel_nmwMcjAMIaEAwFq25sskN1Zgqy_T3x4D0Goy\"","operationId":"fetch_product_coupon_api_v1_douyin_web_fetch_product_coupon_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"3770337983790711029"},{"name":"shop_id","in":"query","required":true,"schema":{"type":"string","description":"店铺ID/Shop ID","title":"Shop Id"},"description":"店铺ID/Shop ID","example":"129508461"},{"name":"price","in":"query","required":true,"schema":{"type":"string","description":"价格/Price","title":"Price"},"description":"价格/Price","example":"1490"},{"name":"author_id","in":"query","required":true,"schema":{"type":"string","description":"作者ID/Author ID","title":"Author Id"},"description":"作者ID/Author ID","example":"3109048548866375"},{"name":"sec_user_id","in":"query","required":true,"schema":{"type":"string","description":"作者ID/Secure Author ID","title":"Sec User Id"},"description":"作者ID/Secure Author ID","example":"MS4wLjABAAAALoWx-cZWuQVWWvvlE-HiKgm9jel_nmwMcjAMIaEAwFq25sskN1Zgqy_T3x4D0Goy"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_product_review_score":{"get":{"tags":["Douyin-Web-API"],"summary":"获取商品评价评分/Get product review score","description":"# [中文]\n\n获取商品评价评分\n\n# [English]\n\nGet product review score\n\n# [示例/Example]\n\nproduct_id = \"3770337983790711029\"\nshop_id = \"129508461\"","operationId":"fetch_product_review_score_api_v1_douyin_web_fetch_product_review_score_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"3770337983790711029"},{"name":"shop_id","in":"query","required":true,"schema":{"type":"string","description":"店铺ID/Shop ID","title":"Shop Id"},"description":"店铺ID/Shop ID","example":"129508461"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_product_review_list":{"get":{"tags":["Douyin-Web-API"],"summary":"获取商品评价列表/Get product review list","description":"# [中文]\n\n获取商品评价列表\n\n# [English]\n\nGet product review list\n\n# [示例/Example]\n\nproduct_id = \"3770337983790711029\"\nshop_id = \"129508461\"\ncursor = 0\ncount = 20\nsort_type = 0  # 0: 默认排序, 1: 最新排序","operationId":"fetch_product_review_list_api_v1_douyin_web_fetch_product_review_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"product_id","in":"query","required":true,"schema":{"type":"string","description":"商品ID/Product ID","title":"Product Id"},"description":"商品ID/Product ID","example":"3770337983790711029"},{"name":"shop_id","in":"query","required":true,"schema":{"type":"string","description":"店铺ID/Shop ID","title":"Shop Id"},"description":"店铺ID/Shop ID","example":"129508461"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Count","default":20,"title":"Count"},"description":"数量/Count"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型 (0: 默认排序, 1: 最新排序)/Sort Type (0: Default, 1: Latest)","default":0,"title":"Sort Type"},"description":"排序类型 (0: 默认排序, 1: 最新排序)/Sort Type (0: Default, 1: Latest)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_profile_by_uid":{"get":{"tags":["Douyin-Web-API"],"summary":"使用UID获取用户信息/Get user information by UID","description":"# [中文]\n### 用途:\n- 使用UID获取用户信息\n### 参数:\n- uid: 用户UID\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get user information by UID\n### Parameters:\n- uid: User UID\n### Return:\n- User information\n\n# [示例/Example]\nuid = \"68141954464\"","operationId":"fetch_user_profile_by_uid_api_v1_douyin_web_fetch_user_profile_by_uid_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户UID/User UID","title":"Uid"},"description":"用户UID/User UID","example":"68141954464"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_batch_user_profile_v1":{"get":{"tags":["Douyin-Web-API"],"summary":"获取批量用户信息(最多10个)/Get batch user profile (up to 10)","description":"# [中文]\n### 用途:\n- 获取批量用户信息，最多支持10个用户\n### 参数:\n- sec_user_ids: 用户sec_user_id列表，用逗号分隔，最多10个\n### 返回:\n- 批量用户信息\n\n# [English]\n### Purpose:\n- Get batch user profile, up to 10 users\n### Parameters:\n- sec_user_ids: User sec_user_id list, separated by commas, up to 10\n### Return:\n- Batch user profile\n\n# [示例/Example]\nsec_user_ids = \"MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE,MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y\"","operationId":"fetch_batch_user_profile_v1_api_v1_douyin_web_fetch_batch_user_profile_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_ids","in":"query","required":true,"schema":{"type":"string","description":"用户sec_user_id列表，用逗号分隔/User sec_user_id list, separated by commas","title":"Sec User Ids"},"description":"用户sec_user_id列表，用逗号分隔/User sec_user_id list, separated by commas","example":"MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE,MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_batch_user_profile_v2":{"get":{"tags":["Douyin-Web-API"],"summary":"获取批量用户信息(最多50个)/Get batch user profile (up to 50)","description":"# [中文]\n### 用途:\n- 获取批量用户信息，最多支持50个用户\n### 参数:\n- sec_user_ids: 用户sec_user_id列表，用逗号分隔，最多50个\n### 返回:\n- 批量用户信息\n\n# [English]\n### Purpose:\n- Get batch user profile, up to 50 users\n### Parameters:\n- sec_user_ids: User sec_user_id list, separated by commas, up to 50\n### Return:\n- Batch user profile\n\n# [示例/Example]\nsec_user_ids = \"MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE,MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y\"","operationId":"fetch_batch_user_profile_v2_api_v1_douyin_web_fetch_batch_user_profile_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_ids","in":"query","required":true,"schema":{"type":"string","description":"用户sec_user_id列表，用逗号分隔/User sec_user_id list, separated by commas","title":"Sec User Ids"},"description":"用户sec_user_id列表，用逗号分隔/User sec_user_id list, separated by commas","example":"MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE,MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_live_info_by_uid":{"get":{"tags":["Douyin-Web-API"],"summary":"使用UID获取用户开播信息/Get user live information by UID","description":"# [中文]\n### 用途:\n- 使用UID获取用户开播信息\n### 参数:\n- uid: 用户UID\n### 返回:\n- 用户开播信息，包含room_id与live_status\n\n# [English]\n### Purpose:\n- Get user live information by UID\n### Parameters:\n- uid: User UID\n### Return:\n- User live information, including room_id and live_status\n\n# [示例/Example]\nuid = \"3081254195702747\"","operationId":"fetch_user_live_info_by_uid_api_v1_douyin_web_fetch_user_live_info_by_uid_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户UID/User UID","title":"Uid"},"description":"用户UID/User UID","example":"3081254195702747"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_profile_by_short_id":{"get":{"tags":["Douyin-Web-API"],"summary":"使用Short ID获取用户信息/Get user information by Short ID","description":"# [中文]\n### 用途:\n- 使用Short ID获取用户信息\n### 参数:\n- short_id: 用户Short ID\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get user information by Short ID\n### Parameters:\n- short_id: User Short ID\n### Return:\n- User information\n\n# [示例/Example]\nshort_id = \"114131058\"","operationId":"fetch_user_profile_by_short_id_api_v1_douyin_web_fetch_user_profile_by_short_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"short_id","in":"query","required":true,"schema":{"type":"string","description":"用户Short ID/User Short ID","title":"Short Id"},"description":"用户Short ID/User Short ID","example":"114131058"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/handler_shorten_url":{"get":{"tags":["Douyin-Web-API"],"summary":"生成短链接","operationId":"handler_shorten_url_api_v1_douyin_web_handler_shorten_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target_url","in":"query","required":true,"schema":{"type":"string","description":"待转换的短链接/Target URL to be converted","title":"Target Url"},"description":"待转换的短链接/Target URL to be converted","example":"https://www.douyin.com/video/7575136499386720761"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/handler_user_profile":{"get":{"tags":["Douyin-Web-API"],"summary":"使用sec_user_id获取指定用户的信息/Get information of specified user by sec_user_id","description":"# [中文]\n### 用途:\n- 获取指定用户的信息\n### 参数:\n- sec_user_id: 用户sec_user_id\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get information of specified user\n### Parameters:\n- sec_user_id: User sec_user_id\n### Return:\n- User information\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y\"","operationId":"handler_user_profile_api_v1_douyin_web_handler_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":true,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/handler_user_profile_v2":{"get":{"tags":["Douyin-Web-API"],"summary":"使用unique_id（抖音号）获取指定用户的信息/Get information of specified user by unique_id","description":"# [中文]\n### 用途:\n- 根据抖音号获取指定用户的信息\n### 参数:\n- unique_id: 用户unique_id\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get information of specified user by unique_id\n### Parameters:\n- unique_id: User unique_id\n### Return:\n- User information\n\n# [示例/Example]\nunique_id = \"TheChief\"","operationId":"handler_user_profile_v2_api_v1_douyin_web_handler_user_profile_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"unique_id","in":"query","required":true,"schema":{"type":"string","description":"用户unique_id/User unique_id","title":"Unique Id"},"description":"用户unique_id/User unique_id","example":"TheChief"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/encrypt_uid_to_sec_user_id":{"get":{"tags":["Douyin-Web-API"],"summary":"加密用户uid到sec_user_id/Encrypt user uid to sec_user_id","description":"# [中文]\n### 用途:\n- 加密用户uid到sec_user_id\n### 参数:\n- uid: 用户uid，也就是抖音号的short_id\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Encrypt user uid to sec_user_id\n### Parameters:\n- uid: User uid, which is the short_id of the Douyin number\n### Return:\n- User information\n\n# [示例/Example]\nuid = \"1673937488185292\"","operationId":"encrypt_uid_to_sec_user_id_api_v1_douyin_web_encrypt_uid_to_sec_user_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户uid(short_id)/User uid(short_id)","title":"Uid"},"description":"用户uid(short_id)/User uid(short_id)","example":"1673937488185292"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/handler_user_profile_v3":{"get":{"tags":["Douyin-Web-API"],"summary":"根据抖音uid获取指定用户的信息/Get information of specified user by uid","description":"# [中文]\n### 用途:\n- 根据抖音uid获取指定用户的信息\n### 参数:\n- uid: 用户uid，也就是抖音号的short_id\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get information of specified user by unique_id\n### Parameters:\n- uid: User uid, which is the short_id of the Douyin number\n### Return:\n- User information\n\n# [示例/Example]\nuid = \"1673937488185292\"","operationId":"handler_user_profile_v3_api_v1_douyin_web_handler_user_profile_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户uid(short_id)/User uid(short_id)","title":"Uid"},"description":"用户uid(short_id)/User uid(short_id)","example":"1673937488185292"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/handler_user_profile_v4":{"get":{"tags":["Douyin-Web-API"],"summary":"根据sec_user_id获取指定用户的信息（性别，年龄，直播等级、牌子）/Get information of specified user by sec_user_id (gender, age, live level、brand)","description":"# [中文]\n### 用途:\n- 获取指定用户的信息\n### 参数:\n- sec_user_id: 用户sec_user_id\n### 返回:\n- 用户信息，包含性别，年龄，直播等级，直播间牌子\n### 说明：\n- 性别：1为男，2为女，0为未知，在live_user字段中。\n- 年龄：在user字段中，-1为未知。\n\n# [English]\n### Purpose:\n- Get information of specified user\n### Parameters:\n- sec_user_id: User sec_user_id\n### Return:\n- User information, including gender, age, live level, live room brand\n### Description:\n- gender: 1 male, 2 female, 0 unknown, in the live_user field.\n- age: in the user field, -1 unknown.\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y\"","operationId":"handler_user_profile_v4_api_v1_douyin_web_handler_user_profile_v4_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":true,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_fans_list":{"get":{"tags":["Douyin-Web-API"],"summary":"获取用户粉丝列表/Get user fans list","description":"# [中文]\n### 用途:\n- 获取用户粉丝列表\n- 第一次请求时，max_time传`0`，source_type传`2`，然后会返回一个空的粉丝列表，里面包含了max_time，然后再次请求时，max_time传上一次请求返回的max_time，source_type传`1`，即可获取到粉丝列表。\n- 如果不按照上述方式请求，可能会导致返回数据包含重复数据。\n\n### 参数:\n- sec_user_id: 用户sec_user_id\n- max_time: 最大时间戳，默认为0，后续从返回数据中获取，用于翻页。\n- count: 数量，默认为20，建议保持不变。\n- source_type: 来源类型，默认为`1`，第一次请求时使用`2`作为来源类型，然后再次请求时使用`1`作为来源类型。\n### 返回:\n- 粉丝列表\n\n# [English]\n### Purpose:\n- Get user fans list\n- When requesting for the first time, pass `0` for max_time, pass `2` for source_type, and an empty fans list will be returned, which contains max_time, then pass the max_time returned by the previous request for paging each time, pass `1` for source_type, you can get the fans list.\n- If you do not request according to the above method, it may cause the returned data to contain duplicate data.\n\n### Parameters:\n- sec_user_id: User sec_user_id\n- max_time: Maximum timestamp, default is 0, get from the returned data later, used for paging.\n- count: Number, default is 20, it is recommended to keep it unchanged.\n- source_type: Source type, default is `1`, use `2` as the source type for the first request, and then use `1` as the source type for the subsequent request.\n### Return:\n- Fans list\n\n# [示例/Example]\nsec_user = \"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70\"\nmax_time = \"0\"\ncount = 20\nsource_type = 2","operationId":"fetch_user_fans_list_api_v1_douyin_web_fetch_user_fans_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","default":"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id"},{"name":"max_time","in":"query","required":false,"schema":{"type":"string","description":"最大时间戳/Maximum timestamp","default":"0","title":"Max Time"},"description":"最大时间戳/Maximum timestamp"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"source_type","in":"query","required":false,"schema":{"type":"integer","description":"来源类型/Source type","default":1,"title":"Source Type"},"description":"来源类型/Source type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_following_list":{"get":{"tags":["Douyin-Web-API"],"summary":"获取用户关注列表/Get user following list","description":"# [中文]\n### 用途:\n- 获取用户关注列表\n- 第一次请求时，max_time传`0`，source_type传`2`，然后会返回一个空的粉丝列表，里面包含了max_time，然后再次请求时，max_time传上一次请求返回的max_time，source_type传`1`，即可获取到粉丝列表。\n- 如果不按照上述方式请求，可能会导致返回数据包含重复数据。\n### 参数:\n- sec_user_id: 用户sec_user_id\n- max_time: 最大时间戳，默认为0，后续从返回数据中获取，用于翻页。\n- count: 数量，默认为20，建议保持不变。\n- source_type: 来源类型，默认为`1`，第一次请求时使用`2`作为来源类型，然后再次请求时使用`1`作为来源类型。\n### 返回:\n- 关注列表\n\n# [English]\n### Purpose:\n- Get user following list\n- When requesting for the first time, pass `0` for max_time, pass `2` for source_type, and an empty fans list will be returned, which contains max_time, then pass the max_time returned by the previous request for paging each time, pass `1` for source_type, you can get the fans list.\n- If you do not request according to the above method, it may cause the returned data to contain duplicate data.\n\n### Parameters:\n- sec_user_id: User sec_user_id\n- max_time: Maximum timestamp, default is 0, get from the returned data later, used for paging.\n- count: Number, default is 20, it is recommended to keep it unchanged.\n- source_type: Source type, default is `1`, use `2` as the source type for the first request, and then use `1` as the source type for the subsequent request.\n### Return:\n- Following list\n\n# [示例/Example]\nsec_user = \"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70\"\nmax_time = \"0\"\ncount = 20\nsource_type = 2","operationId":"fetch_user_following_list_api_v1_douyin_web_fetch_user_following_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","default":"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id"},{"name":"max_time","in":"query","required":false,"schema":{"type":"string","description":"最大时间戳/Maximum timestamp","default":"0","title":"Max Time"},"description":"最大时间戳/Maximum timestamp"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"source_type","in":"query","required":false,"schema":{"type":"integer","description":"来源类型/Source type","default":1,"title":"Source Type"},"description":"来源类型/Source type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_video_comments":{"get":{"tags":["Douyin-Web-API"],"summary":"获取单个视频评论数据/Get single video comments data","description":"# [中文]\n### 用途:\n- 获取单个视频评论数据\n### 参数:\n- aweme_id: 作品id\n- cursor: 游标\n- count: 数量\n### 返回:\n- 评论数据\n\n# [English]\n### Purpose:\n- Get single video comments data\n### Parameters:\n- aweme_id: Video id\n- cursor: Cursor\n- count: Number\n### Return:\n- Comments data\n\n# [示例/Example]\naweme_id = \"7372484719365098803\"\ncursor = 0\ncount = 20","operationId":"fetch_video_comments_api_v1_douyin_web_fetch_video_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7372484719365098803"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_video_comment_replies":{"get":{"tags":["Douyin-Web-API"],"summary":"获取指定视频的评论回复数据/Get comment replies data of specified video","description":"# [中文]\n### 用途:\n- 获取指定视频的评论回复数据\n### 参数:\n- item_id: 作品id\n- comment_id: 评论id\n- cursor: 游标\n- count: 数量\n### 返回:\n- 评论回复数据\n\n# [English]\n### Purpose:\n- Get comment replies data of specified video\n### Parameters:\n- item_id: Video id\n- comment_id: Comment id\n- cursor: Cursor\n- count: Number\n### Return:\n- Comment replies data\n\n# [示例/Example]\naweme_id = \"7354666303006723354\"\ncomment_id = \"7354669356632638218\"\ncursor = 0\ncount = 20","operationId":"fetch_video_comments_reply_api_v1_douyin_web_fetch_video_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7354666303006723354"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论id/Comment id","title":"Comment Id"},"description":"评论id/Comment id","example":"7354669356632638218"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_general_search_result":{"get":{"tags":["Douyin-Web-API"],"summary":"[已弃用/Deprecated] 获取指定关键词的综合搜索结果/Get comprehensive search results of specified keywords","description":"# [中文]\n## ⚠️ 此接口已弃用，不再维护，可能无法正常使用。请使用抖音搜索系列接口替代：https://docs.tikhub.io/370212773e0\n### 用途:\n- 获取指定关键词的综合搜索结果，此接口有概率失败，如果失败请使用同样的参数重新请求 1-3次。\n- 推荐默认使用专门的搜索接口，稳定性更好：https://docs.tikhub.io/370212773e0\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量\n- sort_type: 0:综合排序 1:最多点赞 2:最新发布\n- publish_time: 0:不限 1:最近一天 7:最近一周 180:最近半年\n- filter_duration: 0:不限 0-1:1分钟以内 1-5:1-5分钟 5-10000:5分钟以上\n-search_range: 0:不限 1:最近看过 2:还未看过 3:关注的人\n-content_type: 0:不限 1:视频 2:图集\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### 返回:\n- 综合搜索结果\n\n# [English]\n## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly. Please use the Douyin Search API instead: https://docs.tikhub.io/370212773e0\n### Purpose:\n- Get comprehensive search results of specified keywords, this interface may fail, if it fails, please use the same parameters to request 1-3 times again.\n- It is recommended to use the dedicated search interface by default, which is more stable: https://docs.tikhub.io/370212773e0\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number\n- sort_type: 0: Comprehensive sorting 1: Most likes 2: Latest release\n- publish_time: 0: Unlimited 1: Last day 7: Last week 180: Last half year\n- filter_duration: 0: Unlimited 0-1: Within 1 minute 1-5: 1-5 minutes 5-10000: More than 5 minutes\n- search_range: 0: Unlimited 1: Recently viewed 2: Not yet viewed 3: Followed\n- content_type: 0: Unlimited 1: Video 2: Album\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### Return:\n- Comprehensive search results\n\n# [示例/Example]\nkeyword = \"中华娘\"\noffset = 0\ncount = 20\nsort_type = \"0\"\npublish_time = \"0\"\nfilter_duration = \"0\"","operationId":"fetch_general_search_result_api_v1_douyin_web_fetch_general_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序类型/Sort type","default":"0","title":"Sort Type"},"description":"排序类型/Sort type"},{"name":"publish_time","in":"query","required":false,"schema":{"type":"string","description":"发布时间/Publish time","default":"0","title":"Publish Time"},"description":"发布时间/Publish time"},{"name":"filter_duration","in":"query","required":false,"schema":{"type":"string","description":"视频时长/Duration filter","default":"0","title":"Filter Duration"},"description":"视频时长/Duration filter"},{"name":"search_range","in":"query","required":false,"schema":{"type":"string","description":"搜索范围/Search range","default":"0","title":"Search Range"},"description":"搜索范围/Search range"},{"name":"content_type","in":"query","required":false,"schema":{"type":"string","description":"内容类型/Content type","default":"0","title":"Content Type"},"description":"内容类型/Content type"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_video_search_result":{"get":{"tags":["Douyin-Web-API"],"summary":"[已弃用/Deprecated] 获取指定关键词的视频搜索结果/Get video search results of specified keywords","description":"# [中文]\n## ⚠️ 此接口已弃用，不再维护，可能无法正常使用。请使用抖音搜索系列接口替代：https://docs.tikhub.io/370212780e0\n### 用途:\n- 获取指定关键词的视频搜索结果，此接口有概率失败，如果失败请使用同样的参数重新请求 1-3次，目前的失败率在5%以下。\n- 此接口收费相较于其他搜索接口便宜，但是稳定性差，需要配合重试机制使用。\n- 请求价格：0.001$ / 次\n- 推荐默认使用专门的搜索接口，稳定性更好：https://docs.tikhub.io/370212780e0\n### 参数:\n- keyword: 关键词\n- offset: 偏移量，第一次请求时为0，后续从返回数据中获取，用于翻页。\n    - 例如: offset = 10\n    - JSON Path-1 : $.data.cursor\n- count: 数量，默认为10，建议保持不变。\n- sort_type:\n    - 0:综合排序\n    - 1:最多点赞\n    - 2:最新发布\n- publish_time:\n    - 0:不限\n    - 1:最近一天\n    - 7:最近一周\n    - 180:最近半年\n- filter_duration:\n    - 0:不限 0-1:1分钟以内\n    - 1-5:1-5分钟\n    - 5-10000:5分钟以上\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### 返回:\n- 视频搜索结果\n\n# [English]\n## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly. Please use the Douyin Search API instead: https://docs.tikhub.io/370212780e0\n### Purpose:\n- Get video search results of specified keywords, this interface may fail, if it fails, please use the same parameters to request 1-3 times again, the current failure rate is below 5%.\n- This interface is cheaper than other search interfaces, but the stability is poor and needs to be used with a retry mechanism.\n- Request price: 0.001$ / time\n- It is recommended to use the dedicated search interface by default, which is more stable: https://docs.tikhub.io/370212780e0\n### Parameters:\n- keyword: Keyword\n- offset: Offset, 0 for the first request, get from the returned data later, used for paging.\n    - For example: offset = 10\n    - JSON Path-1 : $.data.cursor\n- count: Number, default is 10, it is recommended to keep it unchanged.\n- sort_type:\n    - 0: Comprehensive sorting\n    - 1: Most likes\n    - 2: Latest release\n- publish_time:\n    - 0: Unlimited\n    - 1: Last day\n    - 7: Last week\n    - 180: Last half year\n- filter_duration:\n    - 0: Unlimited\n    - 0-1: Within 1 minute\n    - 1-5: 1-5 minutes\n    - 5-10000: More than 5 minutes\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### Return:\n- Video search results\n\n# [示例/Example]\nkeyword = \"游戏\"\noffset = 0\ncount = 10\nsort_type = \"0\"\npublish_time = \"0\"\nfilter_duration = \"0\"\nsearch_id = \"\"","operationId":"fetch_video_search_result_api_v1_douyin_web_fetch_video_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"游戏"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序类型/Sort type","default":"0","title":"Sort Type"},"description":"排序类型/Sort type"},{"name":"publish_time","in":"query","required":false,"schema":{"type":"string","description":"发布时间/Publish time","default":"0","title":"Publish Time"},"description":"发布时间/Publish time"},{"name":"filter_duration","in":"query","required":false,"schema":{"type":"string","description":"视频时长/Duration filter","default":"0","title":"Filter Duration"},"description":"视频时长/Duration filter"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_video_search_result_v2":{"get":{"tags":["Douyin-Web-API"],"summary":"获取指定关键词的视频搜索结果 V2 （废弃，替代接口请参考下方文档）/Get video search results of specified keywords V2 (Deprecated, please refer to the following document for replacement interface)","description":"# [中文]\n## ⚠️ 此接口已弃用，不再维护，可能无法正常使用。请使用抖音搜索系列接口替代：https://docs.tikhub.io/370212780e0\n### 用途:\n- 获取指定关键词的视频搜索结果V2，此接口稳定性更好，收费更贵，当`/api/v1/douyin/web/fetch_video_search_result`接口不稳定时，建议使用此接口。\n- 收费标准为：0.01$每次请求。\n- 推荐默认使用专门的搜索接口，稳定性更好：https://docs.tikhub.io/370212780e0\n### 参数:\n- keyword: 关键词\n- sort_type:\n    - 排序类型，可用值如下：\n    - _0 :综合(General)\n    - _1 :最多点赞(More likes)\n    - _2 :最新发布(New)\n- publish_time：\n    - 发布时间，可用值如下：\n    - _0 :不限(No Limit)\n    - _1 :一天之内(last 1 day)\n    - _7 :一周之内(last 1 week)\n    - _180 :半年之内(last half year)\n- filter_duration：\n    - 视频时长，可用值如下：\n    - _0 :不限(No Limit)\n    - _1 :1分钟以下(1 minute and below)\n    - _2 :1-5分钟 (1-5 minutes)\n    - _3 :5分钟以上(5 minutes more)\n- page: 页码\n    - 默认从1开始，然后依次递增加1\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### 返回:\n- 视频搜索结果V2\n\n# [English]\n## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly. Please use the Douyin Search API instead: https://docs.tikhub.io/370212780e0\n### Purpose:\n- Get video search results of specified keywords V2, this interface has better stability and higher cost, when the `/api/v1/douyin/web/fetch_video_search_result` interface is unstable, it is recommended to use this interface.\n- The charging standard is: $0.01 per request.\n- It is recommended to use the dedicated search interface by default, which is more stable: https://docs.tikhub.io/370212780e0\n### Parameters:\n- keyword: Keyword\n- sort_type:\n    - Sort type, available values are as follows:\n    - _0 : General\n    - _1 : More likes\n    - _2 : New\n- publish_time:\n    - Publish time, available values are as follows:\n    - _0 : No Limit\n    - _1 : last 1 day\n    - _7 : last 1 week\n    - _180 : last half year\n- filter_duration:\n    - Duration filter, available values are as follows:\n    - _0 : No Limit\n    - _1 : 1 minute and below\n    - _2 : 1-5 minutes\n    - _3 : 5 minutes more\n- page: Page\n    - Start from 1 by default, then increase by 1 each time\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### Return:\n- Video search results V2\n\n# [示例/Example]\nkeyword = \"中华娘\"\nsort_type = \"_0\"\npublish_time = \"_0\"\nfilter_duration = \"_0\"\npage = 1\nsearch_id = \"\"","operationId":"fetch_video_search_result_v2_api_v1_douyin_web_fetch_video_search_result_v2_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序类型/Sort type","default":"_0","title":"Sort Type"},"description":"排序类型/Sort type"},{"name":"publish_time","in":"query","required":false,"schema":{"type":"string","description":"发布时间/Publish time","default":"_0","title":"Publish Time"},"description":"发布时间/Publish time"},{"name":"filter_duration","in":"query","required":false,"schema":{"type":"string","description":"视频时长/Duration filter","default":"_0","title":"Filter Duration"},"description":"视频时长/Duration filter"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page","default":1,"title":"Page"},"description":"页码/Page"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_search_result":{"get":{"tags":["Douyin-Web-API"],"summary":"获取指定关键词的用户搜索结果(废弃，替代接口请参考下方文档)/Get user search results of specified keywords (deprecated, please refer to the following document for replacement interface)","description":"# [中文]\n## ⚠️ 此接口已弃用，不再维护，可能无法正常使用。请使用抖音搜索系列接口替代：https://docs.tikhub.io/370212785e0\n### 用途:\n- 获取指定关键词的用户搜索结果\n- 推荐默认使用专门的搜索接口，稳定性更好：https://docs.tikhub.io/370212785e0\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量\n- douyin_user_fans: 留空:不限, \"0_1k\": 1000以下, \"1k_1w\": 1000-1万, \"1w_10w\": 1w-10w, \"10w_100w\": 10w-100w，\"100w_\": 100w以上\n- douyin_user_type: 留空:不限, \"common_user\": 普通用户, \"enterprise_user\": 企业认证, \"personal_user\": 个人认证\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### 返回:\n- 用户搜索结果\n\n# [English]\n## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly. Please use the Douyin Search API instead: https://docs.tikhub.io/370212785e0\n### Purpose:\n- Get user search results of specified keywords\n- It is recommended to use the dedicated search interface by default, which is more stable: https://docs.tikhub.io/370212785e0\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number\n- douyin_user_fans: Leave blank: Unlimited, \"0_1k\": Below 1000, \"1k_1w\": 1000-10,000, \"1w_10w\": 10,000-100,000, \"10w_100w\": 100,000-1 million, \"100w_\": More than 1 million\n- douyin_user_type: Leave blank: Unlimited, \"common_user\": Ordinary user, \"enterprise_user\": Enterprise certification, \"personal_user\": Personal certification\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### Return:\n- User search results\n\n# [示例/Example]\nkeyword = \"动漫\"\noffset = 0\ncount = 20\ndouyin_user_fans = \"\"\ndouyin_user_type = \"\"\nsearch_id = \"\"","operationId":"fetch_user_search_result_api_v1_douyin_web_fetch_user_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"douyin_user_fans","in":"query","required":false,"schema":{"type":"string","description":"粉丝数/Fans","default":"","title":"Douyin User Fans"},"description":"粉丝数/Fans"},{"name":"douyin_user_type","in":"query","required":false,"schema":{"type":"string","description":"用户类型/User type","default":"","title":"Douyin User Type"},"description":"用户类型/User type"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_search_result_v2":{"get":{"tags":["Douyin-Web-API"],"summary":"获取指定关键词的用户搜索结果 V2 (已弃用，替代接口请参考下方文档)/Get user search results of specified keywords V2 (deprecated, please refer to the following document for replacement interface)","description":"# [中文]\n## ⚠️ 此接口已弃用，不再维护，可能无法正常使用。请使用抖音搜索系列接口替代：https://docs.tikhub.io/370212785e0\n### 用途:\n- 获取指定关键词的用户搜索结果V2\n- 推荐默认使用专门的搜索接口，稳定性更好：https://docs.tikhub.io/370212785e0\n### 参数:\n- keyword: 关键词\n- cursor: 游标，第一次请求时为0，后续从返回数据中获取，用于翻页。\n### 返回:\n- 用户搜索结果V2\n\n# [English]\n## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly. Please use the Douyin Search API instead: https://docs.tikhub.io/370212785e0\n### Purpose:\n- Get user search results of specified keywords V2\n- It is recommended to use the dedicated search interface by default, which is more stable: https://docs.tikhub.io/370212785e0\n### Parameters:\n- keyword: Keyword\n- cursor: Cursor, 0 for the first request, get from the returned data later, used for paging.\n### Return:\n- User search results V2\n\n# [示例/Example]\nkeyword = \"中华娘\"\ncursor = 0","operationId":"fetch_user_search_result_v2_api_v1_douyin_web_fetch_user_search_result_v2_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_user_search_result_v3":{"get":{"tags":["Douyin-Web-API"],"summary":"获取指定关键词的用户搜索结果 V3 (已弃用，替代接口请参考下方文档)/Get user search results of specified keywords V3 (deprecated, please refer to the following document for replacement interface)","description":"# [中文]\n## ⚠️ 此接口已弃用，不再维护，可能无法正常使用。请使用抖音搜索系列接口替代：https://docs.tikhub.io/370212785e0\n### 用途:\n- 获取指定关键词的用户搜索结果 V3\n- 推荐默认使用专门的搜索接口，稳定性更好：https://docs.tikhub.io/370212785e0\n### 参数:\n- keyword: 关键词\n- cursor: 偏移量\n- douyin_user_fans: 留空:不限, \"0_1k\": 1000以下, \"1k_1w\": 1000-1万, \"1w_10w\": 1w-10w, \"10w_100w\": 10w-100w，\"100w_\": 100w以上\n- douyin_user_type: 留空:不限, \"common_user\": 普通用户, \"enterprise_user\": 企业认证, \"personal_user\": 个人认证\n### 返回:\n- 用户搜索结果\n\n# [English]\n## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly. Please use the Douyin Search API instead: https://docs.tikhub.io/370212785e0\n### Purpose:\n- Get user search results of specified keywords V3\n- It is recommended to use the dedicated search interface by default, which is more stable: https://docs.tikhub.io/370212785e0\n### Parameters:\n- keyword: Keyword\n- cursor: Offset\n- douyin_user_fans: Leave blank: Unlimited, \"0_1k\": Below 1000, \"1k_1w\": 1000-10,000, \"1w_10w\": 10,000-100,000, \"10w_100w\": 100,000-1 million, \"100w_\": More than 1 million\n- douyin_user_type: Leave blank: Unlimited, \"common_user\": Ordinary user, \"enterprise_user\": Enterprise certification, \"personal_user\": Personal certification\n### Return:\n- User search results\n\n# [示例/Example]\nkeyword = \"中华娘\"\ncursor = \"0\"\ndouyin_user_fans = \"\"\ndouyin_user_type = \"\"","operationId":"fetch_user_search_result_v3_api_v1_douyin_web_fetch_user_search_result_v3_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","default":"0","title":"Cursor"},"description":"游标/Cursor"},{"name":"douyin_user_type","in":"query","required":false,"schema":{"type":"string","description":"用户类型/User type","default":"","title":"Douyin User Type"},"description":"用户类型/User type"},{"name":"douyin_user_fans","in":"query","required":false,"schema":{"type":"string","description":"粉丝数/Fans","default":"","title":"Douyin User Fans"},"description":"粉丝数/Fans"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_live_search_result":{"get":{"tags":["Douyin-Web-API"],"summary":"[已弃用/Deprecated] 获取指定关键词的直播搜索结果/Get live search results of specified keywords","description":"# [中文]\n## ⚠️ 此接口已弃用，不再维护，可能无法正常使用。请使用抖音搜索系列接口替代：https://docs.tikhub.io/370212789e0\n### 用途:\n- 获取指定关键词的直播搜索结果\n- 推荐默认使用专门的搜索接口，稳定性更好：https://docs.tikhub.io/370212789e0\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量\n### 返回:\n- 直播搜索结果\n\n# [English]\n## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly. Please use the Douyin Search API instead: https://docs.tikhub.io/370212789e0\n### Purpose:\n- Get live search results of specified keywords\n- It is recommended to use the dedicated search interface by default, which is more stable: https://docs.tikhub.io/370212789e0\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number\n### Return:\n- Live search results\n\n# [示例/Example]\nkeyword = \"动漫\"\noffset = 0\ncount = 20","operationId":"fetch_live_search_result_api_v1_douyin_web_fetch_live_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_search_challenge":{"post":{"tags":["Douyin-Web-API"],"summary":"[已弃用/Deprecated] 搜索话题/Search Challenge","description":"# [中文]\n## ⚠️ 此接口已弃用，不再维护，可能无法正常使用。请使用抖音搜索系列接口替代：https://docs.tikhub.io/370212773e0\n### 用途:\n- 搜索话题，此接口不带Cookie请求时只能获取到前30条数据，建议自行提供Cookie获取更多数据。\n- Cookie获取方式：打开网页抖音，登录后，按F12打开开发者工具，点击Network，刷新页面，找到第一个请求，复制Cookie。\n### 参数:\n- keyword: 关键词\n- cursor: 偏移量\n- count: 数量\n- cookie: 用户自行提供的Cookie，用于获取更多数据。\n### 返回:\n- 话题搜索结果\n\n# [English]\n## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly. Please use the Douyin Search API instead: https://docs.tikhub.io/370212773e0\n### Purpose:\n- Search Challenge, when this interface is requested without Cookie, only the first 30 data can be obtained, it is recommended to provide Cookie to get more data.\n- Cookie acquisition method: Open the Douyin webpage, log in, press F12 to open the developer tool, click Network, refresh the page, find the first request, copy the Cookie.\n### Parameters:\n- keyword: Keyword\n- cursor: Offset\n- count: Number\n- cookie: User provided Cookie, used to get more data.\n### Return:\n- Challenge search results\n\n# [示例/Example]\nkeyword = \"动漫\"\ncursor = 0\ncount = 20","operationId":"fetch_search_challenge_api_v1_douyin_web_fetch_search_challenge_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchChallengeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/fetch_challenge_posts":{"post":{"tags":["Douyin-Web-API"],"summary":"话题作品/Challenge Posts","description":"# [中文]\n### 用途:\n- 话题作品\n### 参数:\n- challenge_id: 话题id\n- sort_type: 排序类型\n    - 0:综合排序 1:最热排序 2:最新排序\n- cursor: 游标\n- count: 数量\n- cookie: 用户自行提供的Cookie，用于获取更多数据。\n### 返回:\n- 话题作品\n\n# [English]\n### Purpose:\n- Challenge Posts\n### Parameters:\n- challenge_id: Challenge id\n- sort_type: Sort type\n    - 0: Comprehensive sorting 1: Hottest sorting 2: Latest sorting\n- cursor: Cursor\n- count: Number\n- cookie: User provided Cookie, used to get more data\n### Return:\n- Challenge Posts\n\n# [示例/Example]\nchallenge_id = \"1750525814851611\"\nsort_type = 0\noffset = 0\ncursor = 0\ncount = 20","operationId":"fetch_challenge_posts_api_v1_douyin_web_fetch_challenge_posts_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengePostRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/fetch_hot_search_result":{"get":{"tags":["Douyin-Web-API"],"summary":"获取抖音热榜数据/Get Douyin hot search results","description":"# [中文]\n### 用途:\n- 获取抖音热榜数据\n### 返回:\n- 热榜数据\n\n# [English]\n### Purpose:\n- Get Douyin hot search results\n### Return:\n- Hot search results","operationId":"fetch_hot_search_result_api_v1_douyin_web_fetch_hot_search_result_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/fetch_video_channel_result":{"get":{"tags":["Douyin-Web-API"],"summary":"抖音视频频道数据/Douyin video channel data","description":"# [中文]\n### 用途:\n- 抖音视频频道数据\n- https://www.douyin.com/channel/300205\n### 参数:\n- tag_id: 标签id，从URL中获取\n- count: 数量\n- refresh_index: 刷新索引\n### 返回:\n- 视频频道数据\n\n# [English]\n### Purpose:\n- Douyin video channel data\n- https://www.douyin.com/channel/300205\n### Parameters:\n- tag_id: Tag id, get from the URL\n- count: Number\n- refresh_index: Refresh index\n### Return:\n- Video channel data\n\n# [示例/Example]\ntag_id = 300203\ncount = 10\nrefresh_index = 1","operationId":"fetch_video_channel_result_api_v1_douyin_web_fetch_video_channel_result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"tag_id","in":"query","required":true,"schema":{"type":"integer","description":"标签id/Tag id","title":"Tag Id"},"description":"标签id/Tag id","example":300203},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":10,"title":"Count"},"description":"数量/Number"},{"name":"refresh_index","in":"query","required":false,"schema":{"type":"integer","description":"刷新索引/Refresh index","default":1,"title":"Refresh Index"},"description":"刷新索引/Refresh index"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_douyin_web_guest_cookie":{"get":{"tags":["Douyin-Web-API"],"summary":"获取抖音Web的游客Cookie/Get the guest Cookie of Douyin Web","description":"# [中文]\n### 用途:\n- 获取抖音Web的游客Cookie\n- 可以用于爬取抖音Web的数据，如用户作品、合辑作品等。\n- 可以固定身份避免部分接口重复数据。\n- 请注意：游客Cookie无法爬取所有数据，有一定的限制。\n- 可以配合开源项目使用此接口实现抖音Web的数据爬取。\n### 参数:\n- user_agent: 用户浏览器代理\n### 返回:\n- 游客Cookie\n\n# [English]\n### Purpose:\n- Get the guest Cookie of Douyin Web\n- Can be used to crawl data of Douyin Web, such as user videos, mix videos, etc.\n- Can fix identity to avoid duplicate data for some interfaces.\n- Please note: Guest Cookie cannot crawl all data, there are certain restrictions.\n- Can be used with open source projects to implement data crawling of Douyin Web using this interface.\n### Parameters:\n- user_agent: User browser agent\n### Return:\n- Guest Cookie\n\n# [示例/Example]\nuser_agent = \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36\"","operationId":"fetch_douyin_web_guest_cookie_api_v1_douyin_web_fetch_douyin_web_guest_cookie_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_agent","in":"query","required":true,"schema":{"type":"string","description":"用户浏览器代理/User browser agent","title":"User Agent"},"description":"用户浏览器代理/User browser agent","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/generate_real_msToken":{"get":{"tags":["Douyin-Web-API"],"summary":"生成真实msToken/Generate real msToken","description":"# [中文]\n### 用途:\n- 生成真实msToken\n### 返回:\n- msToken\n\n# [English]\n### Purpose:\n- Generate real msToken\n### Return:\n- msToken","operationId":"generate_real_msToken_api_v1_douyin_web_generate_real_msToken_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/generate_ttwid":{"get":{"tags":["Douyin-Web-API"],"summary":"生成ttwid/Generate ttwid","description":"# [中文]\n### 用途:\n- 生成ttwid\n### 返回:\n- ttwid\n\n# [English]\n### Purpose:\n- Generate ttwid\n### Return:\n- ttwid","operationId":"generate_ttwid_api_v1_douyin_web_generate_ttwid_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_agent","in":"query","required":false,"schema":{"type":"string","default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:125.0) Gecko/20100101 Firefox/125.0","title":"User Agent"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_query_user":{"post":{"tags":["Douyin-Web-API"],"summary":"查询抖音用户基本信息/Query Douyin user basic information","description":"# [中文]\n### 用途:\n- 查询抖音用户基本信息\n### 参数:\n- cookie: 用户ttwid Cookie，获取方式：调用`/api/v1/douyin/web/generate_ttwid`接口获取。\n### 返回:\n- 用户基本信息\n\n# [English]\n### Purpose:\n- Query Douyin user basic information\n### Parameters:\n- cookie: User ttwid Cookie, acquisition method: call `/api/v1/douyin/web/generate_ttwid` interface to get.\n### Return:\n- User basic information\n\n# [示例/Example]\ncookie = \"ttwid=xxx;\"","operationId":"fetch_query_user_api_v1_douyin_web_fetch_query_user_post","requestBody":{"content":{"application/json":{"schema":{"type":"string","title":"Cookie","description":"用户ttwid Cookie，获取方式：调用`/api/v1/douyin/web/generate_ttwid`接口获取。/User ttwid Cookie, acquisition method: call `/api/v1/douyin/web/generate_ttwid` interface to get.","default":"ttwid=1%7CNBG4pKnnBr32xpXszWA57PAooMT-02MTYJCyYl0fayI%7C1746172842%7Ce2aa988d355d220eb2fe8fb7e7bb22a51a46a933f969f768c5315fa73e372d5f;"},"example":"ttwid=1%7CNBG4pKnnBr32xpXszWA57PAooMT-02MTYJCyYl0fayI%7C1746172842%7Ce2aa988d355d220eb2fe8fb7e7bb22a51a46a933f969f768c5315fa73e372d5f;"}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/generate_verify_fp":{"get":{"tags":["Douyin-Web-API"],"summary":"生成verify_fp/Generate verify_fp","description":"# [中文]\n### 用途:\n- 生成verify_fp\n### 返回:\n- verify_fp\n\n# [English]\n### Purpose:\n- Generate verify_fp\n### Return:\n- verify_fp","operationId":"generate_verify_fp_api_v1_douyin_web_generate_verify_fp_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/generate_s_v_web_id":{"get":{"tags":["Douyin-Web-API"],"summary":"生成s_v_web_id/Generate s_v_web_id","description":"# [中文]\n### 用途:\n- 生成s_v_web_id\n### 返回:\n- s_v_web_id\n\n# [English]\n### Purpose:\n- Generate s_v_web_id\n### Return:\n- s_v_web_id","operationId":"generate_s_v_web_id_api_v1_douyin_web_generate_s_v_web_id_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/generate_wss_xb_signature":{"get":{"tags":["Douyin-Web-API"],"summary":"生成弹幕xb签名/Generate barrage xb signature","description":"# [中文]\n### 用途:\n- 生成弹幕xb签名\n### 参数:\n- user_agent: 用户浏览器代理\n- room_id: 房间号\n- user_unique_id: 用户唯一ID\n### 返回:\n- 弹幕xb签名\n\n# [English]\n### Purpose:\n- Generate danmu xb signature\n### Parameters:\n- user_agent: User browser agent\n- room_id: Room ID\n- user_unique_id: User unique ID\n### Return:\n- Danmu xb signature\n\n# [示例/Example]\nuser_agent = \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36 Edg/130.0.0.0\"\nroom_id = \"7382517534467115826\"\nuser_unique_id = \"7382524529011246630\"","operationId":"generate_wss_xb_signature_api_v1_douyin_web_generate_wss_xb_signature_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_agent","in":"query","required":true,"schema":{"type":"string","description":"用户浏览器代理/User browser agent","title":"User Agent"},"description":"用户浏览器代理/User browser agent","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36 Edg/130.0.0.0"},{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"房间号/Room ID","title":"Room Id"},"description":"房间号/Room ID","example":"7382517534467115826"},{"name":"user_unique_id","in":"query","required":true,"schema":{"type":"string","description":"用户唯一ID/User unique ID","title":"User Unique Id"},"description":"用户唯一ID/User unique ID","example":"7382524529011246630"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/generate_x_bogus":{"post":{"tags":["Douyin-Web-API"],"summary":"使用接口网址生成X-Bogus参数/Generate X-Bogus parameter using API URL","description":"# [中文]\n### 用途:\n- 使用接口网址生成X-Bogus参数\n### 参数:\n- url: 接口网址\n\n# [English]\n### Purpose:\n- Generate X-Bogus parameter using API URL\n### Parameters:\n- url: API URL\n\n# [示例/Example]\n\n```json\n{\n\"url\": \"https://www.douyin.com/aweme/v1/web/aweme/detail/?aweme_id=7148736076176215311&device_platform=webapp&aid=6383&channel=channel_pc_web&pc_client_type=1&version_code=170400&version_name=17.4.0&cookie_enabled=true&screen_width=1920&screen_height=1080&browser_language=zh-CN&browser_platform=Win32&browser_name=Edge&browser_version=117.0.2045.47&browser_online=true&engine_name=Blink&engine_version=117.0.0.0&os_name=Windows&os_version=10&cpu_core_num=128&device_memory=10240&platform=PC&downlink=10&effective_type=4g&round_trip_time=100\",\n\"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36\"\n}\n```","operationId":"generate_x_bogus_api_v1_douyin_web_generate_x_bogus_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XBogusModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/generate_a_bogus":{"post":{"tags":["Douyin-Web-API"],"summary":"使用接口网址生成A-Bogus参数/Generate A-Bogus parameter using API URL","description":"# [中文]\n### 用途:\n- 使用接口网址生成A-Bogus参数，提交的URL不能带有a_bogus参数，同时a_bogus参数与请求头中的User-Agent有关，需要一起提交和请求。\n### 参数:\n- url: API链接，请去除url中的原本的a_boogus参数(如有)。\n- data: 请求载荷，只有在POST请求中才需要提交，GET请求中使用空字符串即可。\n- user_agent: user-agent，需要提交你请求头中的User-Agent，该值参与a_bogus参数的计算。\n- index_0: 加密明文列表的第一个值，无特殊要求，默认为0，不要随意修改。\n- index_1: 加密明文列表的第二个值，无特殊要求，默认为1，不要随意修改。\n- index_2: 加密明文列表的第三个值，无特殊要求，默认为14，不要随意修改。\n### 返回:\n- A-Bogus参数\n\n# [English]\n### Purpose:\n- Generate A-Bogus parameter using API URL, the submitted URL cannot contain the original a_boogus parameter, and the a_bogus parameter is related to the User-Agent in the request header, which needs to be submitted and requested together.\n### Parameters:\n- url: API link, please remove the original a_boogus parameter from the url (if any).\n- data: Request payload, only need to submit in POST request, use an empty string in GET request.\n- user_agent: user-agent, you need to submit the User-Agent in your request header, which is involved in the calculation of the a_bogus parameter.\n- index_0: The first value of the encrypted plaintext list, no special requirements, the default is 0, do not modify it at will.\n- index_1: The second value of the encrypted plaintext list, no special requirements, the default is 1, do not modify it at will.\n- index_2: The third value of the encrypted plaintext list, no special requirements, the default is 14, do not modify it at will.\n### Return:\n- A-Bogus parameter\n\n# [示例/Example]\n```json\n{\n\"url\": \"https://www.douyin.com/aweme/v1/web/general/search/single/?device_platform=webapp&aid=6383&channel=channel_pc_web&search_channel=aweme_general&enable_history=1&keyword=%E4%B8%AD%E5%8D%8E%E5%A8%98&search_source=normal_search&query_correct_type=1&is_filter_search=0&from_group_id=7346905902554844468&offset=0&count=15&need_filter_settings=1&pc_client_type=1&version_code=190600&version_name=19.6.0&cookie_enabled=true&screen_width=1280&screen_height=800&browser_language=zh-CN&browser_platform=Win32&browser_name=Firefox&browser_version=124.0&browser_online=true&engine_name=Gecko&engine_version=124.0&os_name=Windows&os_version=10&cpu_core_num=16&device_memory=&platform=PC&webid=7348962975497324070&msToken=YCTVM6YGmjFdIpQAN9ykXLBXiSiuHdZkOkEQWTeqVOHBEPmOcM0lNwE0Kd9vgHPMPigSndZDHfAq9k-6lDmH3Jqz6mHHxmn-BzQjmLMIfLIPgirgnOixM9x4PwgcNQ%3D%3D\",\n\"data\": \"\",\n\"user_agent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36\",\n\"index_0\": 0,\n\"index_1\": 1,\n\"index_2\": 14\n}\n```","operationId":"generate_a_bogus_api_v1_douyin_web_generate_a_bogus_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ABogusModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/get_sec_user_id":{"get":{"tags":["Douyin-Web-API"],"summary":"提取单个用户id/Extract single user id","description":"# [中文]\n### 用途:\n- 提取单个用户id\n### 参数:\n- url: 用户主页链接\n### 返回:\n- 用户sec_user_id\n\n# [English]\n### Purpose:\n- Extract single user id\n### Parameters:\n- url: User homepage link\n### Return:\n- User sec_user_id\n\n# [示例/Example]\nurl = \"https://www.douyin.com/user/MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE\"","operationId":"get_sec_user_id_api_v1_douyin_web_get_sec_user_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","title":"Url"},"example":"https://www.douyin.com/user/MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/get_all_sec_user_id":{"post":{"tags":["Douyin-Web-API"],"summary":"提取列表用户id/Extract list user id","description":"# [中文]\n ### 用途:\n - 提取列表用户id\n ### 参数:\n - url: 用户主页链接列表（最多支持10个链接）\n ### 返回:\n - 如果链接成功获取到sec_user_id，则返回sec_user_id，否则返回原始的输入链接，后续可以手动校验链接无法获取sec_user_id的原因。\n\n # [English]\n ### Purpose:\n - Extract list user id\n ### Parameters:\n - url: User homepage link list (supports up to 10 links)\n ### Return:\n - If the sec_user_id is successfully obtained from the link, the sec_user_id is returned, otherwise the original input link is returned, and the reason why the sec_user_id cannot be obtained can be manually verified later.\n\n # [示例/Example]\n ```json\n {\n\"urls\":[\n   \"https://www.douyin.com/user/MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE?vid=7285950278132616463\",\n   \"https://www.douyin.com/user/MS4wLjABAAAAVsneOf144eGDFf8Xp9QNb1VW6ovXnNT5SqJBhJfe8KQBKWKDTWK5Hh-_i9mJzb8C\",\n   \"长按复制此条消息，打开抖音搜索，查看TA的更多作品。 https://v.douyin.com/idFqvUms/\",\n   \"https://v.douyin.com/idFqvUms/\"\n    ]\n }\n ```","operationId":"get_all_sec_user_id_api_v1_douyin_web_get_all_sec_user_id_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Url","description":"用户主页链接列表/User homepage link list"},"example":["https://www.douyin.com/user/MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE?vid=7285950278132616463","https://www.douyin.com/user/MS4wLjABAAAAVsneOf144eGDFf8Xp9QNb1VW6ovXnNT5SqJBhJfe8KQBKWKDTWK5Hh-_i9mJzb8C","长按复制此条消息，打开抖音搜索，查看TA的更多作品。 https://v.douyin.com/idFqvUms/","https://v.douyin.com/idFqvUms/"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/get_aweme_id":{"get":{"tags":["Douyin-Web-API"],"summary":"提取单个作品id/Extract single video id","description":"# [中文]\n### 用途:\n- 提取单个作品id\n### 参数:\n- url: 作品链接\n### 返回:\n- 作品id\n\n# [English]\n### Purpose:\n- Extract single video id\n### Parameters:\n- url: Video link\n### Return:\n- Video id\n\n# [示例/Example]\nurl = \"https://www.douyin.com/video/7298145681699622182\"","operationId":"get_aweme_id_api_v1_douyin_web_get_aweme_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","title":"Url"},"example":"https://www.douyin.com/video/7298145681699622182"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/get_all_aweme_id":{"post":{"tags":["Douyin-Web-API"],"summary":"提取列表作品id/Extract list video id","description":"# [中文]\n ### 用途:\n - 提取列表作品id（最多支持20个链接）\n ### 参数:\n - url: 作品链接列表\n ### 返回:\n - 作品id列表\n\n # [English]\n ### Purpose:\n - Extract list video id (supports up to 20 links)\n ### Parameters:\n - url: Video link list\n ### Return:\n - Video id list\n\n # [示例/Example]\n ```json\n {\n\"urls\":[\n    \"0.53 02/26 I@v.sE Fus:/ 你别太帅了郑润泽# 现场版live # 音乐节 # 郑润泽  https://v.douyin.com/iRNBho6u/ 复制此链接，打开Dou音搜索，直接观看视频!\",\n    \"https://v.douyin.com/iRNBho6u/\",\n    \"https://www.iesdouyin.com/share/video/7298145681699622182/?region=CN&mid=7298145762238565171&u_code=l1j9bkbd&did=MS4wLjABAAAAtqpCx0hpOERbdSzQdjRZw-wFPxaqdbAzsKDmbJMUI3KWlMGQHC-n6dXAqa-dM2EP&iid=MS4wLjABAAAANwkJuWIRFOzg5uCpDRpMj4OX-QryoDgn-yYlXQnRwQQ&with_sec_did=1&titleType=title&share_sign=05kGlqGmR4_IwCX.ZGk6xuL0osNA..5ur7b0jbOx6cc-&share_version=170400&ts=1699262937&from_aid=6383&from_ssr=1&from=web_code_link\",\n    \"https://www.douyin.com/video/7298145681699622182?previous_page=web_code_link\",\n    \"https://www.douyin.com/video/7298145681699622182\",\n ]\n }\n ```","operationId":"get_all_aweme_id_api_v1_douyin_web_get_all_aweme_id_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Url","description":"作品链接列表/Video link list"},"example":["0.53 02/26 I@v.sE Fus:/ 你别太帅了郑润泽# 现场版live # 音乐节 # 郑润泽  https://v.douyin.com/iRNBho6u/ 复制此链接，打开Dou音搜索，直接观看视频!","https://v.douyin.com/iRNBho6u/","https://www.iesdouyin.com/share/video/7298145681699622182/?region=CN&mid=7298145762238565171&u_code=l1j9bkbd&did=MS4wLjABAAAAtqpCx0hpOERbdSzQdjRZw-wFPxaqdbAzsKDmbJMUI3KWlMGQHC-n6dXAqa-dM2EP&iid=MS4wLjABAAAANwkJuWIRFOzg5uCpDRpMj4OX-QryoDgn-yYlXQnRwQQ&with_sec_did=1&titleType=title&share_sign=05kGlqGmR4_IwCX.ZGk6xuL0osNA..5ur7b0jbOx6cc-&share_version=170400&ts=1699262937&from_aid=6383&from_ssr=1&from=web_code_link","https://www.douyin.com/video/7298145681699622182?previous_page=web_code_link","https://www.douyin.com/video/7298145681699622182"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/get_webcast_id":{"get":{"tags":["Douyin-Web-API"],"summary":"提取直播间号/Extract webcast id","description":"# [中文]\n### 用途:\n- 提取列表直播间号\n### 参数:\n- url: 直播间链接\n### 返回:\n- 直播间号\n\n# [English]\n### Purpose:\n- Extract list webcast id\n### Parameters:\n- url: Room link\n### Return:\n- Room id\n\n# [示例/Example]\nurl = \"https://live.douyin.com/775841227732\"","operationId":"get_webcast_id_api_v1_douyin_web_get_webcast_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","title":"Url"},"example":"https://live.douyin.com/775841227732"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/get_all_webcast_id":{"post":{"tags":["Douyin-Web-API"],"summary":"提取列表直播间号/Extract list webcast id","description":"# [中文]\n### 用途:\n- 提取列表直播间号\n### 参数:\n- url: 直播间链接列表（最多支持20个链接）\n### 返回:\n- 直播间号列表\n\n# [English]\n### Purpose:\n- Extract list webcast id\n### Parameters:\n- url: Room link list (supports up to 20 links)\n### Return:\n- Room id list\n\n# [示例/Example]\n```json\n{\n  \"urls\": [\n        \"https://live.douyin.com/775841227732\",\n        \"https://live.douyin.com/775841227732?room_id=7318296342189919011&enter_from_merge=web_share_link&enter_method=web_share_link&previous_page=app_code_link\",\n        'https://webcast.amemv.com/douyin/webcast/reflow/7318296342189919011?u_code=l1j9bkbd&did=MS4wLjABAAAAEs86TBQPNwAo-RGrcxWyCdwKhI66AK3Pqf3ieo6HaxI&iid=MS4wLjABAAAA0ptpM-zzoliLEeyvWOCUt-_dQza4uSjlIvbtIazXnCY&with_sec_did=1&use_link_command=1&ecom_share_track_params=&extra_params={\"from_request_id\":\"20231230162057EC005772A8EAA0199906\",\"im_channel_invite_id\":\"0\"}&user_id=3644207898042206&liveId=7318296342189919011&from=share&style=share&enter_method=click_share&roomId=7318296342189919011&activity_info={}',\n        \"6i- Q@x.Sl 03/23 【醒子8ke的直播间】  点击打开👉https://v.douyin.com/i8tBR7hX/  或长按复制此条消息，打开抖音，看TA直播\",\n        \"https://v.douyin.com/i8tBR7hX/\",\n        ]\n}\n```","operationId":"get_all_webcast_id_api_v1_douyin_web_get_all_webcast_id_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Url","description":"直播间链接列表/Room link list"},"example":["https://live.douyin.com/775841227732","https://live.douyin.com/775841227732?room_id=7318296342189919011&enter_from_merge=web_share_link&enter_method=web_share_link&previous_page=app_code_link","https://webcast.amemv.com/douyin/webcast/reflow/7318296342189919011?u_code=l1j9bkbd&did=MS4wLjABAAAAEs86TBQPNwAo-RGrcxWyCdwKhI66AK3Pqf3ieo6HaxI&iid=MS4wLjABAAAA0ptpM-zzoliLEeyvWOCUt-_dQza4uSjlIvbtIazXnCY&with_sec_did=1&use_link_command=1&ecom_share_track_params=&extra_params={\"from_request_id\":\"20231230162057EC005772A8EAA0199906\",\"im_channel_invite_id\":\"0\"}&user_id=3644207898042206&liveId=7318296342189919011&from=share&style=share&enter_method=click_share&roomId=7318296342189919011&activity_info={}","6i- Q@x.Sl 03/23 【醒子8ke的直播间】  点击打开👉https://v.douyin.com/i8tBR7hX/  或长按复制此条消息，打开抖音，看TA直播","https://v.douyin.com/i8tBR7hX/"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/web/webcast_id_2_room_id":{"get":{"tags":["Douyin-Web-API"],"summary":"直播间号转房间号/Webcast id to room id","description":"# [中文]\n### 用途:\n- 直播间号转房间号\n### 参数:\n- webcast_id: 直播间号\n### 返回:\n- 房间号\n\n# [English]\n### Purpose:\n- Webcast id to room id\n### Parameters:\n- webcast_id: Webcast id\n### Return:\n- Room id\n\n# [示例/Example]\n\"webcast_id = \"775841227732\"","operationId":"webcast_id_2_room_id_api_v1_douyin_web_webcast_id_2_room_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"webcast_id","in":"query","required":true,"schema":{"type":"string","description":"直播间号/Webcast id","title":"Webcast Id"},"description":"直播间号/Webcast id","example":"775841227732"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/douyin_live_room":{"get":{"tags":["Douyin-Web-API"],"summary":"提取直播间弹幕/Extract live room danmaku","description":"# [中文]\n### 用途:\n- 提取直播间弹幕\n- 该接口已不再提供线上服务，需要自行购买源代码后在本地部署使用，购买源代码请在Discord服务器联系管理员，Discord邀请链接：https://discord.gg/aMEAS8Xsvz\n#### 价格:\n- 每10条数据消耗0.001$，支持阶梯式计费折扣。\n### 参数:\n- live_room_url: 直播间链接\n- danmaku_type: 消息类型\n    - WebcastRoomMessage：直播间消息\n    - WebcastLikeMessage：点赞消息\n    - WebcastMemberMessage：成员消息\n    - WebcastChatMessage：聊天消息\n    - WebcastGiftMessage：礼物消息\n    - WebcastSocialMessage：社交消息\n    - WebcastRoomUserSeqMessage：用户序列消息\n    - WebcastUpdateFanTicketMessage：更新粉丝消息\n    - WebcastCommonTextMessage：常规文本消息\n    - WebcastMatchAgainstScoreMessage：比赛得分消息\n    - WebcastFansclubMessage：粉丝俱乐部消息\n    - WebcastRanklistHourEntranceMessage：排行榜小时入口消息\n    - WebcastRoomStatsMessage：直播间统计消息\n    - WebcastLiveShoppingMessage: 直播购物消息\n    - WebcastLiveEcomGeneralMessage: 直播电商通用消息\n    - WebcastProductChangeMessage: 直播商品变更消息\n    - WebcastRoomStreamAdaptationMessage: 直播间流适配消息\n    - WebcastNotifyEffectMessage: 通知效果消息\n    - WebcastLightGiftMessage: 亮礼物消息\n    - WebcastProfitInteractionScoreMessage: 收益互动分消息\n    - WebcastRoomRankMessage: 直播间排行消息\n### 返回:\n- 弹幕数据的WebSocket连接信息，需要使用WebSocket连接获取弹幕数据，此接口不返回弹幕数据。\n\n# [English]\n### Purpose:\n- Extract live room danmaku\n- This interface is no longer available online, you need to purchase the source code and deploy it locally for use. To purchase the source code, please contact the administrator in the Discord server. Discord invite link: https://discord.gg/aMEAS8Xsvz\n#### Price:\n- 0.001$ per 10 data, support tiered billing discounts.\n### Parameters:\n- live_room_url: Live room link\n- danmaku_type: Message type\n    - WebcastRoomMessage: Live room message\n    - WebcastLikeMessage: Like message\n    - WebcastMemberMessage: Member message\n    - WebcastChatMessage: Chat message\n    - WebcastGiftMessage: Gift message\n    - WebcastSocialMessage: Social message\n    - WebcastRoomUserSeqMessage: User sequence message\n    - WebcastUpdateFanTicketMessage: Update fan message\n    - WebcastCommonTextMessage: Common text message\n    - WebcastMatchAgainstScoreMessage: Match score message\n    - WebcastFansclubMessage: Fans club message\n    - WebcastRanklistHourEntranceMessage: Ranking list hour entrance message\n    - WebcastRoomStatsMessage: Live room statistics message\n    - WebcastLiveShoppingMessage: Live shopping message\n    - WebcastLiveEcomGeneralMessage: Live e-commerce general message\n    - WebcastProductChangeMessage: Live product change message\n    - WebcastRoomStreamAdaptationMessage: Live room stream adaptation message\n    - WebcastNotifyEffectMessage: Notification effect message\n    - WebcastLightGiftMessage: Light gift message\n    - WebcastProfitInteractionScoreMessage: Profit interaction score message\n    - WebcastRoomRankMessage: Live room ranking message\n### Return:\n- WebSocket connection information of the danmaku data, you need to use WebSocket connection to get the danmaku data, this interface does not return the danmaku data.","operationId":"douyin_live_room_api_v1_douyin_web_douyin_live_room_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"live_room_url","in":"query","required":true,"schema":{"type":"string","description":"直播间链接/Live room link","title":"Live Room Url"},"description":"直播间链接/Live room link","example":"https://live.douyin.com/834624950943"},{"name":"danmaku_type","in":"query","required":true,"schema":{"type":"string","description":"消息类型/Message type","title":"Danmaku Type"},"description":"消息类型/Message type","example":"WebcastRoomMessage"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_live_im_fetch":{"get":{"tags":["Douyin-Web-API"],"summary":"抖音直播间弹幕参数获取/Douyin live room danmaku parameters","description":"# [中文]\n### 用途:\n- 抖音直播间弹幕参数获取\n### 参数:\n- room_id: 直播间号\n- user_unique_id: 用户唯一ID\n\n### 返回:\n- 弹幕参数数据\n\n# [English]\n### Purpose:\n- Douyin live room danmaku parameters\n### Parameters:\n- room_id: Live room id\n- user_unique_id: User unique ID\n\n### Return:\n- Danmaku parameter data","operationId":"fetch_live_im_fetch_api_v1_douyin_web_fetch_live_im_fetch_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间号/Live room id","title":"Room Id"},"description":"直播间号/Live room id","example":"7382517534467115826"},{"name":"user_unique_id","in":"query","required":true,"schema":{"type":"string","description":"用户唯一ID/User unique ID","title":"User Unique Id"},"description":"用户唯一ID/User unique ID","example":"7382524529011246630"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_series_aweme":{"get":{"tags":["Douyin-Web-API"],"summary":"短剧作品/Series Video","description":"# [中文]\n### 用途:\n- 短剧作品\n### 参数:\n- offset: 页码，默认为0\n- count: 每页数量，默认为16\n- content_type: 子类型，默认为0\n    - 0: 热榜\n    - 101: 甜宠\n    - 102: 搞笑\n    - 104: 正能量\n    - 105: 成长\n    - 106: 悬疑\n    - 109: 家庭\n    - 110: 都市\n    - 112: 奇幻\n    - 113: 玄幻\n    - 114: 职场\n    - 115: 青春\n    - 116: 古装\n    - 117: 动作\n    - 119: 逆袭\n    - 124: 其他\n- cookie: 用户自行提供的Cookie，推荐使用自己的抖音Cookie，否则在翻页时可能会出现数据重复的问题\n- 游客cookie获取接口：https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n### 返回:\n- 短剧作品数据\n\n# [English]\n### Purpose:\n- Series Video\n### Parameters:\n- offset: Page number, default is 0\n- count: Number per page, default is 16\n- content_type: Subtype, default is 0\n    - 0: Hot list\n    - 101: Sweet pet\n    - 102: Funny\n    - 104: Positive energy\n    - 105: Growth\n    - 106: Suspense\n    - 109: Family\n    - 110: Urban\n    - 112: Fantasy\n    - 113: Fantasy\n    - 114: Workplace\n    - 115: Youth\n    - 116: Ancient costume\n    - 117: Action\n    - 119: Counterattack\n    - 124: Other\n- cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging\n- Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### Return:\n- Series Video data","operationId":"fetch_series_aweme_api_v1_douyin_web_fetch_series_aweme_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offset","in":"query","required":true,"schema":{"type":"integer","description":"页码/Page number","title":"Offset"},"description":"页码/Page number","example":0},{"name":"count","in":"query","required":true,"schema":{"type":"integer","description":"每页数量/Number per page","title":"Count"},"description":"每页数量/Number per page","example":16},{"name":"content_type","in":"query","required":true,"schema":{"type":"integer","description":"短剧类型/Subtype","title":"Content Type"},"description":"短剧类型/Subtype","example":0},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户自行提供的Cookie/User provided Cookie","title":"Cookie"},"description":"用户自行提供的Cookie/User provided Cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_knowledge_aweme":{"get":{"tags":["Douyin-Web-API"],"summary":"知识作品推荐/Knowledge Video","description":"# [中文]\n### 用途:\n- 知识作品\n### 参数:\n- count: 每页数量，默认为16\n- refresh_index: 翻页索引，默认为1\n- cookie: 用户自行提供的Cookie，推荐使用自己的抖音Cookie，否则在翻页时可能会出现数据重复的问题\n- 游客cookie获取接口：https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### 返回:\n- 知识作品数据\n\n# [English]\n### Purpose:\n- Knowledge Video\n### Parameters:\n- count: Number per page, default is 16\n- refresh_index: Paging index, default is 1\n- cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging\n- Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### Return:\n- Knowledge Video data","operationId":"fetch_knowledge_aweme_api_v1_douyin_web_fetch_knowledge_aweme_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"count","in":"query","required":true,"schema":{"type":"integer","description":"每页数量/Number per page","title":"Count"},"description":"每页数量/Number per page","example":16},{"name":"refresh_index","in":"query","required":false,"schema":{"type":"integer","description":"翻页索引/Paging index","default":1,"title":"Refresh Index"},"description":"翻页索引/Paging index"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户自行提供的Cookie/User provided Cookie","title":"Cookie"},"description":"用户自行提供的Cookie/User provided Cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_game_aweme":{"get":{"tags":["Douyin-Web-API"],"summary":"游戏作品推荐/Game Video","description":"# [中文]\n### 用途:\n- 知识作品\n### 参数:\n- count: 每页数量，默认为16\n- refresh_index: 翻页索引，默认为1\n- cookie: 用户自行提供的Cookie，推荐使用自己的抖音Cookie，否则在翻页时可能会出现数据重复的问题\n- 游客cookie获取接口：https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### 返回:\n- 游戏作品数据\n\n# [English]\n### Purpose:\n- Knowledge Video\n### Parameters:\n- count: Number per page, default is 16\n- refresh_index: Paging index, default is 1\n- cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging\n- Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### Return:\n- Game Video data","operationId":"fetch_game_aweme_api_v1_douyin_web_fetch_game_aweme_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"count","in":"query","required":true,"schema":{"type":"integer","description":"每页数量/Number per page","title":"Count"},"description":"每页数量/Number per page","example":16},{"name":"refresh_index","in":"query","required":false,"schema":{"type":"integer","description":"翻页索引/Paging index","default":1,"title":"Refresh Index"},"description":"翻页索引/Paging index"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户自行提供的Cookie/User provided Cookie","title":"Cookie"},"description":"用户自行提供的Cookie/User provided Cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_cartoon_aweme":{"get":{"tags":["Douyin-Web-API"],"summary":"二次元作品推荐/Anime Video","description":"# [中文]\n### 用途:\n- 二次元作品\n### 参数:\n- count: 每页数量，默认为16\n- refresh_index: 翻页索引，默认为1\n- cookie: 用户自行提供的Cookie，推荐使用自己的抖音Cookie，否则在翻页时可能会出现数据重复的问题\n- 游客cookie获取接口：https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### 返回:\n- 二次元作品数据\n\n# [English]\n### Purpose:\n- Cartoon Video\n### Parameters:\n- count: Number per page, default is 16\n- refresh_index: Paging index, default is 1\n- cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging\n- Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### Return:\n- Cartoon Video data","operationId":"fetch_cartoon_aweme_api_v1_douyin_web_fetch_cartoon_aweme_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"count","in":"query","required":true,"schema":{"type":"integer","description":"每页数量/Number per page","title":"Count"},"description":"每页数量/Number per page","example":16},{"name":"refresh_index","in":"query","required":false,"schema":{"type":"integer","description":"翻页索引/Paging index","default":1,"title":"Refresh Index"},"description":"翻页索引/Paging index"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户自行提供的Cookie/User provided Cookie","title":"Cookie"},"description":"用户自行提供的Cookie/User provided Cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_music_aweme":{"get":{"tags":["Douyin-Web-API"],"summary":"音乐作品推荐/Music Video","description":"# [中文]\n### 用途:\n- 音乐作品\n### 参数:\n- count: 每页数量，默认为16\n- refresh_index: 翻页索引，默认为1\n- cookie: 用户自行提供的Cookie，推荐使用自己的抖音Cookie，否则在翻页时可能会出现数据重复的问题\n- 游客cookie获取接口：https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### 返回:\n- 音乐作品数据\n\n# [English]\n### Purpose:\n- Music Video\n### Parameters:\n- count: Number per page, default is 16\n- refresh_index: Paging index, default is 1\n- cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging\n- Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### Return:\n- Music Video data","operationId":"fetch_cartoon_aweme_api_v1_douyin_web_fetch_music_aweme_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"count","in":"query","required":true,"schema":{"type":"integer","description":"每页数量/Number per page","title":"Count"},"description":"每页数量/Number per page","example":16},{"name":"refresh_index","in":"query","required":false,"schema":{"type":"integer","description":"翻页索引/Paging index","default":1,"title":"Refresh Index"},"description":"翻页索引/Paging index"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户自行提供的Cookie/User provided Cookie","title":"Cookie"},"description":"用户自行提供的Cookie/User provided Cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/web/fetch_food_aweme":{"get":{"tags":["Douyin-Web-API"],"summary":"美食作品推荐/Food Video","description":"# [中文]\n### 用途:\n- 美食作品\n### 参数:\n- count: 每页数量，默认为16\n- refresh_index: 翻页索引，默认为1\n- cookie: 用户自行提供的Cookie，推荐使用自己的抖音Cookie，否则在翻页时可能会出现数据重复的问题\n- 游客cookie获取接口：https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### 返回:\n- 美食作品数据\n\n# [English]\n### Purpose:\n- Food Video\n### Parameters:\n- count: Number per page, default is 16\n- refresh_index: Paging index, default is 1\n- cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging\n- Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie\n\n### Return:\n- Food Video data","operationId":"fetch_cartoon_aweme_api_v1_douyin_web_fetch_food_aweme_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"count","in":"query","required":true,"schema":{"type":"integer","description":"每页数量/Number per page","title":"Count"},"description":"每页数量/Number per page","example":16},{"name":"refresh_index","in":"query","required":false,"schema":{"type":"integer","description":"翻页索引/Paging index","default":1,"title":"Refresh Index"},"description":"翻页索引/Paging index"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"用户自行提供的Cookie/User provided Cookie","title":"Cookie"},"description":"用户自行提供的Cookie/User provided Cookie"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_one_video":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取单个作品数据/Get single video data","description":"# [中文]\n### 用途:\n- 获取单个作品数据，支持图文、视频等。\n### 参数:\n- aweme_id: 作品id\n### 返回:\n- 作品数据\n### 备注:\n- 如果接口出现返回空的情况，请使用一样的参数去请求 Web 版本接口，具体响应状态码参考：\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8：该内容因海外版权限制，暂时无法观看（短剧，电影片段等）\n    - 8：视频不存在或已被删除\n    - 5：该内容被标记为私人内容，没有公开展示权限\n    - 10：该内容被标记为部分可见，仅作者选择的部分用户可见\n    - 更多状态码请提交给我们的客户支持进行补充。\n\n# [English]\n### Purpose:\n- Get single video data, support photo, video, etc.\n### Parameters:\n- aweme_id: Video id\n### Return:\n- Video data\n### Note:\n- If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)\n    - 8: The video does not exist or has been deleted\n    - 5: This content is marked as private content and does not have public display permissions\n    - 10: This content is marked as partially visible, only visible to some users chosen by the author\n    - For more status codes, please submit them to our customer support for supplementation.\n\n# [示例/Example]\naweme_id = \"7448118827402972455\"","operationId":"fetch_one_video_api_v1_douyin_app_v3_fetch_one_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7448118827402972455"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_one_video_v2":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取单个作品数据 V2/Get single video data V2","description":"# [中文]\n### 用途:\n- 获取单个作品数据，支持图文、视频等。\n### 参数:\n- aweme_id: 作品id\n### 返回:\n- 作品数据\n### 备注:\n- 如果接口出现返回空的情况，请使用一样的参数去请求 Web 版本接口，具体响应状态码参考：\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8：该内容因海外版权限制，暂时无法观看（短剧，电影片段等）\n    - 8：视频不存在或已被删除\n    - 5：该内容被标记为私人内容，没有公开展示权限\n    - 10：该内容被标记为部分可见，仅作者选择的部分用户可见\n    - 更多状态码请提交给我们的客户支持进行补充。\n\n# [English]\n### Purpose:\n- Get single video data, support photo, video, etc.\n### Parameters:\n- aweme_id: Video id\n### Return:\n- Video data\n### Note:\n- If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)\n    - 8: The video does not exist or has been deleted\n    - 5: This content is marked as private content and does not have public display permissions\n    - 10: This content is marked as partially visible, only visible to some users chosen by the author\n    - For more status codes, please submit them to our customer support for supplementation.\n\n# [示例/Example]\naweme_id = \"7448118827402972455\"","operationId":"fetch_one_video_v2_api_v1_douyin_app_v3_fetch_one_video_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7448118827402972455"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_one_video_v3":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取单个作品数据 V3 (无版权限制)/Get single video data V3 (No copyright restrictions)","description":"# [中文]\n### 用途:\n- 获取单个作品数据，支持文章、图文、视频等。\n- V3版本的接口，解决了版权限制问题，可以获取更多受限内容，比如 V1，V2版本返回的Reason为8的内容和部分文章或短剧等。\n### 参数:\n- aweme_id: 作品id\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data, support article, photo, video, etc.\n- V3 version of the interface, which solves the copyright restriction problem and can obtain more restricted content, such as content with Reason 8 returned by V1 and V2 versions and some articles or short dramas.\n### Parameters:\n- aweme_id: Video id\n### Return:\n- Video data\n\n# [示例/Example]\naweme_id = \"7592116912205630761\"","operationId":"fetch_one_video_v3_api_v1_douyin_app_v3_fetch_one_video_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品或文章ID/Video or Article ID","title":"Aweme Id"},"description":"作品或文章ID/Video or Article ID","example":"7592116912205630761"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_share_info_by_share_code":{"get":{"tags":["Douyin-App-V3-API"],"summary":"根据分享口令获取分享信息/Get share info by share code","description":"# [中文]\n### 用途:\n- 根据分享口令获取分享信息，比如抖音文章的分享口令提取分享人信息和文章ID等然后再去请求单一作品数据接口获取文章内容。\n### 参数:\n- share_code: 分享口令\n### 返回:\n- 分享信息，包含分享人信息和文章ID等\n\n# [English]\n### Purpose:\n- Get share info by share code, such as extracting sharer information and article ID from Douyin article share code, and then requesting a single video data interface to get the article content.\n### Parameters:\n- share_code: Share code\n### Return:\n- Share info, including sharer information and article ID, etc.\n\n# [示例/Example]\nshare_code = \"8:/ h@O.kP 05/21 【生意场上，装逼就是节省沟通成本】长按复制打开抖音，即可阅读文章 ︽︽2QnCB9aIZZ29︽︽\"","operationId":"fetch_one_video_by_share_url_api_v1_douyin_app_v3_fetch_share_info_by_share_code_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_code","in":"query","required":true,"schema":{"type":"string","description":"分享口令/Share code","title":"Share Code"},"description":"分享口令/Share code","example":"8:/ h@O.kP 05/21 【生意场上，装逼就是节省沟通成本】长按复制打开抖音，即可阅读文章 ︽︽2QnCB9aIZZ29︽︽"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_multi_video":{"post":{"tags":["Douyin-App-V3-API"],"summary":"批量获取视频信息 V1/Batch Get Video Information V1","description":"# [中文]\n### 用途:\n- 批量获取视频信息，支持图文、视频等，一次性最多支持10个视频，此接口收费固定价格为0.001$ * 10 = 0.01$一次。\n### 参数:\n- aweme_ids: 作品id列表，最多支持10个作品id。\n### 返回:\n- 作品数据\n### 备注:\n- 如果接口出现返回空的情况，请使用一样的参数去请求 Web 版本接口，具体响应状态码参考：\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8：该内容因海外版权限制，暂时无法观看（短剧，电影片段等）\n    - 8：视频不存在或已被删除\n    - 5：该内容被标记为私人内容，没有公开展示权限\n    - 10：该内容被标记为部分可见，仅作者选择的部分用户可见\n    - 更多状态码请提交给我们的客户支持进行补充。\n\n# [English]\n### Purpose:\n- Batch Get Video Information, support photo, video, etc., up to 10 videos at a time, this interface charges a fixed price of 0.001$ * 10 = 0.01$ each time.\n### Parameters:\n- aweme_ids: List of video ids, up to 10 video ids are supported.\n### Return:\n- Video data\n### Note:\n- If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)\n    - 8: The video does not exist or has been deleted\n    - 5: This content is marked as private content and does not have public display permissions\n    - 10: This content is marked as partially visible, only visible to some users chosen by the author\n    - For more status codes, please submit them to our customer support for supplementation.\n\n# [示例/Example]\naweme_ids = [\"7448118827402972455\", \"7126745726494821640\", \"7448118827402972455\", \"7126745726494821640\", \"7448118827402972455\", \"7126745726494821640\", \"7448118827402972455\", \"7126745726494821640\", \"7448118827402972455\", \"7126745726494821640\"]","operationId":"fetch_multi_video_api_v1_douyin_app_v3_fetch_multi_video_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Aweme Ids"},"example":["7448118827402972455","7126745726494821640","7448118827402972455","7126745726494821640","7448118827402972455","7126745726494821640","7448118827402972455","7126745726494821640","7448118827402972455","7126745726494821640"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/app/v3/fetch_multi_video_v2":{"post":{"tags":["Douyin-App-V3-API"],"summary":"批量获取视频信息 V2/Batch Get Video Information V2","description":"# [中文]\n### 用途:\n- 批量获取视频信息，支持图文、视频等，一次性最多支持50个视频，此接口收费固定价格为0.001$ * 50 = 0.05$一次。\n### 参数:\n- aweme_ids: 作品id列表，最多支持50个作品id。\n### 返回:\n- 作品数据\n### 备注:\n- 如果接口出现返回空的情况，请使用一样的参数去请求 Web 版本接口，具体响应状态码参考：\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8：该内容因海外版权限制，暂时无法观看（短剧，电影片段等）\n    - 8：视频不存在或已被删除\n    - 5：该内容被标记为私人内容，没有公开展示权限\n    - 10：该内容被标记为部分可见，仅作者选择的部分用户可见\n    - 更多状态码请提交给我们的客户支持进行补充。\n\n# [English]\n### Purpose:\n- Batch Get Video Information, support photo, video, etc., up to 50 videos at a time, this interface charges a fixed price of 0.001$ * 50 = 0.05$ each time.\n### Parameters:\n- aweme_ids: List of video ids, up to 50 video ids are supported.\n### Return:\n- Video data\n### Note:\n- If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)\n    - 8: The video does not exist or has been deleted\n    - 5: This content is marked as private content and does not have public display permissions\n    - 10: This content is marked as partially visible, only visible to some users chosen by the author\n    - For more status codes, please submit them to our customer support for supplementation.\n\n# [示例/Example]\naweme_ids = [\"7448118827402972455\", \"7126745726494821640\", \"7448118827402972455\", \"7126745726494821640\", \"7448118827402972455\", \"7126745726494821640\", \"7448118827402972455\", \"7126745726494821640\", \"7448118827402972455\", \"7126745726494821640\"]","operationId":"fetch_multi_video_v2_api_v1_douyin_app_v3_fetch_multi_video_v2_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Aweme Ids"},"example":["7448118827402972455","7126745726494821640","7448118827402972455","7126745726494821640","7448118827402972455","7126745726494821640","7448118827402972455","7126745726494821640","7448118827402972455","7126745726494821640"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/app/v3/fetch_one_video_by_share_url":{"get":{"tags":["Douyin-App-V3-API"],"summary":"根据分享链接获取单个作品数据/Get single video data by sharing link","description":"# [中文]\n### 用途:\n- 根据分享链接获取单个作品数据\n### 参数:\n- share_url: 分享链接\n### 返回:\n- 作品数据\n### 备注:\n- 如果接口出现返回空的情况，请使用一样的参数去请求 Web 版本接口，具体响应状态码参考：\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8：该内容因海外版权限制，暂时无法观看（短剧，电影片段等）\n    - 8：视频不存在或已被删除\n    - 5：该内容被标记为私人内容，没有公开展示权限\n    - 10：该内容被标记为部分可见，仅作者选择的部分用户可见\n    - 更多状态码请提交给我们的客户支持进行补充。\n\n# [English]\n### Purpose:\n- Get single video data by sharing link\n### Parameters:\n- share_url: Share link\n### Return:\n- Video data\n### Note:\n- If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:\n    - JSON PATH: $.data.filter_list[0].reason\n    - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)\n    - 8: The video does not exist or has been deleted\n    - 5: This content is marked as private content and does not have public display permissions\n    - 10: This content is marked as partially visible, only visible to some users chosen by the author\n    - For more status codes, please submit them to our customer support for supplementation.\n\n# [示例/Example]\nshare_url = \"https://v.douyin.com/e3x2fjE/\"","operationId":"fetch_one_video_by_share_url_api_v1_douyin_app_v3_fetch_one_video_by_share_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_url","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Url"},"description":"分享链接/Share link","example":"https://v.douyin.com/e3x2fjE/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_video_high_quality_play_url":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取视频的最高画质播放链接/Get the highest quality play URL of the video","description":"# [中文]\n### 用途:\n- 价格：0.005$ 一次。\n- 获取视频的最高画质(原始上传画质)播放链接\n- 该接口会返回最高画质的播放链接，原始上传画质是指用户上传视频时的画质，通常最高画质视频无压缩码率并且文件头包含元数据。\n- 最高画质的视频链接无法从抖音APP或网页版直接获取，需要通过此接口获取。\n- 此接口非常适合用于获取高清无水印视频链接，适用于需要高质量视频的场景，如视频编辑、存档、训练模型等。\n- 一般情况都可以在线播放，如果不行，可以尝试使用IDM或浏览器下载后播放。\n### 参数:\n- aweme_id: 作品id，优先使用aweme_id，如果没有则使用share_url。\n- share_url: 可选，分享链接，如果提供了作品id，则此参数可以不传。\n### 返回:\n- video_id： 作品id\n- original_video_url： 最高画质(原始上传画质)播放链接\n- video_data： 视频数据，包含视频的元数据，如时长、大小等。\n\n# [English]\n### Purpose:\n- Price: 0.005$ each time.\n- Get the highest quality (original upload quality) play URL of the video\n- This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata.\n- The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface.\n- This interface is very suitable for obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc.\n- Generally, it can be played online, if not, you can try to download it using IDM or a browser and then play it.\n### Parameters:\n- aweme_id: Video id, prefer to use aweme_id, if not available, use share_url.\n- share_url: Optional, share link, if the video id is provided, this parameter can be omitted.\n### Return:\n- video_id: Video id\n- original_video_url: Highest quality (original upload quality) play URL\n- video_data: Video data, including metadata such as duration, size, etc.\n# [示例/Example]\naweme_id = \"7512756548356492544\"\nshare_url = \"https://www.douyin.com/video/7512756548356492544\"","operationId":"fetch_video_high_quality_play_url_api_v1_douyin_app_v3_fetch_video_high_quality_play_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":false,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7512756548356492544"},{"name":"share_url","in":"query","required":false,"schema":{"type":"string","description":"可选，分享链接/Optional, share link","title":"Share Url"},"description":"可选，分享链接/Optional, share link","example":"https://www.douyin.com/video/7512756548356492544"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_multi_video_high_quality_play_url":{"post":{"tags":["Douyin-App-V3-API"],"summary":"批量获取视频的最高画质播放链接/Batch get the highest quality play URL of videos","description":"# [中文]\n### 用途:\n- 此接口目前优惠活动价为$0.25，活动结束后恢复原价$0.5。不足50个视频按50个视频收费。\n- 批量获取视频的最高画质(原始上传画质)播放链接\n- 该接口会返回最高画质的播放链接，原始上传画质是指用户上传视频时的画质，通常最高画质视频无压缩码率并且文件头包含元数据。\n- 最高画质的视频链接无法从抖音APP或网页版直接获取，需要通过此接口获取。\n- 此接口非常适合用于批量获取高清无水印视频链接，适用于需要高质量视频的场景，如视频编辑、存档、训练模型等。\n- 使用并发请求，提高批量获取效率。\n- 最多支持50个视频ID。\n### 参数:\n- aweme_ids: 作品id列表，用逗号分隔，例如: \"123,456,789\"，最多50个。\n### 返回:\n- total: 总数\n- success_count: 成功数量\n- failed_count: 失败数量\n- videos: 视频列表，每个视频包含以下字段：\n    - video_id: 作品id\n    - original_video_url: 最高画质(原始上传画质)播放链接\n    - file_size: 文件大小（字节）\n    - file_size_in_mb: 文件大小（MB）\n    - content_type: 内容类型\n    - success: 是否成功\n    - error: 错误信息（如果失败）\n### 备注:\n- 由于数量较多，处理时间可能会稍长，请增加等待时间。\n\n# [English]\n### Purpose:\n- This interface is currently on sale for $0.25, and will return to the original price of $0.5 after the event ends. If there are less than 50 videos, they will be charged as 50 videos.\n- Batch get the highest quality (original upload quality) play URL of videos\n- This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata.\n- The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface.\n- This interface is very suitable for batch obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc.\n- Use concurrent requests to improve batch acquisition efficiency.\n- Support up to 50 video IDs.\n### Parameters:\n- aweme_ids: Video id list, separated by commas, for example: \"123,456,789\", up to 50.\n### Return:\n- total: Total count\n- success_count: Success count\n- failed_count: Failed count\n- videos: Video list, each video contains the following fields:\n    - video_id: Video id\n    - original_video_url: Highest quality (original upload quality) play URL\n    - file_size: File size (bytes)\n    - file_size_in_mb: File size (MB)\n    - content_type: Content type\n    - success: Whether successful\n    - error: Error message (if failed)\n### Note:\n- Due to the large number, the processing time may be slightly longer, please increase the waiting time.\n# [示例/Example]\naweme_ids = \"7512756548356492544,7448118827402972455,7126745726494821640\"","operationId":"fetch_multi_video_high_quality_play_url_api_v1_douyin_app_v3_fetch_multi_video_high_quality_play_url_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchMultiVideoHighQualityPlayUrlRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/app/v3/fetch_video_statistics":{"get":{"tags":["Douyin-App-V3-API"],"summary":"根据视频ID获取作品的统计数据（点赞数、下载数、播放数、分享数）/Get the statistical data of the Post according to the video ID (like count, download count, play count, share count)","description":"# [中文]\n### 用途:\n- 根据视频ID获取作品的统计数据\n- 抖音大多数接口已经不再返回作品的播放数，只能通过此接口获取。\n- 可以获取到的统计有：\n    - 点赞数（digg_count）\n    - 下载数（download_count）\n    - 播放数（play_count）\n    - 分享数（share_count）\n### 参数:\n- aweme_ids: 作品id，支持多个视频id，用逗号隔开即可，不能超过2个，单个也可以，则无需逗号。\n### 返回:\n- 作品统计数据\n\n# [English]\n### Purpose:\n- Get the statistical data of the Post according to the video ID\n- Most of the Douyin interfaces no longer return the number of plays of the Post, and can only be obtained through this interface.\n- List of statistics that can be obtained:\n    - Like count (digg_count)\n    - Download count (download_count)\n    - Play count (play_count)\n    - Share count (share_count)\n### Parameters:\n- aweme_ids: Video id, supports multiple video ids, separated by commas, no more than 2, single is also possible, no need for commas.\n### Return:\n- Post statistics data\n\n# [示例/Example]\naweme_ids = \"7448118827402972455,7126745726494821640\"","operationId":"fetch_video_statistics_api_v1_douyin_app_v3_fetch_video_statistics_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_ids","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Ids"},"description":"作品id/Video id","example":"7448118827402972455,7126745726494821640"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_multi_video_statistics":{"get":{"tags":["Douyin-App-V3-API"],"summary":"根据视频ID批量获取作品的统计数据（点赞数、下载数、播放数、分享数）/Get the statistical data of the Post according to the video ID (like count, download count, play count, share count)","description":"# [中文]\n### 用途:\n- 根据视频ID获取作品的统计数据，支持多个视频id，一次性最多支持50个视频。\n- 抖音大多数接口已经不再返回作品的播放数，只能通过此接口获取。\n- 价格为：0.025$一次。\n- 可以获取到的统计有：\n    - 点赞数（digg_count）\n    - 下载数（download_count）\n    - 播放数（play_count）\n    - 分享数（share_count）\n### 参数:\n- aweme_ids: 作品id，支持多个视频id，用逗号隔开即可，不能超过50个，单个也可以，则无需逗号。\n### 返回:\n- 作品统计数据\n\n# [English]\n### Purpose:\n- Get the statistical data of the Post according to the video ID, support multiple video ids, up to 50 videos at a time.\n- Most of the Douyin interfaces no longer return the number of plays of the Post, and can only be obtained through this interface.\n- Price: 0.025$ each time.\n- List of statistics that can be obtained:\n    - Like count (digg_count)\n    - Download count (download_count)\n    - Play count (play_count)\n    - Share count (share_count)\n### Parameters:\n- aweme_ids: Video id, supports multiple video ids, separated by commas, no more than 50, single is also possible, no need for commas.\n### Return:\n- Post statistics data\n\n# [示例/Example]\naweme_ids = \"7448118827402972455,7126745726494821640\"","operationId":"fetch_multi_video_statistics_api_v1_douyin_app_v3_fetch_multi_video_statistics_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_ids","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Ids"},"description":"作品id/Video id","example":"7448118827402972455,7126745726494821640"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/add_video_play_count":{"get":{"tags":["Douyin-App-V3-API"],"summary":"根据视频ID来增加作品的播放数/Increase the number of plays of the work according to the video ID","description":"# [中文]\n### 用途:\n- 根据视频ID来增加作品的播放数\n- 该接口默认使用游客Cookie，如果需要使用登录用户的Cookie，请在参数中传入。\n- 单一作品每次调用增加1次播放数，请求约 `1000` 次后会被抖音限制，需要等待一段时间（如：2小时后）后再继续调用。\n- 该限制是针对作品的，不是针对接口的，在未登录的情况下，使用不同IP的浏览器或在APP中浏览作品，该作品的播放数也不会增加。\n- 可以携带抖音网页端的Cookie来请求此接口，但是不保证一定有效，需要自行测试。\n- 上述的限制是根据测试结果得出的，具体限制可能会有所不同，仅供参考。\n### 参数:\n- aweme_type: 作品类型，0:视频 1:图文，可以从单一作品数据接口中获取。\n- item_id: 作品id，别名为aweme_id\n- cookie: 可选，默认使用游客Cookie\n### 返回:\n- 当前时间戳和状态码，状态码为200时表示成功，否则为失败，可以尝试更换一个作品id再次调用，或者等待一段时间后再次调用。\n\n# [English]\n### Purpose:\n- Increase the number of plays of the work according to the video ID\n- This interface uses guest Cookie by default. If you need to use the Cookie of the logged-in user, please pass it in the parameters.\n- Each call to a single work increases the number of plays by 1. After about `1000` calls, Douyin will restrict it. You need to wait for a period of time (such as 2 hours) before continuing to call.\n- This restriction is for the work, not for the interface. When browsing the work without logging in, using different IP browsers or browsing the work in the APP, the number of plays of the work will not increase.\n- You can carry the Cookie of the Douyin web page to request this interface, but it is not guaranteed to be effective and needs to be tested by yourself.\n- The above restrictions are based on test results, and the specific restrictions may vary, for reference only.\n### Parameters:\n- aweme_type: Video type, 0: Video 1: Graphic and text, can be obtained from the single work data interface.\n- item_id: Video id, alias aweme_id\n- cookie: Optional, use guest Cookie by default\n### Return:\n- The current timestamp and status code. When the status code is 200, it means success, otherwise it is a failure. You can try to change another work id and call it again, or wait for a period of time and call it again.\n\n# [示例/Example]\naweme_type = 0\nitem_id = \"7197598285882789120\"\ncookie = None","operationId":"add_video_play_count_api_v1_douyin_app_v3_add_video_play_count_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_type","in":"query","required":true,"schema":{"type":"integer","description":"作品类型/Video type","title":"Aweme Type"},"description":"作品类型/Video type","example":0},{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7197598285882789120"},{"name":"cookie","in":"query","required":false,"schema":{"type":"string","description":"可选，默认使用游客Cookie/Optional, use guest Cookie by default","title":"Cookie"},"description":"可选，默认使用游客Cookie/Optional, use guest Cookie by default"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/handler_user_profile":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定用户的信息/Get information of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户的信息\n### 参数:\n- sec_user_id: 用户sec_user_id\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get information of specified user\n### Parameters:\n- sec_user_id: User sec_user_id\n### Return:\n- User information\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y\"","operationId":"handler_user_profile_api_v1_douyin_app_v3_handler_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":true,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_user_fans_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取用户粉丝列表/Get user fans list","description":"# [中文]\n### 用途:\n- 获取用户粉丝列表\n### 参数:\n- sec_user_id: 用户sec_user_id\n- max_time: 最大时间戳，默认为0，后续从返回数据中获取，用于翻页。\n- count: 数量，默认为20，建议保持不变。\n### 返回:\n- 粉丝列表\n\n# [English]\n### Purpose:\n- Get user fans list\n### Parameters:\n- sec_user_id: User sec_user_id\n- max_time: Maximum timestamp, default is 0, get from the returned data later, used for paging.\n- count: Number, default is 20, it is recommended to keep it unchanged.\n### Return:\n- Fans list\n\n# [示例/Example]\nsec_user = \"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70\"\nmax_time = \"0\"\ncount = 20","operationId":"fetch_user_fans_list_api_v1_douyin_app_v3_fetch_user_fans_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","default":"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id"},{"name":"max_time","in":"query","required":false,"schema":{"type":"string","description":"最大时间戳/Maximum timestamp","default":"0","title":"Max Time"},"description":"最大时间戳/Maximum timestamp"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_user_following_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取用户关注列表 (弃用，使用 /api/v1/douyin/web/fetch_user_following_list 替代)/Get user following list (Deprecated, use /api/v1/douyin/web/fetch_user_following_list instead)","description":"# [中文]\n### 用途:\n- 获取用户关注列表\n### 参数:\n- sec_user_id: 用户sec_user_id\n- max_time: 最大时间戳，默认为0，后续从返回数据中获取，用于翻页。\n- count: 数量，默认为20，建议保持不变。\n### 返回:\n- 关注列表\n\n# [English]\n### Purpose:\n- Get user following list\n### Parameters:\n- sec_user_id: User sec_user_id\n- max_time: Maximum timestamp, default is 0, get from the returned data later, used for paging.\n- count: Number, default is 20, it is recommended to keep it unchanged.\n### Return:\n- Following list\n\n# [示例/Example]\nsec_user = \"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70\"\nmax_time = \"0\"\ncount = 20","operationId":"fetch_user_following_list_api_v1_douyin_app_v3_fetch_user_following_list_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","default":"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id"},{"name":"max_time","in":"query","required":false,"schema":{"type":"string","description":"最大时间戳/Maximum timestamp","default":"0","title":"Max Time"},"description":"最大时间戳/Maximum timestamp"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_user_post_videos":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取用户主页作品数据/Get user homepage video data","description":"# [中文]\n### 用途:\n- 获取用户主页作品数据\n### 参数:\n- sec_user_id: 用户sec_user_id\n- max_cursor: 最大游标，用于翻页，第一页为0，第二页为第一次响应中的max_cursor值。\n- count: 最大数量，不要超过20，建议保持不变。\n- sort_type: 排序类型，可选值如下：\n    - `0`: 最新排序-默认\n    - `1`: 最热排序\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user homepage video data\n### Parameters:\n- sec_user_id: User sec_user_id\n- max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response.\n- count: Maximum count number, do not exceed 20, it is recommended to keep it unchanged.\n- sort_type: Sort type, optional values are as follows:\n    - `0`: Latest sorting - default\n    - `1`: Hottest sorting\n### Return:\n- User video data\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE\"\nmax_cursor = 0\ncounts = 20\nsort_type = 0","operationId":"fetch_user_post_videos_api_v1_douyin_app_v3_fetch_user_post_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":true,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE"},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Maximum cursor","default":0,"title":"Max Cursor"},"description":"最大游标/Maximum cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Count"},"description":"每页数量/Number per page"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型/Sort type","default":0,"title":"Sort Type"},"description":"排序类型/Sort type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_user_like_videos":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取用户喜欢作品数据/Get user like video data","description":"# [中文]\n### 用途:\n- 获取用户喜欢作品数据\n### 参数:\n- sec_user_id: 用户sec_user_id\n- max_cursor: 最大游标，用于翻页，第一页为0，第二页为第一次响应中的max_cursor值。\n- count: 最大数量\n### 返回:\n- 用户作品数据\n\n# [English]\n### Purpose:\n- Get user like video data\n### Parameters:\n- sec_user_id: User sec_user_id\n- max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response.\n- count: Maximum count number\n### Return:\n- User video data\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y\"\nmax_cursor = 0\ncounts = 20","operationId":"fetch_user_like_videos_api_v1_douyin_app_v3_fetch_user_like_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":true,"schema":{"type":"string","description":"用户sec_user_id/User sec_user_id","title":"Sec User Id"},"description":"用户sec_user_id/User sec_user_id","example":"MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y"},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"integer","description":"最大游标/Maximum cursor","default":0,"title":"Max Cursor"},"description":"最大游标/Maximum cursor"},{"name":"counts","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Number per page","default":20,"title":"Counts"},"description":"每页数量/Number per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_video_comments":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取单个视频评论数据/Get single video comments data","description":"# [中文]\n### 用途:\n- 获取单个视频评论数据\n### 参数:\n- aweme_id: 作品id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量，请保持默认，否则会出现BUG。\n### 返回:\n- 评论数据\n\n# [English]\n### Purpose:\n- Get single video comments data\n### Parameters:\n- aweme_id: Video id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number Please keep the default, otherwise there will be BUG.\n### Return:\n- Comments data\n\n# [示例/Example]\naweme_id = \"7448118827402972455\"\ncursor = 0\ncount = 20","operationId":"fetch_video_comments_api_v1_douyin_app_v3_fetch_video_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7448118827402972455"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_video_comment_replies":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定视频的评论回复数据/Get comment replies data of specified video","description":"# [中文]\n### 用途:\n- 获取指定视频的评论回复数据\n### 参数:\n- item_id: 作品id\n- comment_id: 评论id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量，请保持默认，否则会出现BUG。\n### 返回:\n- 评论回复数据\n\n# [English]\n### Purpose:\n- Get comment replies data of specified video\n### Parameters:\n- item_id: Video id\n- comment_id: Comment id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number Please keep the default, otherwise there will be BUG.\n### Return:\n- Comment replies data\n\n# [示例/Example]\naweme_id = \"7354666303006723354\"\ncomment_id = \"7354669356632638218\"\ncursor = 0\ncount = 20","operationId":"fetch_video_comments_reply_api_v1_douyin_app_v3_fetch_video_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7354666303006723354"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论id/Comment id","title":"Comment Id"},"description":"评论id/Comment id","example":"7354669356632638218"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_video_mix_detail":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取抖音视频合集详情数据/Get Douyin video mix detail data","description":"# [中文]\n### 用途:\n- 获取抖音视频合集详情数据\n### 参数:\n- mix_id: 合集id\n### 返回:\n- 视频合集详情数据\n\n# [English]\n### Purpose:\n- Get Douyin video mix detail data\n### Parameters:\n- mix_id: Mix id\n### Return:\n- Video mix detail data\n\n# [示例/Example]\nmix_id = \"7302011174286002217\"","operationId":"fetch_video_mix_detail_api_v1_douyin_app_v3_fetch_video_mix_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"mix_id","in":"query","required":true,"schema":{"type":"string","description":"合集id/Mix id","title":"Mix Id"},"description":"合集id/Mix id","example":"7302011174286002217"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_video_mix_post_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取抖音视频合集作品列表数据/Get Douyin video mix post list data","description":"# [中文]\n### 用途:\n- 获取抖音视频合集作品列表数据\n### 参数:\n- mix_id: 合集id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量，请保持默认，否则会出现BUG。\n### 返回:\n- 视频合集作品列表数据\n\n# [English]\n### Purpose:\n- Get Douyin video mix post list data\n### Parameters:\n- mix_id: Mix id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number Please keep the default, otherwise there will be BUG.\n### Return:\n- Video mix post list data\n\n# [示例/Example]\nmix_id = \"7302011174286002217\"\ncursor = 0\ncount = 20","operationId":"fetch_video_mix_post_list_api_v1_douyin_app_v3_fetch_video_mix_post_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"mix_id","in":"query","required":true,"schema":{"type":"string","description":"合集id/Mix id","title":"Mix Id"},"description":"合集id/Mix id","example":"7302011174286002217"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_user_series_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取用户短剧合集列表/Get user series list","description":"# [中文]\n### 用途:\n- 获取用户的短剧合集列表\n### 参数:\n- user_id: 用户id，与sec_user_id二选一即可\n- sec_user_id: 用户加密id，与user_id二选一即可\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n### 返回:\n- 用户短剧合集列表数据\n### 备注:\n- 该接口返回用户发布的所有短剧合集\n- 响应中的 series_id 可用于获取短剧详情和视频列表\n\n# [English]\n### Purpose:\n- Get user's series/playlet collection list\n### Parameters:\n- user_id: User id\n- sec_user_id: User encrypted id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n### Return:\n- User series list data\n### Note:\n- This interface returns all series collections published by the user\n- The series_id in the response can be used to get series details and video list\n\n# [示例/Example]\nuser_id = \"3010877781453635\"\nsec_user_id = \"MS4wLjABAAAAfAU5kMk-W4569G1z2iRsy8t6-kOxO17Eaz6yte4NQokeUeOpeqTGEc480e34O8lK\"\ncursor = 0","operationId":"fetch_user_series_list_api_v1_douyin_app_v3_fetch_user_series_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户id/User id","default":"","title":"User Id"},"description":"用户id/User id","example":"3010877781453635"},{"name":"sec_user_id","in":"query","required":false,"schema":{"type":"string","description":"用户加密id/User sec id","default":"","title":"Sec User Id"},"description":"用户加密id/User sec id","example":"MS4wLjABAAAAfAU5kMk-W4569G1z2iRsy8t6-kOxO17Eaz6yte4NQokeUeOpeqTGEc480e34O8lK"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_series_video_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取短剧视频列表/Get series video list","description":"# [中文]\n### 用途:\n- 获取短剧视频列表\n### 参数:\n- series_id: 短剧id\n- cursor: 游标，用于翻页，第一页为0，第二页通常为count的值（如15）。\n### 返回:\n- 短剧视频列表数据\n### 备注:\n- 该接口返回短剧中的所有视频列表\n- 响应中的 aweme_list 包含短剧的各集视频信息\n- has_more 字段表示是否还有更多数据\n\n# [English]\n### Purpose:\n- Get series/playlet video list\n### Parameters:\n- series_id: Series id\n- cursor: Cursor, used for paging, the first page is 0, the second page is usually the value of count (e.g., 15).\n### Return:\n- Series video list data\n### Note:\n- This interface returns all video list in the series\n- The aweme_list in the response contains video information of each episode\n- The has_more field indicates whether there is more data\n\n# [示例/Example]\nseries_id = \"7592054624643713067\"\ncursor = 0","operationId":"fetch_series_video_list_api_v1_douyin_app_v3_fetch_series_video_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"series_id","in":"query","required":true,"schema":{"type":"string","description":"短剧id/Series id","title":"Series Id"},"description":"短剧id/Series id","example":"7592054624643713067"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_series_detail":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取短剧详情信息/Get series detail","description":"# [中文]\n### 用途:\n- 获取短剧详情信息\n### 参数:\n- series_id: 短剧id\n### 返回:\n- 短剧详情数据\n### 备注:\n- 该接口返回短剧的详细信息，包括：\n    - 短剧名称、描述、封面\n    - 作者信息\n    - 总集数、更新状态\n    - 播放量、收藏量等统计数据\n    - 付费信息（如有）\n\n# [English]\n### Purpose:\n- Get series/playlet detail information\n### Parameters:\n- series_id: Series id\n### Return:\n- Series detail data\n### Note:\n- This interface returns detailed information of the series, including:\n    - Series name, description, cover\n    - Author information\n    - Total episodes, update status\n    - Play count, collection count and other statistics\n    - Payment information (if any)\n\n# [示例/Example]\nseries_id = \"7592054624643713067\"","operationId":"fetch_series_detail_api_v1_douyin_app_v3_fetch_series_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"series_id","in":"query","required":true,"schema":{"type":"string","description":"短剧id/Series id","title":"Series Id"},"description":"短剧id/Series id","example":"7592054624643713067"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_general_search_result":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定关键词的综合搜索结果（弃用，替代接口见下方文档说明）/Get comprehensive search results of specified keywords (deprecated, see the documentation below for alternative interfaces)","description":"# [中文]\n### 用途:\n- 获取指定关键词的综合搜索结果\n- 该接口已弃用，替代接口为：https://docs.tikhub.io/370212773e0\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量，请保持默认，否则会出现BUG。\n- sort_type: 0:综合排序 1:最多点赞 2:最新发布\n- publish_time: 0:不限 1:最近一天 7:最近一周 180:最近半年\n- filter_duration: 0:不限 0-1:1分钟以内 1-5:1-5分钟 5-10000:5分钟以上\n- content_type: 0:不限 1:视频 2:图片 3:文章\n### 返回:\n- 综合搜索结果\n\n# [English]\n### Purpose:\n- Get comprehensive search results of specified keywords\n- This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212773e0\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number Please keep the default, otherwise there will be BUG.\n- sort_type: 0: Comprehensive sorting 1: Most likes 2: Latest release\n- publish_time: 0: Unlimited 1: Last day 7: Last week 180: Last half year\n- filter_duration: 0: Unlimited 0-1: Within 1 minute 1-5: 1-5 minutes 5-10000: More than 5 minutes\n- content_type: 0: Unlimited 1: Video 2: Picture 3: Article\n### Return:\n- Comprehensive search results\n\n# [示例/Example]\nkeyword = \"中华娘\"\noffset = 0\ncount = 20\nsort_type = \"0\"\npublish_time = \"0\"\nfilter_duration = \"0\"\ncontent_type = \"0\"","operationId":"fetch_general_search_result_api_v1_douyin_app_v3_fetch_general_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序类型/Sort type","default":"0","title":"Sort Type"},"description":"排序类型/Sort type"},{"name":"publish_time","in":"query","required":false,"schema":{"type":"string","description":"发布时间/Publish time","default":"0","title":"Publish Time"},"description":"发布时间/Publish time"},{"name":"filter_duration","in":"query","required":false,"schema":{"type":"string","description":"时长/Duration","default":"0","title":"Filter Duration"},"description":"时长/Duration"},{"name":"content_type","in":"query","required":false,"schema":{"type":"string","description":"内容类型/Content type","default":"0","title":"Content Type"},"description":"内容类型/Content type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_video_search_result":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定关键词的视频搜索结果（弃用，替代接口见下方文档说明）/Get video search results of specified keywords (deprecated, see the documentation below for alternative interfaces)","description":"# [中文]\n### 用途:\n- 获取指定关键词的视频搜索结果\n- 该接口已弃用，替代接口为：https://docs.tikhub.io/370212780e0\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量，请保持默认，否则会出现BUG。\n- sort_type: 0:综合排序 1:最多点赞 2:最新发布\n- publish_time: 0:不限 1:最近一天 7:最近一周 180:最近半年\n- filter_duration: 0:不限 0-1:1分钟以内 1-5:1-5分钟 5-10000:5分钟以上\n- content_type: 0:不限 1:视频 2:图文\n### 返回:\n- 视频搜索结果\n\n# [English]\n### Purpose:\n- Get video search results of specified keywords\n- This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212780e0\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number Please keep the default, otherwise there will be BUG.\n- sort_type: 0: Comprehensive sorting 1: Most likes 2: Latest release\n- publish_time: 0: Unlimited 1: Last day 7: Last week 180: Last half year\n- filter_duration: 0: Unlimited 0-1: Within 1 minute 1-5: 1-5 minutes 5-10000: More than 5 minutes\n- content_type: 0: Unlimited 1: Video 2: Graphic and text\n### Return:\n- Video search results\n\n# [示例/Example]\nkeyword = \"中华娘\"\noffset = 0\ncount = 20\nsort_type = \"0\"\npublish_time = \"0\"\nfilter_duration = \"0\"","operationId":"fetch_video_search_result_api_v1_douyin_app_v3_fetch_video_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序类型/Sort type","default":"0","title":"Sort Type"},"description":"排序类型/Sort type"},{"name":"publish_time","in":"query","required":false,"schema":{"type":"string","description":"发布时间/Publish time","default":"0","title":"Publish Time"},"description":"发布时间/Publish time"},{"name":"filter_duration","in":"query","required":false,"schema":{"type":"string","description":"时长/Duration","default":"0","title":"Filter Duration"},"description":"时长/Duration"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_video_search_result_v2":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定关键词的视频搜索结果 V2 （弃用，替代接口见下方文档说明）/Get video search results of specified keywords V2 (deprecated, see the documentation below for alternative interfaces)","description":"# [中文]\n### 用途:\n- 获取指定关键词的视频搜索结果V2，此接口稳定性更好，收费更贵，当`/api/v1/douyin/web/fetch_video_search_result`接口不稳定时，建议使用此接口。\n- 收费标准为：0.01$每次请求。\n- 该接口已弃用，替代接口为：https://docs.tikhub.io/370212780e0\n### 参数:\n- keyword: 关键词\n- sort_type:\n    - 排序类型，可用值如下：\n    - _0 :综合(General)\n    - _1 :最多点赞(More likes)\n    - _2 :最新发布(New)\n- publish_time：\n    - 发布时间，可用值如下：\n    - _0 :不限(No Limit)\n    - _1 :一天之内(last 1 day)\n    - _7 :一周之内(last 1 week)\n    - _180 :半年之内(last half year)\n- filter_duration：\n    - 视频时长，可用值如下：\n    - _0 :不限(No Limit)\n    - _1 :1分钟以下(1 minute and below)\n    - _2 :1-5分钟 (1-5 minutes)\n    - _3 :5分钟以上(5 minutes more)\n- page: 页码\n    - 默认从1开始，然后依次递增加1\n- search_id: 搜索id，第一次请求时为空，第二次翻页时需要提供，需要从上一次请求的返回响应中获取。\n    - 例如: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### 返回:\n- 视频搜索结果V2\n\n# [English]\n### Purpose:\n- Get video search results of specified keywords V2, this interface has better stability and higher cost, when the `/api/v1/douyin/web/fetch_video_search_result` interface is unstable, it is recommended to use this interface.\n- The charging standard is: $0.01 per request.\n- This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212780e0\n### Parameters:\n- keyword: Keyword\n- sort_type:\n    - Sort type, available values are as follows:\n    - _0 : General\n    - _1 : More likes\n    - _2 : New\n- publish_time:\n    - Publish time, available values are as follows:\n    - _0 : No Limit\n    - _1 : last 1 day\n    - _7 : last 1 week\n    - _180 : last half year\n- filter_duration:\n    - Duration filter, available values are as follows:\n    - _0 : No Limit\n    - _1 : 1 minute and below\n    - _2 : 1-5 minutes\n    - _3 : 5 minutes more\n- page: Page\n    - Start from 1 by default, then increase by 1 each time\n- search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.\n    - For example: search_id = \"2024083107320448E367ECDCCC6B71F7F3\"\n    - JSON Path-1 : $.data.extra.logid\n    - JSON Path-2 : $.data.log_pb.impr_id\n### Return:\n- Video search results V2\n\n# [示例/Example]\nkeyword = \"中华娘\"\nsort_type = \"_0\"\npublish_time = \"_0\"\nfilter_duration = \"_0\"\npage = 1\nsearch_id = \"\"","operationId":"fetch_video_search_result_v2_api_v1_douyin_app_v3_fetch_video_search_result_v2_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序类型/Sort type","default":"_0","title":"Sort Type"},"description":"排序类型/Sort type"},{"name":"publish_time","in":"query","required":false,"schema":{"type":"string","description":"发布时间/Publish time","default":"_0","title":"Publish Time"},"description":"发布时间/Publish time"},{"name":"filter_duration","in":"query","required":false,"schema":{"type":"string","description":"视频时长/Duration filter","default":"_0","title":"Filter Duration"},"description":"视频时长/Duration filter"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page","default":1,"title":"Page"},"description":"页码/Page"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索id，翻页时需要提供/Search id, need to provide when paging","default":"","title":"Search Id"},"description":"搜索id，翻页时需要提供/Search id, need to provide when paging"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_user_search_result":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定关键词的用户搜索结果（弃用，替代接口见下方文档说明）/Get user search results of specified keywords (deprecated, see the documentation below for alternative interfaces)","description":"# [中文]\n### 用途:\n- 获取指定关键词的用户搜索结果\n- 该接口已弃用，替代接口为：https://docs.tikhub.io/370212785e0\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量，请保持默认，否则会出现BUG。\n- douyin_user_fans(粉丝数量):\n    - \"\": 不限\n    - \"0_1k\": 1000以下\n    - \"1k_1w\": 1000-1万\n    - \"1w_10w\": 1w-10w\n    - \"10w_100w\": 10w-100w\n    - \"100w_\": 100w以上\n- douyin_user_type(用户类型，请使用英文而不是中文):\n    - \"\": 不限\n    - \"common_user\": 普通用户\n    - \"enterprise_user\": 企业认证\n    - \"personal_user\": 个人认证\n### 返回:\n- 用户搜索结果\n\n# [English]\n### Purpose:\n- Get user search results of specified keywords\n- This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212785e0\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number Please keep the default, otherwise there will be BUG.\n- douyin_user_fans(Fans):\n    - \"\": Unlimited\n    - \"0_1k\": Less than 1000\n    - \"1k_1w\": 1000-10,000\n    - \"1w_10w\": 10,000-100,000\n    - \"10w_100w\": 100,000-1,000,000\n    - \"100w_\": More than 1,000,000\n- douyin_user_type(User type, please use English instead of Chinese):\n    - \"\": Unlimited\n    - \"common_user\": Common user\n    - \"enterprise_user\": Enterprise certification\n    - \"personal_user\": Personal certification\n### Return:\n- User search results\n\n# [示例/Example]\nkeyword = \"动漫\"\noffset = 0\ncount = 20","operationId":"fetch_user_search_result_api_v1_douyin_app_v3_fetch_user_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"},{"name":"douyin_user_fans","in":"query","required":false,"schema":{"type":"string","description":"粉丝数/Fans","default":"","title":"Douyin User Fans"},"description":"粉丝数/Fans"},{"name":"douyin_user_type","in":"query","required":false,"schema":{"type":"string","description":"用户类型/User type","default":"","title":"Douyin User Type"},"description":"用户类型/User type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_live_search_result":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定关键词的直播搜索结果（弃用，替代接口见下方文档说明）/Get live search results of specified keywords (deprecated, see the documentation below for alternative interfaces)","description":"# [中文]\n### 用途:\n- 获取指定关键词的直播搜索结果\n- 该接口已弃用，替代接口为：https://docs.tikhub.io/370212789e0\n### 参数:\n- keyword: 关键词\n- cursor: 偏移量，从0开始，每次请求从上次请求返回响应中的cursor中获取。\n- count: 数量，请保持默认，否则会出现BUG。\n### 返回:\n- 直播搜索结果\n\n# [English]\n### Purpose:\n- Get live search results of specified keywords\n- This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212789e0\n### Parameters:\n- keyword: Keyword\n- cursor: Offset, starting from 0, each request gets from the cursor in the response returned by the last request.\n- count: Number Please keep the default, otherwise there will be BUG.\n### Return:\n- Live search results\n\n# [示例/Example]\nkeyword = \"小米商城\"\ncursor = 0\ncount = 20","operationId":"fetch_live_search_result_api_v1_douyin_app_v3_fetch_live_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"小米商城"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Cursor"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_music_search_result":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定关键词的音乐搜索结果（弃用，替代接口见下方文档说明）/Get music search results of specified keywords (deprecated, see the documentation below for alternative interfaces)","description":"# [中文]\n### 用途:\n- 获取指定关键词的音乐搜索结果\n- 该接口已弃用，替代接口为：https://docs.tikhub.io/370212797e0\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量，请保持默认，否则会出现BUG。\n### 返回:\n- 音乐搜索结果\n\n# [English]\n### Purpose:\n- Get music search results of specified keywords\n- This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212797e0\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number Please keep the default, otherwise there will be BUG.\n### Return:\n- Music search results\n\n# [示例/Example]\nkeyword = \"中华娘\"\noffset = 0\ncount = 20","operationId":"fetch_music_search_result_api_v1_douyin_app_v3_fetch_music_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_hashtag_search_result":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定关键词的话题搜索结果（弃用，替代接口见下方文档说明）/Get hashtag search results of specified keywords (deprecated, see the documentation below for alternative interfaces)","description":"# [中文]\n### 用途:\n- 获取指定关键词的话题搜索结果\n- 该接口已弃用，替代接口为：https://docs.tikhub.io/370212794e0\n### 参数:\n- keyword: 关键词\n- offset: 偏移量\n- count: 数量，请保持默认，否则会出现BUG。\n### 返回:\n- 话题搜索结果\n\n# [English]\n### Purpose:\n- Get hashtag search results of specified keywords\n- This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212794e0\n### Parameters:\n- keyword: Keyword\n- offset: Offset\n- count: Number Please keep the default, otherwise there will be BUG.\n### Return:\n- Hashtag search results\n\n# [示例/Example]\nkeyword = \"中华娘\"\noffset = 0\ncount = 20","operationId":"fetch_hashtag_search_result_api_v1_douyin_app_v3_fetch_hashtag_search_result_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"中华娘"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":20,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_music_detail":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定音乐的详情数据/Get details of specified music","description":"# [中文]\n### 用途:\n- 获取指定音乐的详情数据\n### 参数:\n- music_id: 音乐id\n### 返回:\n- 音乐详情数据\n\n# [English]\n### Purpose:\n- Get details of specified music\n### Parameters:\n- music_id: Music id\n### Return:\n- Music details data\n\n# [示例/Example]\nmusic_id = \"7136850194742315016\"","operationId":"fetch_music_detail_api_v1_douyin_app_v3_fetch_music_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"music_id","in":"query","required":true,"schema":{"type":"string","description":"音乐id/Music id","title":"Music Id"},"description":"音乐id/Music id","example":"7136850194742315016"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_music_video_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定音乐的视频列表数据/Get video list of specified music","description":"# [中文]\n### 用途:\n- 获取指定音乐的视频列表数据\n### 参数:\n- music_id: 音乐id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- count: 数量，请保持默认，否则会出现BUG。\n### 返回:\n- 音乐视频列表数据\n\n# [English]\n### Purpose:\n- Get video list of specified music\n### Parameters:\n- music_id: Music id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- count: Number Please keep the default, otherwise there will be BUG.\n### Return:\n- Music video list data\n\n# [示例/Example]\nmusic_id = \"7136850194742315016\"\ncursor = 0\ncount = 10","operationId":"fetch_music_video_list_api_v1_douyin_app_v3_fetch_music_video_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"music_id","in":"query","required":true,"schema":{"type":"string","description":"音乐id/Music id","title":"Music Id"},"description":"音乐id/Music id","example":"7136850194742315016"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":10,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_hashtag_detail":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定话题的详情数据/Get details of specified hashtag","description":"# [中文]\n### 用途:\n- 获取指定话题的详情数据\n### 参数:\n- ch_id: 话题id\n### 返回:\n- 话题详情数据\n\n# [English]\n### Purpose:\n- Get details of specified hashtag\n### Parameters:\n- ch_id: Hashtag id\n### Return:\n- Hashtag details data\n\n# [示例/Example]\nch_id = 1575791821492238","operationId":"fetch_hashtag_detail_api_v1_douyin_app_v3_fetch_hashtag_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ch_id","in":"query","required":true,"schema":{"type":"integer","description":"话题id/Hashtag id","title":"Ch Id"},"description":"话题id/Hashtag id","example":1575791821492238}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_hashtag_video_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取指定话题的作品数据/Get video list of specified hashtag","description":"# [中文]\n### 用途:\n- 获取指定话题的作品数据\n### 参数:\n- ch_id: 话题id\n- cursor: 游标，用于翻页，第一页为0，第二页为第一次响应中的cursor值。\n- sort_type: 0:综合排序 1:最多点赞 2:最新发布\n- count: 数量，请保持默认，否则会出现BUG。\n### 返回:\n- 话题作品数据\n\n# [English]\n### Purpose:\n- Get video list of specified hashtag\n### Parameters:\n- ch_id: Hashtag id\n- cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.\n- sort_type: 0: Comprehensive sorting 1: Most likes 2: Latest release\n- count: Number Please keep the default, otherwise there will be BUG.\n### Return:\n- Hashtag video list data\n\n# [示例/Example]\nch_id = 1575791821492238\ncursor = 0\nsort_type = 0\ncount = 10","operationId":"fetch_hashtag_video_list_api_v1_douyin_app_v3_fetch_hashtag_video_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ch_id","in":"query","required":true,"schema":{"type":"string","description":"话题id/Hashtag id","title":"Ch Id"},"description":"话题id/Hashtag id","example":"1575791821492238"},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","description":"游标/Cursor","default":0,"title":"Cursor"},"description":"游标/Cursor"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型/Sort type","default":0,"title":"Sort Type"},"description":"排序类型/Sort type"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Number","default":10,"title":"Count"},"description":"数量/Number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_hot_search_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取抖音热搜榜数据/Get Douyin hot search list data","description":"# [中文]\n### 用途:\n- 获取抖音热榜数据，包括：\n    - 热点榜\n    - 种草榜\n    - 娱乐榜\n    - 社会榜\n    - 挑战榜\n### 参数:\n- board_type:\n    - 0: 热点榜（默认）\n    - 2: 其他榜单，如种草榜等，需要传入对应的board_sub_type参数。\n- board_sub_type:\n    - 空字符串: 热点榜（默认）\n    - seeding: 种草榜\n    - 2: 娱乐榜\n    - 4: 社会榜\n    - hotspot_challenge: 挑战榜\n### 返回:\n- 热搜榜数据\n\n# [English]\n### Purpose:\n- Get Douyin hot search list data, including:\n    - Hot search list\n    - Seeding list\n    - Entertainment list\n    - Social list\n    - Challenge list\n\n### Parameters:\n- board_type:\n    - 0: Hot search list (default)\n    - 2: Other lists, such as seeding list, etc., need to pass in the corresponding board_sub_type parameter.\n- board_sub_type:\n    - Empty string: Hot search list (default)\n    - seeding: Seeding list\n    - 2: Entertainment list\n    - 4: Social list\n    - hotspot_challenge: Challenge list\n### Return:\n- Hot search list data\n\n# [示例/Example]\n- 获取热点榜数据\n    - board_type = 0\n    - board_sub_type = \"\"\n- 获取种草榜数据\n    - board_type = 2\n    - board_sub_type = \"seeding\"","operationId":"fetch_hot_search_list_api_v1_douyin_app_v3_fetch_hot_search_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"board_type","in":"query","required":false,"schema":{"type":"string","description":"榜单类型/Board type","default":"0","title":"Board Type"},"description":"榜单类型/Board type"},{"name":"board_sub_type","in":"query","required":false,"schema":{"type":"string","description":"榜单子类型/Board sub type","default":"","title":"Board Sub Type"},"description":"榜单子类型/Board sub type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_live_hot_search_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取抖音直播热搜榜数据/Get Douyin live hot search list data","description":"# [中文]\n### 用途:\n- 获取抖音直播热搜榜数据\n### 返回:\n- 直播热搜榜数据\n\n# [English]\n### Purpose:\n- Get Douyin live hot search list data\n### Return:\n- Live hot search list data\n\n# [示例/Example]\npass","operationId":"fetch_live_hot_search_list_api_v1_douyin_app_v3_fetch_live_hot_search_list_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/app/v3/fetch_music_hot_search_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取抖音音乐榜数据/Get Douyin music hot search list data","description":"# [中文]\n### 用途:\n- 获取抖音音乐热榜数据\n### 参数:\n- chart_type: 榜单类型，默认值为'hot'，支持下面的值：\n    - 'hot': 热门榜\n    - 'trending': 飙升榜\n    - 'original': 原创榜\n- cursor: 游标，默认值为'0'，用于分页获取数据，每次请求后会返回下一个游标值，并且通过 `has_more` 字段指示是否有更多数据可供获取。\n### 返回:\n- 音乐热搜榜数据\n\n# [English]\n### Purpose:\n- Get Douyin music hot search list data\n### Parameters:\n- chart_type: Chart type, default value is 'hot', supports the following values:\n    - 'hot': Hot chart\n    - 'trending': Trending chart\n    - 'original': Original chart\n- cursor: Cursor, default value is '0', used for paginating data retrieval. After each request, the next cursor value will be returned, and the `has_more` field indicates whether there is more data available.\n### Return:\n- Music hot search list data\n\n# [示例/Example]\nchart_type = \"hot\"\ncursor = \"0\"","operationId":"fetch_music_hot_search_list_api_v1_douyin_app_v3_fetch_music_hot_search_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"chart_type","in":"query","required":false,"schema":{"type":"string","description":"榜单类型/Chart type","default":"hot","title":"Chart Type"},"description":"榜单类型/Chart type","example":"hot"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","default":"0","title":"Cursor"},"description":"游标/Cursor","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/fetch_brand_hot_search_list":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取抖音品牌热榜分类数据/Get Douyin brand hot search list data","description":"# [中文]\n### 用途:\n- 获取抖音品牌热榜分类数据\n### 返回:\n- 品牌热搜榜分类数据\n\n# [English]\n### Purpose:\n- Get Douyin brand hot search category data\n### Return:\n- Hot brand search category data\n\n# [示例/Example]\npass","operationId":"fetch_hot_brand_search_category_api_v1_douyin_app_v3_fetch_brand_hot_search_list_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/app/v3/fetch_brand_hot_search_list_detail":{"get":{"tags":["Douyin-App-V3-API"],"summary":"获取抖音品牌热榜具体分类数据/Get Douyin brand hot search list detail data","description":"# [中文]\n### 用途:\n- 获取抖音品牌热榜具体分类数据\n### 参数:\n- category_id: 分类id\n### 返回:\n- 品牌热搜榜具体分类数据\n\n# [English]\n### Purpose:\n- Get Douyin brand hot search list detail data\n### Parameters:\n- category_id: Category id\n### Return:\n- Hot brand search list detail data\n\n# [示例/Example]\ncategory_id = 10","operationId":"fetch_hot_brand_search_api_v1_douyin_app_v3_fetch_brand_hot_search_list_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category_id","in":"query","required":true,"schema":{"type":"integer","description":"分类id/Category id","title":"Category Id"},"description":"分类id/Category id","example":10}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/generate_douyin_short_url":{"get":{"tags":["Douyin-App-V3-API"],"summary":"生成抖音短链接/Generate Douyin short link","description":"# [中文]\n### 用途:\n- 生成抖音短链接\n### 参数:\n- url: 抖音链接\n### 返回:\n- 短链接数据\n\n# [English]\n### Purpose:\n- Generate Douyin short link\n### Parameters:\n- url: Douyin link\n### Return:\n- Short link data\n\n# [示例/Example]\nurl = \"https://www.douyin.com/passport/web/logout/\"","operationId":"generate_douyin_short_url_api_v1_douyin_app_v3_generate_douyin_short_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"抖音链接/Douyin link","title":"Url"},"description":"抖音链接/Douyin link","example":"https://www.douyin.com/passport/web/logout/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/generate_douyin_video_share_qrcode":{"get":{"tags":["Douyin-App-V3-API"],"summary":"生成抖音视频分享二维码/Generate Douyin video share QR code","description":"# [中文]\n### 用途:\n- 生成抖音视频分享二维码\n### 参数:\n- object_id: 作品id或作者uid\n### 返回:\n- 二维码数据\n\n# [English]\n### Purpose:\n- Generate Douyin video share QR code\n### Parameters:\n- object_id: Video id or author uid\n### Return:\n- QR code data\n\n# [示例/Example]\nobject_id = \"7348044435755846962\"","operationId":"generate_douyin_video_share_qrcode_api_v1_douyin_app_v3_generate_douyin_video_share_qrcode_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"object_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Object Id"},"description":"作品id/Video id","example":"7348044435755846962"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/register_device":{"get":{"tags":["Douyin-App-V3-API"],"summary":"抖音APP注册设备/Douyin APP register device","description":"# [中文]\n### 用途:\n- 抖音APP注册设备，获取设备信息以及设备的Cookie信息。\n\n### 参数:\n- proxy: 代理，要带http://或https://，仅支持http代理。\n  - 格式: username:password@ip:port\n\n### 返回:\n- 设备信息以及设备的Cookie信息。\n\n# [English]\n### Purpose:\n- Register device in Douyin APP, retrieve device information and device cookies.\n\n### Parameters:\n- proxy: Proxy, with http:// or https://, only supports http proxies.\n  - Format: username:password@ip:port\n\n### Return:\n- Device information and device cookies.\n\n# [示例/Example]\nproxy = \"http://username:password@ip:port\"\n\n# [响应/Response]\n```json\n{\n    \"code\": 200,\n    \"router\": \"/api/v1/douyin/app/v3/register_device\",\n    \"params\": {\n        \"proxy\": \"username:password@ip:port\"\n    },\n    \"data\": {\n        \"iid\": \"3631064037200330\",\n        \"device_id\": \"3631064037196234\",\n        \"mssdk_token\": \"\",\n        \"device_platform\": \"android\",\n        \"channel\": \"xiaomi_64_1775\",\n        \"version_code\": 240900,\n        \"version_name\": \"24.9.0\",\n        \"manifest_version_code\": 240901,\n        \"update_version_code\": 24909900,\n        \"device_type\": \"V1963A\",\n        \"device_brand\": \"vivo\",\n        \"device_model\": \"V1963A\",\n        \"openudid\": \"5d736335afc17aab\",\n        \"os_api\": 29,\n        \"os_version\": \"10\",\n        \"resolution\": \"2400x1080\",\n        \"dpi\": 480,\n        \"host_abi\": \"arm64-v8a\",\n        \"ua\": \"com.ss.android.ugc.aweme/240901 (Linux; U; Android 10; zh_CN; V1963A; Build/compiler10301842;tt-ok/3.12.13.4-tiktok)\",\n        \"cookies\": {\n            \"install_id\": \"3631064037200330\",\n            \"odin_tt\": \"5ef413aaa319b3a4077814a1da3d3e1bcec3e8640ddc3ad30945a8518f59d1563d24c3b7a3c59d97fbd5344f13208a25cf143312acf4462b028e56cd0b611cc3fc2a64318f7375470d6db86440f92841\",\n            \"d_ticket\": \"42186c5b0c54ea1a2a9e02d4e62bf6ab\",\n            \"store-region\": \"cn-js\",\n            \"store-region-src\": \"did\",\n            \"multi_sids\": \"462868309327184:38167255076198698951907954929873\",\n            \"passport_csrf_token\": \"6f75287240634ad1f51f3b3bdcdb5424\",\n            \"passport_csrf_token_default\": \"6f75287240634ad1f51f3b3bdcdb5424\",\n            \"ttreq\": \"1$7f616210b41fc044b1f164542ac4e064288b5163\"\n        },\n        \"lanusk\": \"\",\n        \"device_manufacturer\": \"vivo\",\n        \"uuid\": \"357125675341697\",\n        \"cdid\": \"f64372bf-4d1d-4883-bc8a-d3d6fa87a9e3\",\n        \"first_launch_timestamp\": 1726970498636,\n        \"x_tt_dt\": \"AAA2FGV24A2GAOHJJ3D3XCJ32IZDZ26XXKMQAOTDNUDWTB644ISU5YA3GBYVX2Y3XVOQ3ISDH3UA4JXGGNFXBLJ6AAZU7QTIBKHFYJLDJMDG5K36LVPBRCKLHW2XM\",\n        \"BootTime\": 1726980411,\n        \"MbTime\": 1726780411,\n        \"server_time\": 1726980500,\n        \"mc\": \"2A:66:7A:2D:8B:29\",\n        \"rom\": \"compiler10301842\",\n        \"rom_version\": \"PD1963-user 10 QP1A.190711.020 compiler10301842 release-keys\"\n    }\n}\n```","operationId":"register_device_api_v1_douyin_app_v3_register_device_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proxy","in":"query","required":false,"schema":{"type":"string","description":"代理/Proxy","default":"","title":"Proxy"},"description":"代理/Proxy"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/open_douyin_app_to_video_detail":{"get":{"tags":["Douyin-App-V3-API"],"summary":"生成抖音分享链接，唤起抖音APP，跳转指定作品详情页/Generate Douyin share link, call Douyin APP, and jump to the specified video details page","description":"# [中文]\n### 用途:\n- 生成抖音分享链接，唤起抖音APP，跳转指定作品详情页。\n\n### 参数:\n- aweme_id: 作品id\n\n### 返回:\n- 分享链接\n\n# [English]\n### Purpose:\n- Generate Douyin share link, call Douyin APP, and jump to the specified video\n\n### Parameters:\n- aweme_id: Video id\n\n### Return:\n- Share link\n\n# [示例/Example]\naweme_id = \"7197598285882789120\"","operationId":"open_douyin_app_to_video_detail_api_v1_douyin_app_v3_open_douyin_app_to_video_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aweme Id"},"description":"作品id/Video id","example":"7348044435755846962"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/open_douyin_app_to_user_profile":{"get":{"tags":["Douyin-App-V3-API"],"summary":"生成抖音分享链接，唤起抖音APP，跳转指定用户主页/Generate Douyin share link, call Douyin APP, and jump to the specified user profile","description":"# [中文]\n### 用途:\n- 生成抖音分享链接，唤起抖音APP，跳转指定用户主页。\n\n### 参数:\n- uid: 用户id\n- sec_uid: 用户sec_uid\n- 注意: 请确保user_id和sec_uid都有值，否则无法跳转到指定用户主页。\n\n### 返回:\n- 分享链接\n\n# [English]\n### Purpose:\n- Generate Douyin share link, call Douyin APP, and jump to the specified user profile\n\n### Parameters:\n- uid: User id\n- sec_uid: User sec_uid\n- Note: Please make sure that both user_id and sec_uid have values, otherwise you cannot jump to the specified user profile.\n\n### Return:\n- Share link\n\n# [示例/Example]\nuid = \"96874812426\"\nsec_uid = \"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70\"","operationId":"open_douyin_app_to_user_profile_api_v1_douyin_app_v3_open_douyin_app_to_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"Uid"},"description":"用户id/User id","example":"96874812426"},{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_uid/User sec_uid","title":"Sec Uid"},"description":"用户sec_uid/User sec_uid","example":"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/open_douyin_app_to_keyword_search":{"get":{"tags":["Douyin-App-V3-API"],"summary":"生成抖音分享链接，唤起抖音APP，跳转指定关键词搜索结果/Generate Douyin share link, call Douyin APP, and jump to the specified keyword search result","description":"# [中文]\n### 用途:\n- 生成抖音分享链接，唤起抖音APP，跳转指定关键词搜索结果。\n\n### 参数:\n- keyword: 关键词\n\n### 返回:\n- 分享链接\n\n# [English]\n### Purpose:\n- Generate Douyin share link, call Douyin APP, and jump to the specified keyword search result\n\n### Parameters:\n- keyword: Keyword\n\n### Return:\n- Share link\n\n# [示例/Example]\nkeyword = \"雷军\"","operationId":"open_douyin_app_to_keyword_search_api_v1_douyin_app_v3_open_douyin_app_to_keyword_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"雷军"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/app/v3/open_douyin_app_to_send_private_message":{"get":{"tags":["Douyin-App-V3-API"],"summary":"生成抖音分享链接，唤起抖音APP，给指定用户发送私信/Generate Douyin share link, call Douyin APP, and send private messages to specified users","description":"# [中文]\n### 用途:\n- 生成抖音分享链接，唤起抖音APP，给指定用户发送私信。\n\n### 参数:\n- uid: 用户id\n- sec_uid: 用户sec_uid\n- 注意: 请确保user_id和sec_uid都有值，否则无法发送私信给指定用户。\n\n### 返回:\n- 分享链接\n\n# [English]\n### Purpose:\n- Generate Douyin share link, call Douyin APP, and send private messages to specified users\n\n### Parameters:\n- uid: User id\n- sec_uid: User sec_uid\n- Note: Please make sure that both user_id and sec_uid have values, otherwise you cannot send private messages to the specified user.\n\n### Return:\n- Share link\n\n# [示例/Example]\nuid = \"96874812426\"\nsec_uid = \"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70\"","operationId":"open_douyin_app_to_send_private_message_api_v1_douyin_app_v3_open_douyin_app_to_send_private_message_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"Uid"},"description":"用户id/User id","example":"96874812426"},{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_uid/User sec_uid","title":"Sec Uid"},"description":"用户sec_uid/User sec_uid","example":"MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_creator_activity_list":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者活动列表/Get creator activity list","description":"# [中文]\n### 用途:\n- 获取抖音创作者活动列表数据\n### 参数:\n- start_time: 开始时间戳\n- end_time: 结束时间戳\n### 返回:\n- 创作者活动列表数据\n\n# [English]\n### Purpose:\n- Get Douyin creator activity list data\n### Parameters:\n- start_time: Start timestamp\n- end_time: End timestamp\n### Return:\n- Creator activity list data\n\n# [示例/Example]\nstart_time = 1756656000\nend_time = 1759247999","operationId":"fetch_creator_activity_list_api_v1_douyin_creator_fetch_creator_activity_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"start_time","in":"query","required":true,"schema":{"type":"integer","description":"开始时间戳/Start timestamp","title":"Start Time"},"description":"开始时间戳/Start timestamp","example":1756656000},{"name":"end_time","in":"query","required":true,"schema":{"type":"integer","description":"结束时间戳/End timestamp","title":"End Time"},"description":"结束时间戳/End timestamp","example":1759247999}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_creator_activity_detail":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者活动详情/Get creator activity detail","description":"# [中文]\n### 用途:\n- 获取抖音创作者活动详情数据\n### 参数:\n- activity_id: 活动ID（从活动列表接口获取）\n### 返回:\n- 创作者活动详情数据\n\n# [English]\n### Purpose:\n- Get Douyin creator activity detail data\n### Parameters:\n- activity_id: Activity ID (obtained from activity list interface)\n### Return:\n- Creator activity detail data\n\n# [示例/Example]\nactivity_id = \"7545335931785450534\"","operationId":"fetch_creator_activity_detail_api_v1_douyin_creator_fetch_creator_activity_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"activity_id","in":"query","required":true,"schema":{"type":"string","description":"活动ID/Activity ID","title":"Activity Id"},"description":"活动ID/Activity ID","example":"7545335931785450534"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_creator_material_center_config":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者中心配置/Get creator material center config","description":"# [中文]\n### 用途:\n- 获取抖音创作者中心配置信息\n### 返回:\n- 创作者中心配置数据\n\n# [English]\n### Purpose:\n- Get Douyin creator material center configuration\n### Return:\n- Creator material center config data","operationId":"fetch_creator_material_center_config_api_v1_douyin_creator_fetch_creator_material_center_config_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator/fetch_creator_material_center_billboard":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者中心热门视频榜单/Get creator material center billboard","description":"# [中文]\n### 用途:\n- 获取抖音创作者中心热门视频榜单数据\n### 参数:\n- billboard_tag: 榜单标签，0=全部，其他值请通过config接口获取\n    - 0: 全部\n    - 333: 美食\n    - 334: 旅行\n    - 299: 泛生活\n    - 335: 汽车\n    - 336: 科技\n    - 302: 游戏\n    - 296: 二次元\n    - 337: 娱乐\n    - 311: 明星\n    - 298: 体育\n    - 300: 文化教育\n    - 301: 校园\n    - 297: 政务\n    - 305: 时尚\n    - 306: 才艺\n    - 669: 财经\n    - 314: 随拍\n    - 307: 动植物\n    - 309: 图文控\n    - 308: 剧情\n    - 315: 亲子\n    - 718: 三农\n    - 310: 创意\n    - 312: 户外\n    - 926: 公益\n- order_key: 排序键\n    - 1: 播放最高\n    - 2: 点赞最多\n    - 3: 评论最多\n    - 4: 热度最高\n- time_filter: 时间筛选\n    - 1: 24小时\n    - 2: 7天\n    - 3: 30天\n### 返回:\n- 创作者中心热门视频榜单数据\n\n# [English]\n### Purpose:\n- Get Douyin creator material center billboard data\n### Parameters:\n- billboard_tag: Billboard tag, 0=all, other values can be obtained through config interface\n    - 0: All\n    - 333: Food\n    - 334: Travel\n    - 299: Lifestyle\n    - 335: Automotive\n    - 336: Technology\n    - 302: Gaming\n    - 296: Anime\n    - 337: Entertainment\n    - 311: Celebrity\n    - 298: Sports\n    - 300: Culture & Education\n    - 301: Campus\n    - 297: Government\n    - 305: Fashion\n    - 306: Talent Show\n    - 669: Finance\n    - 314: Random\n    - 307: Animals & Plants\n    - 309: Graphics & Text\n    - 308: Drama\n    - 315: Parenting\n    - 718: Agriculture\n    - 310: Creative\n    - 312: Outdoor\n    - 926: Public Welfare\n- order_key: Order key\n    - 1: Highest views\n    - 2: Most likes\n    - 3: Most comments\n    - 4: Highest popularity\n- time_filter: Time filter\n    - 1: 24 hours\n    - 2: 7 days\n    - 3: 30 days\n### Return:\n- Creator material center billboard data\n\n# [示例/Example]\nbillboard_tag = 0\norder_key = 1  # 播放最高/Highest views\ntime_filter = 1  # 24小时/24 hours","operationId":"fetch_creator_material_center_billboard_api_v1_douyin_creator_fetch_creator_material_center_billboard_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"billboard_tag","in":"query","required":false,"schema":{"type":"integer","description":"榜单标签，0=全部，其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface","default":0,"title":"Billboard Tag"},"description":"榜单标签，0=全部，其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface"},{"name":"order_key","in":"query","required":false,"schema":{"type":"integer","description":"排序键: 1=播放最高, 2=点赞最多, 3=评论最多, 4=热度最高/Order key: 1=highest views, 2=most likes, 3=most comments, 4=highest popularity","default":1,"title":"Order Key"},"description":"排序键: 1=播放最高, 2=点赞最多, 3=评论最多, 4=热度最高/Order key: 1=highest views, 2=most likes, 3=most comments, 4=highest popularity"},{"name":"time_filter","in":"query","required":false,"schema":{"type":"integer","description":"时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days","default":1,"title":"Time Filter"},"description":"时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_creator_hot_spot_billboard":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者中心创作热点/Get creator hot spot billboard","description":"# [中文]\n### 用途:\n- 获取抖音创作者热点榜单数据\n### 参数:\n- billboard_tag: 热点标签，多个标签用逗号分隔\n    可选值:\n    - 站内玩法: 1004,1000,1002,1003,1001\n    - 话题互动: 20001,20006,20000,20003,20005,20002,20\n    - 娱乐: 2007,2000,2011,2012,2009,2010,2004,2005,2003,2008,2001,2002,2006\n    - 社会: 4005,4006,4007,4003,4004,4000\n    - 二次元: 13000\n    - 交通: 23000\n    - 亲子: 19000\n    - 体育: 5002,5000,5001\n    - 军事: 21000\n    - 剧情: 18000\n    - 动物萌宠: 8000\n    - 天气: 22001,22002\n    - 才艺: 17000\n    - 文化教育: 14000\n    - 旅行: 10000\n    - 时尚: 16000\n    - 时政: 3000,3001,3002\n    - 校园: 15000\n    - 汽车: 11000\n    - 游戏: 12000,12001\n    - 科技: 6000\n    - 美食: 9000\n    - 财经: 7000\n- hot_search_type: 热搜类型\n    - 1: 热点总榜\n    - 2: 同城热点榜\n    - 3: 热点上升榜\n- city_code: 城市代码，当hot_search_type=2时必需\n### 返回:\n- 创作者热点榜单数据\n\n# [English]\n### Purpose:\n- Get Douyin creator hot spot billboard data\n### Parameters:\n- billboard_tag: Hot spot tag - multiple tags separated by comma\n    Available values:\n    - Platform Features: 1004,1000,1002,1003,1001\n    - Topic Interaction: 20001,20006,20000,20003,20005,20002,20\n    - Entertainment: 2007,2000,2011,2012,2009,2010,2004,2005,2003,2008,2001,2002,2006\n    - Society: 4005,4006,4007,4003,4004,4000\n    - Anime: 13000\n    - Transportation: 23000\n    - Parenting: 19000\n    - Sports: 5002,5000,5001\n    - Military: 21000\n    - Drama: 18000\n    - Animals & Pets: 8000\n    - Weather: 22001,22002\n    - Talent Show: 17000\n    - Culture & Education: 14000\n    - Travel: 10000\n    - Fashion: 16000\n    - Politics: 3000,3001,3002\n    - Campus: 15000\n    - Automotive: 11000\n    - Gaming: 12000,12001\n    - Technology: 6000\n    - Food: 9000\n    - Finance: 7000\n- hot_search_type: Hot search type\n    - 1: Hot Spot Overall Ranking\n    - 2: Local Hot Spot Ranking\n    - 3: Rising Hot Spot Ranking\n- city_code: City code - required when hot_search_type=2\n### Return:\n- Creator hot spot billboard data\n\n# [示例/Example]\nbillboard_tag = \"0\"  # 全部/All\nhot_search_type = 1  # 热点总榜/Overall ranking\ncity_code = None  # 可选/Optional","operationId":"fetch_creator_hot_spot_billboard_api_v1_douyin_creator_fetch_creator_hot_spot_billboard_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"billboard_tag","in":"query","required":false,"schema":{"type":"string","description":"热点标签，多个标签用逗号分隔，如'1004,1000,1002'/Hot spot tag - multiple tags separated by comma, like '1004,1000,1002'","default":"0","title":"Billboard Tag"},"description":"热点标签，多个标签用逗号分隔，如'1004,1000,1002'/Hot spot tag - multiple tags separated by comma, like '1004,1000,1002'"},{"name":"hot_search_type","in":"query","required":false,"schema":{"type":"integer","description":"热搜类型: 1=热点总榜, 2=同城热点榜, 3=热点上升榜/Hot search type: 1=Overall ranking, 2=Local ranking, 3=Rising ranking","default":1,"title":"Hot Search Type"},"description":"热搜类型: 1=热点总榜, 2=同城热点榜, 3=热点上升榜/Hot search type: 1=Overall ranking, 2=Local ranking, 3=Rising ranking"},{"name":"city_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"城市代码，当hot_search_type=2时必需/City code - required when hot_search_type=2","title":"City Code"},"description":"城市代码，当hot_search_type=2时必需/City code - required when hot_search_type=2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_creator_hot_topic_billboard":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者热门话题榜单/Get creator hot topic billboard","description":"# [中文]\n### 用途:\n- 获取抖音创作者热门话题榜单数据\n### 参数:\n- billboard_tag: 榜单标签，0=全部，其他值请通过config接口获取\n    - 0: 全部\n    - 333: 美食\n    - 334: 旅行\n    - 299: 泛生活\n    - 335: 汽车\n    - 336: 科技\n    - 302: 游戏\n    - 296: 二次元\n    - 337: 娱乐\n    - 311: 明星\n    - 298: 体育\n    - 300: 文化教育\n    - 301: 校园\n    - 297: 政务\n    - 305: 时尚\n    - 306: 才艺\n    - 669: 财经\n    - 314: 随拍\n    - 307: 动植物\n    - 309: 图文控\n    - 308: 剧情\n    - 315: 亲子\n    - 718: 三农\n    - 310: 创意\n    - 312: 户外\n    - 926: 公益\n- order_key: 排序键\n    - 1: 播放最高\n    - 2: 点赞最多\n    - 3: 评论最多\n    - 4: 投稿最多\n- time_filter: 时间筛选\n    - 1: 24小时\n    - 2: 7天\n    - 3: 30天\n### 返回:\n- 创作者热门话题榜单数据\n\n# [English]\n### Purpose:\n- Get Douyin creator hot topic billboard data\n### Parameters:\n- billboard_tag: Billboard tag, 0=all, other values can be obtained through config interface\n    - 0: All\n    - 333: Food\n    - 334: Travel\n    - 299: Lifestyle\n    - 335: Automotive\n    - 336: Technology\n    - 302: Gaming\n    - 296: Anime\n    - 337: Entertainment\n    - 311: Celebrity\n    - 298: Sports\n    - 300: Culture & Education\n    - 301: Campus\n    - 297: Government\n    - 305: Fashion\n    - 306: Talent Show\n    - 669: Finance\n    - 314: Random\n    - 307: Animals & Plants\n    - 309: Graphics & Text\n    - 308: Drama\n    - 315: Parenting\n    - 718: Agriculture\n    - 310: Creative\n    - 312: Outdoor\n    - 926: Public Welfare\n- order_key: Order key\n    - 1: Highest views\n    - 2: Most likes\n    - 3: Most comments\n    - 4: Most submissions\n- time_filter: Time filter\n    - 1: 24 hours\n    - 2: 7 days\n    - 3: 30 days\n### Return:\n- Creator hot topic billboard data\n\n# [示例/Example]\nbillboard_tag = 0\norder_key = 1  # 播放最高/Highest views\ntime_filter = 1  # 24小时/24 hours","operationId":"fetch_creator_hot_topic_billboard_api_v1_douyin_creator_fetch_creator_hot_topic_billboard_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"billboard_tag","in":"query","required":false,"schema":{"type":"integer","description":"榜单标签，0=全部，其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface","default":0,"title":"Billboard Tag"},"description":"榜单标签，0=全部，其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface"},{"name":"order_key","in":"query","required":false,"schema":{"type":"integer","description":"排序键: 1=播放最高, 2=点赞最多, 3=评论最多, 4=投稿最多/Order key: 1=highest views, 2=most likes, 3=most comments, 4=most submissions","default":1,"title":"Order Key"},"description":"排序键: 1=播放最高, 2=点赞最多, 3=评论最多, 4=投稿最多/Order key: 1=highest views, 2=most likes, 3=most comments, 4=most submissions"},{"name":"time_filter","in":"query","required":false,"schema":{"type":"integer","description":"时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days","default":1,"title":"Time Filter"},"description":"时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_creator_hot_props_billboard":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者热门道具榜单/Get creator hot props billboard","description":"# [中文]\n### 用途:\n- 获取抖音创作者热门道具榜单数据\n### 参数:\n- billboard_tag: 榜单标签，0=全部，其他值请通过config接口获取\n    - 0: 全部\n    - 333: 美食\n    - 334: 旅行\n    - 299: 泛生活\n    - 335: 汽车\n    - 336: 科技\n    - 302: 游戏\n    - 296: 二次元\n    - 337: 娱乐\n    - 311: 明星\n    - 298: 体育\n    - 300: 文化教育\n    - 301: 校园\n    - 297: 政务\n    - 305: 时尚\n    - 306: 才艺\n    - 669: 财经\n    - 314: 随拍\n    - 307: 动植物\n    - 309: 图文控\n    - 308: 剧情\n    - 315: 亲子\n    - 718: 三农\n    - 310: 创意\n    - 312: 户外\n    - 926: 公益\n- order_key: 排序键\n    - 1: 播放最高\n    - 5: 投稿最多\n    - 6: 展现最高\n    - 7: 收藏最高\n- time_filter: 时间筛选\n    - 1: 24小时\n    - 2: 7天\n    - 3: 30天\n### 返回:\n- 创作者热门道具榜单数据\n\n# [English]\n### Purpose:\n- Get Douyin creator hot props billboard data\n### Parameters:\n- billboard_tag: Billboard tag, 0=all, other values can be obtained through config interface\n    - 0: All\n    - 333: Food\n    - 334: Travel\n    - 299: Lifestyle\n    - 335: Automotive\n    - 336: Technology\n    - 302: Gaming\n    - 296: Anime\n    - 337: Entertainment\n    - 311: Celebrity\n    - 298: Sports\n    - 300: Culture & Education\n    - 301: Campus\n    - 297: Government\n    - 305: Fashion\n    - 306: Talent Show\n    - 669: Finance\n    - 314: Random\n    - 307: Animals & Plants\n    - 309: Graphics & Text\n    - 308: Drama\n    - 315: Parenting\n    - 718: Agriculture\n    - 310: Creative\n    - 312: Outdoor\n    - 926: Public Welfare\n- order_key: Order key\n    - 1: Highest views\n    - 5: Most submissions\n    - 6: Highest exposure\n    - 7: Most favorites\n- time_filter: Time filter\n    - 1: 24 hours\n    - 2: 7 days\n    - 3: 30 days\n### Return:\n- Creator hot props billboard data\n\n# [示例/Example]\nbillboard_tag = 0\norder_key = 1  # 播放最高/Highest views\ntime_filter = 1  # 24小时/24 hours","operationId":"fetch_creator_hot_props_billboard_api_v1_douyin_creator_fetch_creator_hot_props_billboard_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"billboard_tag","in":"query","required":false,"schema":{"type":"integer","description":"榜单标签，0=全部，其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface","default":0,"title":"Billboard Tag"},"description":"榜单标签，0=全部，其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface"},{"name":"order_key","in":"query","required":false,"schema":{"type":"integer","description":"排序键: 1=播放最高, 5=投稿最多, 6=展现最高, 7=收藏最高/Order key: 1=highest views, 5=most submissions, 6=highest exposure, 7=most favorites","default":1,"title":"Order Key"},"description":"排序键: 1=播放最高, 5=投稿最多, 6=展现最高, 7=收藏最高/Order key: 1=highest views, 5=most submissions, 6=highest exposure, 7=most favorites"},{"name":"time_filter","in":"query","required":false,"schema":{"type":"integer","description":"时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days","default":1,"title":"Time Filter"},"description":"时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_creator_hot_challenge_billboard":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者热门挑战榜单/Get creator hot challenge billboard","description":"# [中文]\n### 用途:\n- 获取抖音创作者平台热门挑战榜单数据\n### 返回:\n- 热门挑战榜单数据\n\n# [English]\n### Purpose:\n- Get Douyin creator platform hot challenge billboard data\n### Return:\n- Hot challenge billboard data\n\n# [示例/Example]\n无需参数，直接调用即可获取当前热门挑战榜单\nNo parameters required, call directly to get current hot challenge billboard","operationId":"fetch_creator_hot_challenge_billboard_api_v1_douyin_creator_fetch_creator_hot_challenge_billboard_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator/fetch_creator_hot_music_billboard":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者热门音乐榜单/Get creator hot music billboard","description":"# [中文]\n### 用途:\n- 获取抖音创作者平台热门音乐榜单数据\n### 参数:\n- billboard_tag: 榜单标签，0=全部，其他值请通过配置接口获取\n- order_key: 排序键 (1=播放最高, 2=点赞最多, 4=热度最高, 5=投稿最多)\n- time_filter: 时间筛选 (1=24小时, 2=7天, 3=30天)\n### 返回:\n- 热门音乐榜单数据\n\n# [English]\n### Purpose:\n- Get Douyin creator platform hot music billboard data\n### Parameters:\n- billboard_tag: Billboard tag, 0=all, other values can be obtained through config interface\n- order_key: Order key (1=highest views, 2=most likes, 4=highest popularity, 5=most submissions)\n- time_filter: Time filter (1=24 hours, 2=7 days, 3=30 days)\n### Return:\n- Hot music billboard data\n\n# [示例/Example]\nbillboard_tag = 0   # 全部/All\norder_key = 1   # 播放最高/Highest views\ntime_filter = 1 # 24小时/24 hours","operationId":"fetch_creator_hot_music_billboard_api_v1_douyin_creator_fetch_creator_hot_music_billboard_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"billboard_tag","in":"query","required":false,"schema":{"type":"integer","description":"榜单标签/Billboard tag (0=全部，具体分类值可通过配置接口获取)","default":0,"title":"Billboard Tag"},"description":"榜单标签/Billboard tag (0=全部，具体分类值可通过配置接口获取)","example":0},{"name":"order_key","in":"query","required":false,"schema":{"type":"integer","description":"排序键/Order key (1=播放最高, 2=点赞最多, 4=热度最高, 5=投稿最多)","default":1,"title":"Order Key"},"description":"排序键/Order key (1=播放最高, 2=点赞最多, 4=热度最高, 5=投稿最多)","example":1},{"name":"time_filter","in":"query","required":false,"schema":{"type":"integer","description":"时间筛选/Time filter (1=24小时, 2=7天, 3=30天)","default":1,"title":"Time Filter"},"description":"时间筛选/Time filter (1=24小时, 2=7天, 3=30天)","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_creator_hot_course":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者热门课程/Get creator hot course","description":"# [中文]\n### 用途:\n- 获取抖音创作者平台热门课程数据或精选专题课程\n### 参数:\n- order: 排序方式 (1=推荐排序, 2=最受欢迎, 3=最新上传)\n- limit: 每页数量 (建议24，范围1-100)\n- offset: 偏移量 (起始位置)\n- category_id: 精选专题分类ID (不传则获取热门课程，传入则获取指定分类的精选专题)\n    可选值:\n    - 6976547830546582816: 知识品类\n    - 6976547923849006336: 生活品类\n    - 6976547940311633165: 娱乐品类\n    - 6976547972108635404: 美食品类\n    - 6980288134957272352: 正能量\n    - 6980288181744766219: 游戏品类\n    - 6980288219548011776: 通用\n### 返回:\n- 热门课程数据或精选专题课程数据\n\n# [English]\n### Purpose:\n- Get Douyin creator platform hot course data or selected topic courses\n### Parameters:\n- order: Order type (1=recommended order, 2=most popular, 3=latest upload)\n- limit: Items per page (recommended 24, range 1-100)\n- offset: Offset (starting position)\n- category_id: Selected topic category ID (empty for hot courses, specific ID for selected topics)\n    Available values:\n    - 6976547830546582816: Knowledge Category\n    - 6976547923849006336: Life Category\n    - 6976547940311633165: Entertainment Category\n    - 6976547972108635404: Food Category\n    - 6980288134957272352: Positive Energy\n    - 6980288181744766219: Gaming Category\n    - 6980288219548011776: General\n### Return:\n- Hot course data or selected topic course data\n\n# [示例/Example]\n```\n# 获取热门课程/Get hot courses\nGET /fetch_creator_hot_course?order=1&limit=24&offset=0\n\n# 获取知识品类精选专题/Get knowledge category selected topics\nGET /fetch_creator_hot_course?order=1&limit=24&offset=0&category_id=6976547830546582816\n\n# 获取美食品类精选专题/Get food category selected topics\nGET /fetch_creator_hot_course?order=1&limit=24&offset=0&category_id=6976547972108635404\n```","operationId":"fetch_creator_hot_course_api_v1_douyin_creator_fetch_creator_hot_course_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"order","in":"query","required":false,"schema":{"type":"integer","description":"排序方式/Order type (1=推荐排序, 2=最受欢迎, 3=最新上传)","default":1,"title":"Order"},"description":"排序方式/Order type (1=推荐排序, 2=最受欢迎, 3=最新上传)","example":1},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"每页数量/Items per page (建议24)","default":24,"title":"Limit"},"description":"每页数量/Items per page (建议24)","example":24},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset","example":0},{"name":"category_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"精选专题分类ID/Selected topic category ID - 不传则为热门课程，传入则为精选专题\n        可选值/Available values:\n        6976547830546582816=知识品类, 6976547923849006336=生活品类, 6976547940311633165=娱乐品类,\n        6976547972108635404=美食品类, 6980288134957272352=正能量, 6980288181744766219=游戏品类,\n        6980288219548011776=通用","title":"Category Id"},"description":"精选专题分类ID/Selected topic category ID - 不传则为热门课程，传入则为精选专题\n        可选值/Available values:\n        6976547830546582816=知识品类, 6976547923849006336=生活品类, 6976547940311633165=娱乐品类,\n        6976547972108635404=美食品类, 6980288134957272352=正能量, 6980288181744766219=游戏品类,\n        6980288219548011776=通用"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_creator_content_category":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者内容创作合集分类/Get creator content creation category","description":"# [中文]\n### 用途:\n- 获取抖音创作者平台内容创作的合集分类列表\n### 参数:\n- 无需额外参数\n### 返回:\n- 内容创作合集分类数据\n\n# [English]\n### Purpose:\n- Get Douyin creator platform content creation category list\n### Parameters:\n- No additional parameters required\n### Return:\n- Content creation category data","operationId":"fetch_creator_content_category_api_v1_douyin_creator_fetch_creator_content_category_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator/fetch_creator_content_course":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取创作者内容创作课程/Get creator content creation course","description":"# [中文]\n### 用途:\n- 获取抖音创作者平台指定分类的内容创作课程\n### 参数:\n- category_id: 分类ID (更多分类ID请通过内容创作合集分类接口获取)\n    常见分类ID示例:\n    - 184: 视频创作\n    - 185: 直播创作\n    - 186: 图文创作\n    - 188: 美食视频创作\n    - 180: 内容创作基础\n- order: 排序方式 (1=推荐排序, 2=最受欢迎, 3=最新上传)\n- limit: 每页数量 (建议24，范围1-100)\n- offset: 偏移量 (起始位置)\n### 返回:\n- 指定分类的内容创作课程数据\n\n# [English]\n### Purpose:\n- Get Douyin creator platform content creation courses for specified category\n### Parameters:\n- category_id: Category ID (for more category IDs, please refer to the content creation category interface)\n    Common category ID examples:\n    - 184: Video Creation\n    - 185: Live Streaming Creation\n    - 186: Image & Text Creation\n    - 188: Food Video Creation\n    - 180: Content Creation Basics\n- order: Order type (1=recommended order, 2=most popular, 3=latest upload)\n- limit: Items per page (recommended 24, range 1-100)\n- offset: Offset (starting position)\n### Return:\n- Content creation course data for specified category","operationId":"fetch_creator_content_course_api_v1_douyin_creator_fetch_creator_content_course_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category_id","in":"query","required":true,"schema":{"type":"integer","description":"分类ID/Category ID","title":"Category Id"},"description":"分类ID/Category ID","example":180},{"name":"order","in":"query","required":false,"schema":{"type":"integer","description":"排序方式/Order type (1=推荐排序, 2=最受欢迎, 3=最新上传)","default":1,"title":"Order"},"description":"排序方式/Order type (1=推荐排序, 2=最受欢迎, 3=最新上传)","example":1},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"每页数量/Items per page","default":24,"title":"Limit"},"description":"每页数量/Items per page","example":24},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"偏移量/Offset (starting position)","default":0,"title":"Offset"},"description":"偏移量/Offset (starting position)","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_video_danmaku_list":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取作品弹幕列表/Get video danmaku list","description":"# [中文]\n### 用途:\n- 获取指定作品的弹幕列表，支持管理和筛选弹幕\n### 参数:\n- item_id: 作品ID (必需参数，从作品链接或API获取)\n- count: 每页弹幕数量 (建议20，范围1-100)\n- offset: 偏移量 (分页使用，起始位置)\n- order_type: 排序类型 (1=时间排序, 2=其他排序)\n- is_blocked: 是否获取被屏蔽的弹幕 (false=正常弹幕, true=被屏蔽弹幕)\n### 返回:\n- 作品弹幕列表数据\n\n# [English]\n### Purpose:\n- Get danmaku list for specified video, supports management and filtering\n### Parameters:\n- item_id: Video item ID (required, get from video link or API)\n- count: Items per page (recommended 20, range 1-100)\n- offset: Offset (for pagination, starting position)\n- order_type: Order type (1=time order, 2=other order)\n- is_blocked: Whether to get blocked danmaku (false=normal, true=blocked)\n### Return:\n- Video danmaku list data","operationId":"fetch_video_danmaku_list_api_v1_douyin_creator_fetch_video_danmaku_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品ID/Video item ID","title":"Item Id"},"description":"作品ID/Video item ID","example":"7545659154417896746"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"每页数量/Items per page","default":20,"title":"Count"},"description":"每页数量/Items per page","example":20},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"偏移量/Offset (starting position)","default":0,"title":"Offset"},"description":"偏移量/Offset (starting position)","example":0},{"name":"order_type","in":"query","required":false,"schema":{"type":"integer","description":"排序类型/Order type (1=时间排序, 2=其他排序)","default":1,"title":"Order Type"},"description":"排序类型/Order type (1=时间排序, 2=其他排序)","example":1},{"name":"is_blocked","in":"query","required":false,"schema":{"type":"boolean","description":"是否被屏蔽/Is blocked","default":false,"title":"Is Blocked"},"description":"是否被屏蔽/Is blocked","example":false}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_user_search":{"get":{"tags":["Douyin-Creator-API"],"summary":"搜索用户/Search users","description":"# [中文]\n### 用途:\n- 搜索抖音用户，支持抖音号和抖音昵称搜索\n### 参数:\n- user_name: 用户名 (支持抖音号和抖音昵称)\n    - 抖音号: 如 \"rmrbxmt\"\n    - 抖音昵称: 如 \"Y\"、\"人民日报\"\n### 返回:\n- 最多返回20个匹配的用户信息\n- 包含用户基本信息如头像、昵称、抖音号等\n\n# [English]\n### Purpose:\n- Search Douyin users by Douyin ID or nickname\n### Parameters:\n- user_name: Username (supports Douyin ID and nickname)\n    - Douyin ID: e.g., \"rmrbxmt\"\n    - Nickname: e.g., \"Y\", \"人民日报\"\n### Return:\n- Returns up to 20 matching user information\n- Contains basic user info like avatar, nickname, Douyin ID, etc.","operationId":"fetch_user_search_api_v1_douyin_creator_fetch_user_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_name","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username (支持抖音号和抖音昵称)","title":"User Name"},"description":"用户名/Username (支持抖音号和抖音昵称)","example":"Y"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_mission_task_list":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取商单任务列表/Get mission task list","description":"# [中文]\n### 用途:\n- 获取抖音创作者平台的商单任务列表\n- 支持多种筛选条件，包括行业分类、付费类型、平台渠道等\n\n### 重要参数使用说明:\n#### 行业分类组合规则:\n- **industry_lv1=-1 (全部)**: 当选择全部一级行业时，industry_lv2参数将被忽略，无需设置\n- **industry_lv1=具体值**: 当选择具体一级行业时，可配合industry_lv2进行二级筛选\n    - industry_lv2=-1: 该一级行业下的所有二级分类\n    - industry_lv2=具体值: 该一级行业下的具体二级分类\n\n#### 可选参数 (选择\"全部\"时无需传入):\n- **platform_channel**: 不传入表示全部平台渠道\n- **pay_type**: 不传入表示全部付费类型\n- **greater_than_cost_progress**: 不传入表示不限制成本进度\n- **publish_time_start**: 不传入表示不限制发布时间\n- **quick_selector_scene**: 不传入表示不使用快速筛选\n- **keyword**: 不传入表示不进行关键词搜索\n\n### 参数详解:\n- cursor: 游标，用于分页，0表示第一页\n- limit: 每页返回的任务数量，建议24\n- mission_type: 任务类型，通常为1\n- tab_scene: 场景类型\n    - 1: 可投稿 (可以直接投稿的任务)\n    - 2: 可报名 (需要报名审核的任务)\n    - 3: 好物测评 (商品测评类任务)\n- industry_lv1/lv2: 行业分类 (建议先调用fetch_industry_category_config获取完整分类)\n    - -1: 全部行业\n    - 具体数值: 对应具体行业类别 (如1913=游戏, 1903=食品饮料)\n- platform_channel: 平台渠道 (可选)\n    - 1: 抖音视频\n    - 2: 抖音直播\n    - 3: 抖音图文\n- pay_type: 付费类型 (可选)\n    - 1: 视频等级 (按粉丝量等级定价)\n    - 2: 自定义 (商家自定义价格)\n    - 3: 按转化付费 (按转化效果付费)\n    - 4: 按有效播放量 (按播放量付费)\n    - 5: 按销售量 (按商品销售量付费)\n    - 9: 按核销量 (按核销数量付费)\n    - 14: 按付费分佣 (按分佣比例付费)\n- greater_than_cost_progress: 成本进度筛选 (可选)\n    - 20: 高于20%成本进度的任务\n    - 50: 高于50%成本进度的任务\n    - 80: 高于80%成本进度的任务\n- publish_time_start: 发布开始时间过滤 (可选，时间戳格式)\n- quick_selector_scene: 快速筛选场景 (可选)\n    - 1: 高收益任务\n    - 4: 保底收入任务\n    - 5: 曾经合作过的商家\n- keyword: 关键词搜索 (可选，支持任务名称或任务ID)\n\n### 使用示例:\n```\n# 获取全部行业的可投稿任务\nGET /fetch_mission_task_list?industry_lv1=-1&tab_scene=1\n\n# 获取游戏行业休闲游戏分类的按播放量付费任务\nGET /fetch_mission_task_list?industry_lv1=1913&industry_lv2=191301&pay_type=4\n\n# 获取高收益的抖音视频任务\nGET /fetch_mission_task_list?platform_channel=1&quick_selector_scene=1\n```\n\n### 返回:\n- 返回符合条件的商单任务列表\n- 包含任务详情、报酬信息、要求等\n\n# [English]\n### Purpose:\n- Get mission task list from Douyin Creator platform\n- Supports multiple filtering conditions including industry classification, payment type, platform channel, etc.\n\n### Important Parameter Usage Guidelines:\n#### Industry Classification Combination Rules:\n- **industry_lv1=-1 (All)**: When selecting all primary industries, industry_lv2 parameter will be ignored, no need to set\n- **industry_lv1=specific value**: When selecting specific primary industry, can be combined with industry_lv2 for secondary filtering\n    - industry_lv2=-1: All secondary categories under the primary industry\n    - industry_lv2=specific value: Specific secondary category under the primary industry\n\n#### Optional Parameters (No need to pass when selecting \"All\"):\n- **platform_channel**: Not passing means all platform channels\n- **pay_type**: Not passing means all payment types\n- **greater_than_cost_progress**: Not passing means no cost progress restriction\n- **publish_time_start**: Not passing means no publish time restriction\n- **quick_selector_scene**: Not passing means no quick filtering\n- **keyword**: Not passing means no keyword search\n\n### Parameter Details:\n- cursor: Cursor for pagination, 0 for first page\n- limit: Number of tasks per page, recommended 24\n- mission_type: Mission type, usually 1\n- tab_scene: Scene type\n    - 1: Submittable (tasks that can be submitted directly)\n    - 2: Registrable (tasks that require registration and approval)\n    - 3: Product Review (product evaluation tasks)\n- industry_lv1/lv2: Industry classification (recommend calling fetch_industry_category_config first)\n    - -1: All industries\n    - Specific values: Corresponding to specific industry categories (e.g., 1913=Gaming, 1903=Food&Beverage)\n- platform_channel: Platform channel (optional)\n    - 1: Douyin Video\n    - 2: Douyin Live\n    - 3: Douyin Image&Text\n- pay_type: Payment type (optional)\n    - 1: Video Level (pricing by follower level)\n    - 2: Custom (merchant custom pricing)\n    - 3: Conversion-based (pay by conversion effect)\n    - 4: Valid Views (pay by view count)\n    - 5: Sales Volume (pay by product sales)\n    - 9: Verification Volume (pay by verification count)\n    - 14: Commission-based (pay by commission ratio)\n- greater_than_cost_progress: Cost progress filter (optional)\n    - 20: Tasks with more than 20% cost progress\n    - 50: Tasks with more than 50% cost progress\n    - 80: Tasks with more than 80% cost progress\n- publish_time_start: Publish start time filter (optional, timestamp format)\n- quick_selector_scene: Quick filter scene (optional)\n    - 1: High revenue tasks\n    - 4: Guaranteed income tasks\n    - 5: Previously collaborated merchants\n- keyword: Keyword search (optional, supports task name or task ID)\n\n### Usage Examples:\n```\n# Get submittable tasks from all industries\nGET /fetch_mission_task_list?industry_lv1=-1&tab_scene=1\n\n# Get tasks from gaming industry casual games category with view-based payment\nGET /fetch_mission_task_list?industry_lv1=1913&industry_lv2=191301&pay_type=4\n\n# Get high-revenue Douyin video tasks\nGET /fetch_mission_task_list?platform_channel=1&quick_selector_scene=1\n```\n\n### Return:\n- Returns mission task list matching the conditions\n- Contains task details, compensation info, requirements, etc.","operationId":"fetch_mission_task_list_api_v1_douyin_creator_fetch_mission_task_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"游标/Cursor (分页)","default":0,"title":"Cursor"},"description":"游标/Cursor (分页)","example":0},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"每页数量/Items per page","default":24,"title":"Limit"},"description":"每页数量/Items per page","example":24},{"name":"mission_type","in":"query","required":false,"schema":{"type":"integer","description":"任务类型/Mission type","default":1,"title":"Mission Type"},"description":"任务类型/Mission type","example":1},{"name":"tab_scene","in":"query","required":false,"schema":{"type":"integer","description":"场景类型/Scene type (1=可投稿, 2=可报名, 3=好物测评)","default":1,"title":"Tab Scene"},"description":"场景类型/Scene type (1=可投稿, 2=可报名, 3=好物测评)","example":1},{"name":"industry_lv1","in":"query","required":false,"schema":{"type":"integer","description":"一级行业/Primary industry (-1=全部)","default":-1,"title":"Industry Lv1"},"description":"一级行业/Primary industry (-1=全部)","example":1913},{"name":"industry_lv2","in":"query","required":false,"schema":{"type":"integer","description":"二级行业/Secondary industry (-1=全部)","default":-1,"title":"Industry Lv2"},"description":"二级行业/Secondary industry (-1=全部)","example":191301},{"name":"platform_channel","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"平台渠道/Platform channel (1=抖音视频, 2=抖音直播, 3=抖音图文)","title":"Platform Channel"},"description":"平台渠道/Platform channel (1=抖音视频, 2=抖音直播, 3=抖音图文)","example":1},{"name":"pay_type","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"付费类型/Pay type (1=视频等级, 2=自定义, 3=按转化付费, 4=按有效播放量, 5=按销售量, 9=按核销量, 14=按付费分佣)","title":"Pay Type"},"description":"付费类型/Pay type (1=视频等级, 2=自定义, 3=按转化付费, 4=按有效播放量, 5=按销售量, 9=按核销量, 14=按付费分佣)","example":4},{"name":"greater_than_cost_progress","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"成本进度/Cost progress (20=高于20%, 50=高于50%, 80=高于80%)","title":"Greater Than Cost Progress"},"description":"成本进度/Cost progress (20=高于20%, 50=高于50%, 80=高于80%)","example":20},{"name":"publish_time_start","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"发布开始时间/Publish start time (时间戳)","title":"Publish Time Start"},"description":"发布开始时间/Publish start time (时间戳)","example":1757097636},{"name":"quick_selector_scene","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"快速选择场景/Quick selector (1=高收益, 4=保底收入, 5=合作过)","title":"Quick Selector Scene"},"description":"快速选择场景/Quick selector (1=高收益, 4=保底收入, 5=合作过)"},{"name":"keyword","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"关键词/Keyword (任务名称或ID)","title":"Keyword"},"description":"关键词/Keyword (任务名称或ID)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/creator/fetch_industry_category_config":{"get":{"tags":["Douyin-Creator-API"],"summary":"获取行业分类配置/Get industry category config","description":"# [中文]\n### 用途:\n- 获取抖音创作者平台的行业分类配置\n- 返回所有可用的行业分类层级结构\n- **建议在调用商单任务列表接口前先调用此接口获取完整的行业分类信息**\n\n### 重要说明:\n- 此接口已优化为Redis缓存，首次调用后数据将缓存30天\n- 缓存键: `douyin_creator:industry_categories`\n- 数据结构包含一级行业和二级行业的完整映射关系\n\n### 数据结构:\n```json\n{\n    \"status_code\": 0,\n    \"status_msg\": \"success\",\n    \"data\": {\n        \"industry_categories\": [\n            {\"key\": \"-1\", \"label\": \"全部\"},\n            {\"key\": 1901, \"label\": \"3C及电器\"},\n            {\"key\": 1913, \"label\": \"游戏\"},\n            ...\n        ],\n        \"industry_subcategories\": {\n            1913: [\n                {\"key\": \"-1\", \"label\": \"全部\"},\n                {\"key\": 191301, \"label\": \"休闲游戏\"},\n                {\"key\": 191302, \"label\": \"棋牌桌游\"},\n                ...\n            ],\n            ...\n        }\n    }\n}\n```\n\n### 在商单任务筛选中的使用:\n1. **获取全部行业任务**: `industry_lv1=-1` (此时industry_lv2无需设置)\n2. **获取特定一级行业**: `industry_lv1=1913` (游戏行业)\n3. **获取特定二级行业**: `industry_lv1=1913&industry_lv2=191301` (游戏-休闲游戏)\n\n### 性能优化:\n- 首次调用时从本地JSON文件读取并缓存到Redis\n- 后续调用直接从Redis缓存读取，大幅提升响应速度\n- 缓存有效期30天，确保数据时效性\n\n### 返回:\n- 返回完整的行业分类树结构\n- 包含32个一级行业分类和对应的二级行业分类\n- 每个分类包含分类ID(key)和名称(label)\n\n# [English]\n### Purpose:\n- Get industry category configuration from Douyin Creator platform\n- Returns all available industry classification hierarchy\n- **Recommend calling this API first before using mission task list API to get complete industry classification info**\n\n### Important Notes:\n- This API is optimized with Redis caching, data will be cached for 30 days after first call\n- Cache key: `douyin_creator:industry_categories`\n- Data structure contains complete mapping relationship between primary and secondary industries\n\n### Data Structure:\n```json\n{\n    \"status_code\": 0,\n    \"status_msg\": \"success\",\n    \"data\": {\n        \"industry_categories\": [\n            {\"key\": \"-1\", \"label\": \"All\"},\n            {\"key\": 1901, \"label\": \"3C & Electronics\"},\n            {\"key\": 1913, \"label\": \"Gaming\"},\n            ...\n        ],\n        \"industry_subcategories\": {\n            1913: [\n                {\"key\": \"-1\", \"label\": \"All\"},\n                {\"key\": 191301, \"label\": \"Casual Games\"},\n                {\"key\": 191302, \"label\": \"Board Games\"},\n                ...\n            ],\n            ...\n        }\n    }\n}\n```\n\n### Usage in Mission Task Filtering:\n1. **Get all industry tasks**: `industry_lv1=-1` (industry_lv2 not needed)\n2. **Get specific primary industry**: `industry_lv1=1913` (Gaming industry)\n3. **Get specific secondary industry**: `industry_lv1=1913&industry_lv2=191301` (Gaming-Casual Games)\n\n### Performance Optimization:\n- First call reads from local JSON file and caches to Redis\n- Subsequent calls read directly from Redis cache, significantly improving response speed\n- Cache validity period of 30 days ensures data timeliness\n\n### Return:\n- Returns complete industry classification tree structure\n- Contains 32 primary industry categories and corresponding secondary industry categories\n- Each category contains category ID(key) and name(label)","operationId":"fetch_industry_category_config_api_v1_douyin_creator_fetch_industry_category_config_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_overview_data":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取作品总览数据/Fetch item overview data","description":"# [中文]\n### 用途:\n- 获取抖音作品总览数据，包括流量指标、审核状态、播放信息等\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- ids: 作品ID列表，多个ID用逗号分隔（例如: \"7559536212910853422,7559536212910853423\"）\n- fields: 需要返回的字段，默认为 \"metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis\"\n  - 可选字段（用逗号分隔，可自行组合）:\n    - metrics: 流量指标数据（播放量、点赞量、评论量等）\n    - review: 审核状态信息\n    - play_info: 播放相关信息\n    - dou_plus: 抖+推广信息\n    - integrated_incentive: 综合激励数据\n    - incentive_life: 激励生命周期信息\n    - content_analysis: 内容分析数据\n\n### 返回:\n- 作品总览数据，根据 fields 参数返回对应的字段内容\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get Douyin item overview data, including traffic metrics, review status, play info, etc.\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- ids: Item ID list, separated by comma (e.g., \"7559536212910853422,7559536212910853423\")\n- fields: Fields to return, default is \"metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis\"\n  - Available fields (comma-separated, customizable):\n    - metrics: Traffic metrics data (views, likes, comments, etc.)\n    - review: Review status information\n    - play_info: Play related information\n    - dou_plus: DOU+ promotion information\n    - integrated_incentive: Integrated incentive data\n    - incentive_life: Incentive lifecycle information\n    - content_analysis: Content analysis data\n\n### Return:\n- Item overview data, returns corresponding fields based on the fields parameter\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"ids\": \"7559536212910853422\",\n    \"fields\": \"metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis\"\n}\n```\n\n### 字段组合示例/Field Combination Examples:\n- 只获取流量指标: \"metrics\"\n- 获取流量和审核: \"metrics,review\"\n- 获取所有字段: \"metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis\"","operationId":"fetch_item_overview_data_api_v1_douyin_creator_v2_fetch_item_overview_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMgetRequest","description":"作品总览数据请求参数/Item overview data request parameters"},"example":{"cookie":"Your_Cookie_Here","ids":"7559536212910853422","fields":"metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_play_source":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取作品流量来源统计/Fetch item play source statistics","description":"# [中文]\n### 用途:\n- 获取抖音作品的流量来源统计数据\n- 流量来源统计了作品从不同途径播放的占比\n- **若暂时没有看到某个渠道，说明对应渠道暂时没有播放**\n- **作品刚发布推荐页流量占比可能偏低，请等待系统推流**\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- item_id: 作品ID（必填）\n\n### 返回数据说明:\n- play_source: 流量来源列表，包含各渠道的播放占比\n  - key: 流量来源渠道标识\n  - value: 当前占比（0-1之间的小数，如0.85表示85%）\n  - history_difference: 与历史数据的差异\n  - app_id: 应用ID\n\n### 流量来源渠道说明:\n- **homepage_hot**: 推荐页（系统推荐流量）\n- **familiar**: 朋友页（关注的人、好友推荐）\n- **search**: 搜索（用户主动搜索）\n- **homepage**: 个人主页（访问主页观看）\n- **message**: 消息页（通过消息入口）\n- **other**: 其他（其他途径）\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get Douyin item play source statistics\n- Statistics of the proportion of item views from different sources\n- **If a channel is not shown, it means there are no views from that channel yet**\n- **For newly published items, the recommended page traffic may be low initially, please wait for system distribution**\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- item_id: Item ID (required)\n\n### Return Data Description:\n- play_source: List of traffic sources with play proportion for each channel\n  - key: Traffic source channel identifier\n  - value: Current proportion (decimal between 0-1, e.g., 0.85 means 85%)\n  - history_difference: Difference from historical data\n  - app_id: Application ID\n\n### Traffic Source Channel Description:\n- **homepage_hot**: Recommended page (system recommendation traffic)\n- **familiar**: Friends page (followed people, friend recommendations)\n- **search**: Search (user active search)\n- **homepage**: Personal homepage (views from homepage visits)\n- **message**: Message page (through message entry)\n- **other**: Other (other sources)\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"item_id\": \"7559536212910853422\"\n}\n```\n\n### 返回数据示例/Response Example:\n```json\n{\n    \"play_source\": [\n        {\n            \"app_id\": 1128,\n            \"history_difference\": 0.8543689320388349,\n            \"key\": \"homepage_hot\",\n            \"value\": 0.8543689320388349\n        },\n        {\n            \"app_id\": 1128,\n            \"history_difference\": 0.05825242718446602,\n            \"key\": \"familiar\",\n            \"value\": 0.05825242718446602\n        },\n        {\n            \"app_id\": 1128,\n            \"history_difference\": 0.04854368932038835,\n            \"key\": \"search\",\n            \"value\": 0.04854368932038835\n        }\n    ],\n    \"status_code\": 0,\n    \"status_msg\": \"\"\n}\n```\n\n### 数据解读/Data Interpretation:\n- value 值表示该渠道的流量占比，例如 0.85 表示 85% 的流量来自该渠道\n- homepage_hot 占比高说明作品获得了较好的系统推荐\n- familiar 占比高说明作品在关注用户中传播较好\n- search 占比高说明作品搜索热度高","operationId":"fetch_item_play_source_api_v1_douyin_creator_v2_fetch_item_play_source_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemPlaySourceRequest","description":"作品流量来源统计请求参数/Item play source statistics request parameters"},"example":{"cookie":"Your_Cookie_Here","item_id":"7559536212910853422"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_search_keyword":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取作品搜索关键词统计/Fetch item search keywords statistics","description":"# [中文]\n### 用途:\n- 获取抖音作品的搜索关键词统计数据\n- 了解用户通过哪些搜索关键词找到并观看了该作品\n- 帮助创作者优化内容标题、标签和描述，提升搜索曝光\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- item_id: 作品ID（必填）\n\n### 返回数据说明:\n返回用户搜索该作品时使用的关键词列表，包括：\n- keyword: 搜索关键词\n- count: 该关键词被搜索的次数\n- percentage: 该关键词占总搜索量的百分比\n\n**注意**: 如果返回空列表，说明该作品目前暂无搜索关键词数据，可能原因：\n- 作品刚发布，还没有用户通过搜索观看\n- 作品主要通过推荐、关注等非搜索渠道传播\n- 数据统计周期内没有搜索行为\n\n### 数据价值:\n- **优化标题**: 根据热门关键词调整作品标题\n- **优化标签**: 添加相关的热门搜索词作为标签\n- **内容策划**: 了解用户兴趣点，制作更符合需求的内容\n- **SEO优化**: 提升作品在搜索结果中的排名\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get Douyin item search keywords statistics\n- Understand which search keywords users used to find and watch the item\n- Help creators optimize content titles, tags, and descriptions to improve search exposure\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- item_id: Item ID (required)\n\n### Return Data Description:\nReturns a list of keywords users searched for to find this item, including:\n- keyword: Search keyword\n- count: Number of times this keyword was searched\n- percentage: Percentage of this keyword in total searches\n\n**Note**: If an empty list is returned, it means there is currently no search keyword data for this item, possible reasons:\n- Item was just published and no users have searched for it yet\n- Item is mainly spread through recommendations, follows, etc., not through search\n- No search behavior during the statistics period\n\n### Data Value:\n- **Optimize Title**: Adjust item title based on popular keywords\n- **Optimize Tags**: Add relevant popular search terms as tags\n- **Content Planning**: Understand user interests and create more relevant content\n- **SEO Optimization**: Improve item ranking in search results\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"item_id\": \"7559536212910853422\"\n}\n```\n\n### 返回数据示例/Response Example:\n```json\n{\n    \"keywords\": [\n        {\n            \"keyword\": \"搞笑视频\",\n            \"count\": 1250,\n            \"percentage\": 35.5\n        },\n        {\n            \"keyword\": \"热门音乐\",\n            \"count\": 850,\n            \"percentage\": 24.2\n        },\n        {\n            \"keyword\": \"舞蹈教学\",\n            \"count\": 620,\n            \"percentage\": 17.6\n        }\n    ],\n    \"total_count\": 3520,\n    \"status_code\": 0,\n    \"status_msg\": \"\"\n}\n```\n\n### 数据解读/Data Interpretation:\n- 关键词列表按搜索次数降序排列\n- percentage 值越高，说明该关键词越受用户关注\n- 可以根据高频关键词优化作品的标题、描述和标签\n- 发现意外的热门关键词可能揭示新的内容方向\n- **空列表**: 说明作品暂无搜索数据，作品主要通过其他渠道传播\n\n### 应用建议/Application Suggestions:\n1. **标题优化**: 在标题中自然融入高频关键词\n2. **标签策略**: 使用搜索量高的关键词作为标签\n3. **内容调整**: 创作更多用户搜索的相关内容\n4. **竞品分析**: 对比不同作品的关键词差异","operationId":"fetch_item_search_keyword_api_v1_douyin_creator_v2_fetch_item_search_keyword_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemSearchKeywordRequest","description":"作品搜索关键词统计请求参数/Item search keywords statistics request parameters"},"example":{"cookie":"Your_Cookie_Here","item_id":"7559536212910853422"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_watch_trend":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取作品观看趋势分析/Fetch item watch trend analysis","description":"# [中文]\n### 用途:\n- 获取抖音作品的观看趋势分析数据\n- 了解用户在观看作品时的行为模式\n- 帮助创作者优化视频内容结构和节奏\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- item_id: 作品ID（必填）\n- analysis_type: 分析类型（可选，默认为1）\n  - **1**: 留存分析 - 显示用户在各个时间点的留存情况\n  - **2**: 点赞分析 - 显示用户在各个时间点的点赞情况\n  - **7**: 跳出分析 - 显示用户在各个时间点的跳出情况\n\n### 分析类型说明:\n- **留存分析 (analysis_type=1)**:\n  - 展示观众在视频各时间点的留存比例\n  - 留存率越高，说明该时间段内容越吸引人\n  - **注意**: 播放量超过200后，数据更准确\n  - 适合分析：哪些片段吸引观众持续观看\n\n- **点赞分析 (analysis_type=2)**:\n  - 展示观众在视频各时间点的点赞比例\n  - 点赞率高的时间点说明该片段特别受欢迎\n  - 适合分析：哪些片段最能引发用户互动\n\n- **跳出分析 (analysis_type=7)**:\n  - 展示观众在视频各时间点的跳出比例\n  - 跳出率高的时间点可能存在内容问题\n  - 适合分析：哪些片段导致观众离开\n\n### 返回数据说明:\n- analysis_trend: 趋势分析数据\n  - current_item: 当前作品的数据点列表\n    - key: 时间点（格式：mm:ss，如 \"00:05\" 表示第5秒）\n    - value: 该时间点的比例值（0-1之间的小数）\n  - similar_author: 同类作者的平均数据（用于对比）\n    - key: 时间点\n    - value: 同类作者在该时间点的平均比例\n\n### 数据价值:\n- **内容优化**: 识别观众流失的关键时间点\n- **节奏调整**: 优化视频的起承转合节奏\n- **对比分析**: 与同类作者对比，找出差距和优势\n- **A/B测试**: 测试不同版本的内容效果\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get Douyin item watch trend analysis data\n- Understand user behavior patterns while watching the item\n- Help creators optimize video content structure and pacing\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- item_id: Item ID (required)\n- analysis_type: Analysis type (optional, default is 1)\n  - **1**: Retention Analysis - Shows user retention at each time point\n  - **2**: Like Analysis - Shows user like behavior at each time point\n  - **7**: Bounce Analysis - Shows user bounce rate at each time point\n\n### Analysis Type Description:\n- **Retention Analysis (analysis_type=1)**:\n  - Shows viewer retention rate at various video time points\n  - Higher retention means more engaging content at that moment\n  - **Note**: Data is more accurate when views exceed 200\n  - Good for: Identifying which segments keep viewers watching\n\n- **Like Analysis (analysis_type=2)**:\n  - Shows viewer like rate at various video time points\n  - Higher like rate indicates particularly popular segments\n  - Good for: Identifying segments that drive user engagement\n\n- **Bounce Analysis (analysis_type=7)**:\n  - Shows viewer bounce rate at various video time points\n  - High bounce rate indicates potential content issues\n  - Good for: Identifying segments that cause viewers to leave\n\n### Return Data Description:\n- analysis_trend: Trend analysis data\n  - current_item: Data points for current item\n    - key: Time point (format: mm:ss, e.g., \"00:05\" for 5 seconds)\n    - value: Proportion at this time point (decimal between 0-1)\n  - similar_author: Average data from similar authors (for comparison)\n    - key: Time point\n    - value: Average proportion at this time point\n\n### Data Value:\n- **Content Optimization**: Identify key drop-off points\n- **Pacing Adjustment**: Optimize video rhythm and flow\n- **Comparative Analysis**: Compare with similar creators to find gaps\n- **A/B Testing**: Test different content versions\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"item_id\": \"7559536212910853422\",\n    \"analysis_type\": 1\n}\n```\n\n### 返回数据示例/Response Example:\n```json\n{\n    \"analysis_trend\": {\n        \"current_item\": [\n            {\n                \"key\": \"00:00\",\n                \"value\": 0.2653\n            },\n            {\n                \"key\": \"00:01\",\n                \"value\": 0.2653\n            },\n            {\n                \"key\": \"00:05\",\n                \"value\": 0.0272\n            },\n            {\n                \"key\": \"00:10\",\n                \"value\": 0.1429\n            }\n        ],\n        \"similar_author\": [\n            {\n                \"key\": \"00:00\",\n                \"value\": 0.1594\n            },\n            {\n                \"key\": \"00:01\",\n                \"value\": 0.2229\n            }\n        ]\n    },\n    \"status_code\": 0,\n    \"status_msg\": \"\"\n}\n```\n\n### 数据解读/Data Interpretation:\n**留存分析 (Retention)**:\n- value 值表示该时间点的留存比例\n- 数值越高表示越多观众看到这个时间点\n- 对比 current_item 和 similar_author 可以看出作品表现\n- 留存曲线下降陡峭说明内容吸引力不足\n\n**点赞分析 (Like)**:\n- value 值表示该时间点的点赞比例\n- 数值越高表示该时间段内容越能引发点赞\n- 点赞高峰通常出现在高潮、反转、笑点等位置\n- 可以帮助识别最有价值的内容片段\n\n**跳出分析 (Bounce)**:\n- value 值表示该时间点的跳出比例\n- 数值越高表示越多观众在此时离开\n- 跳出率高的时间点需要重点优化\n- 开头几秒的跳出率尤其重要\n\n### 优化建议/Optimization Suggestions:\n1. **前3秒黄金法则**: 确保开头吸引眼球，降低初期跳出\n2. **节奏把控**: 在留存率下降前插入高潮或转折\n3. **时长优化**: 根据留存曲线调整视频时长\n4. **点赞热点**: 在点赞率高的时间段前后放置核心内容\n5. **对标学习**: 参考 similar_author 数据优化内容\n6. **持续测试**: 不同类型内容的最佳节奏不同\n\n### 注意事项/Notes:\n- 播放量超过 200 后，留存分析数据更准确\n- 数据可能有延迟，建议作品发布一段时间后查看\n- 结合其他指标（完播率、互动率）综合分析","operationId":"fetch_item_watch_trend_api_v1_douyin_creator_v2_fetch_item_watch_trend_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemWatchTrendRequest","description":"作品观看趋势分析请求参数/Item watch trend analysis request parameters"},"example":{"cookie":"Your_Cookie_Here","item_id":"7559536212910853422","analysis_type":1}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_danmaku_analysis":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取作品弹幕分析/Fetch item bullet analysis","description":"# [中文]\n### 用途:\n- 获取抖音作品的弹幕分析数据\n- 了解观众在视频各个时间点的弹幕互动情况\n- 帮助创作者识别视频中的热点片段和观众反应\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- item_id: 作品ID（必填）\n\n### 返回数据说明:\n返回作品的弹幕分析数据，包括：\n- bullet_distribution: 弹幕分布数据\n  - time_point: 时间点（秒）\n  - count: 该时间点的弹幕数量\n  - percentage: 该时间点弹幕占总弹幕的百分比\n- hot_words: 热门弹幕词汇\n  - word: 弹幕词汇\n  - count: 出现次数\n  - sentiment: 情感倾向（正面/负面/中性）\n- total_count: 弹幕总数\n- peak_time: 弹幕高峰时间点\n\n**注意**: 如果返回空数据或弹幕数量为0，说明该作品目前没有弹幕数据，可能原因：\n- 作品刚发布，还没有观众发送弹幕\n- 作品类型不适合弹幕互动\n- 弹幕功能未开启\n\n### 数据价值:\n- **热点识别**: 识别观众最感兴趣的视频片段\n- **情感分析**: 了解观众对内容的情感反应\n- **互动优化**: 在高弹幕区域优化内容呈现\n- **内容改进**: 根据弹幕反馈调整后续内容\n\n### 应用场景:\n1. **内容优化**: 找出观众最喜欢的片段，在后续视频中强化类似内容\n2. **节奏调整**: 弹幕密集的时间点说明内容吸引人，可以延长类似内容时长\n3. **情感把控**: 通过弹幕情感分析了解观众真实反应\n4. **互动设计**: 在弹幕高峰处设计互动环节，提升参与度\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get Douyin item bullet (danmaku) analysis data\n- Understand audience bullet interaction at various video time points\n- Help creators identify hot segments and audience reactions\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- item_id: Item ID (required)\n\n### Return Data Description:\nReturns item bullet analysis data, including:\n- bullet_distribution: Bullet distribution data\n  - time_point: Time point (seconds)\n  - count: Number of bullets at this time point\n  - percentage: Percentage of bullets at this time point\n- hot_words: Popular bullet words\n  - word: Bullet word\n  - count: Occurrence count\n  - sentiment: Sentiment orientation (positive/negative/neutral)\n- total_count: Total bullet count\n- peak_time: Peak time point for bullets\n\n**Note**: If empty data or zero bullets returned, it means there is currently no bullet data for this item, possible reasons:\n- Item was just published and no viewers have sent bullets yet\n- Item type is not suitable for bullet interaction\n- Bullet feature is not enabled\n\n### Data Value:\n- **Hot Spot Identification**: Identify video segments with highest audience interest\n- **Sentiment Analysis**: Understand audience emotional reactions to content\n- **Interaction Optimization**: Optimize content presentation in high-bullet areas\n- **Content Improvement**: Adjust future content based on bullet feedback\n\n### Application Scenarios:\n1. **Content Optimization**: Find favorite segments and reinforce similar content\n2. **Pacing Adjustment**: Dense bullet areas indicate engaging content, extend similar segments\n3. **Emotion Control**: Understand genuine audience reactions through bullet sentiment\n4. **Interaction Design**: Design interactive elements at bullet peaks to boost engagement\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"item_id\": \"7559536212910853422\"\n}\n```\n\n### 返回数据示例/Response Example:\n```json\n{\n    \"bullet_distribution\": [\n        {\n            \"time_point\": 5,\n            \"count\": 328,\n            \"percentage\": 15.2\n        },\n        {\n            \"time_point\": 12,\n            \"count\": 562,\n            \"percentage\": 26.1\n        },\n        {\n            \"time_point\": 18,\n            \"count\": 445,\n            \"percentage\": 20.6\n        }\n    ],\n    \"hot_words\": [\n        {\n            \"word\": \"哈哈哈\",\n            \"count\": 156,\n            \"sentiment\": \"positive\"\n        },\n        {\n            \"word\": \"精彩\",\n            \"count\": 98,\n            \"sentiment\": \"positive\"\n        },\n        {\n            \"word\": \"学到了\",\n            \"count\": 76,\n            \"sentiment\": \"positive\"\n        }\n    ],\n    \"total_count\": 2156,\n    \"peak_time\": 12,\n    \"status_code\": 0,\n    \"status_msg\": \"\"\n}\n```\n\n### 数据解读/Data Interpretation:\n- **弹幕分布 (Bullet Distribution)**:\n  - time_point 显示哪个时间点弹幕最密集\n  - count 越高表示该片段越引起观众共鸣\n  - percentage 帮助识别弹幕集中度\n  - 多个弹幕高峰说明视频有多个精彩片段\n\n- **热门词汇 (Hot Words)**:\n  - 高频正面词汇（如\"精彩\"、\"学到了\"）说明内容质量好\n  - 负面词汇可能揭示内容问题点\n  - 疑问词汇（如\"为什么\"）可能是用户困惑点\n\n- **总弹幕数 (Total Count)**:\n  - 弹幕数量反映视频互动热度\n  - 相对播放量的弹幕率可以衡量内容吸引力\n  - 持续增长说明内容有长尾效应\n\n### 优化建议/Optimization Suggestions:\n1. **强化高峰**: 在弹幕高峰时间点前后强化内容质量\n2. **延长精彩**: 延长弹幕密集片段的时长，满足观众期待\n3. **回应反馈**: 根据热门词汇调整内容方向\n4. **引导互动**: 在弹幕较少的时间点添加引导性内容\n5. **情感共鸣**: 多设计能引发正面情感的片段\n6. **问题解答**: 针对疑问类弹幕在后续视频中解答\n\n### 注意事项/Notes:\n- 弹幕数据可能有延迟，建议作品发布一段时间后查看\n- 弹幕分析需要一定的样本量才准确，新作品可能数据不足\n- 结合其他指标（互动率、完播率）综合分析效果更好\n- 不同类型内容的弹幕特点不同，需要针对性分析","operationId":"fetch_item_danmaku_analysis_api_v1_douyin_creator_v2_fetch_item_danmaku_analysis_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemBulletAnalysisRequest","description":"作品弹幕分析请求参数/Item bullet analysis request parameters"},"example":{"cookie":"Your_Cookie_Here","item_id":"7559536212910853422"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_audience_portrait":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取作品观众数据分析/Fetch item audience portrait","description":"# [中文]\n### 用途:\n- 获取抖音作品的观众数据分析\n- 了解观看作品的用户画像特征\n- 包含活跃分布、性别分布、地域分布、年龄分布等多维度数据\n- 帮助创作者精准定位目标受众，优化内容策略\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- item_id: 作品ID（必填）\n\n### 返回数据说明:\n返回作品的观众画像数据，包括以下维度：\n\n**1. 活跃分布 (active)**:\n- key: 活跃时段标识（\"2\"=上午, \"3\"=下午, \"4\"=晚上, \"-1\"=其他）\n- value: 该时段的活跃用户占比（0-1之间的小数）\n\n**2. 性别分布 (gender)**:\n- ratio_list: 性别占比列表\n  - key: \"male\"（男性）或 \"female\"（女性）\n  - value: 该性别用户占比（0-1之间的小数）\n- tgi_list: 性别TGI指数列表（Target Group Index，目标群体指数）\n  - key: 性别标识\n  - value: TGI值（100为平均水平，>100表示高于平均）\n\n**3. 地域分布 (province)**:\n- ratio_list: 省份占比列表\n  - key: 省份名称（如\"浙江\"、\"广东\"、\"北京\"）\n  - value: 该省份用户占比（0-1之间的小数）\n- tgi_list: 省份TGI指数列表\n  - key: 省份名称\n  - value: TGI值（反映该地区用户的活跃度）\n\n**4. 年龄分布 (age)**:\n- ratio_list: 年龄段占比列表\n  - key: 年龄段（\"-18\", \"18-23\", \"24-30\", \"31-40\", \"41-50\", \"50-\"）\n  - value: 该年龄段用户占比（0-1之间的小数）\n- tgi_list: 年龄段TGI指数列表\n  - key: 年龄段\n  - value: TGI值（反映该年龄段用户的偏好度）\n\n**5. 其他维度**:\n- career: 职业分布（可能为空）\n- city_level: 城市等级分布（包含ratio_list和tgi_list）\n- new_user: 新用户占比（可能为空）\n\n**TGI指数说明**:\n- TGI = 100: 该群体表现与平台平均水平一致\n- TGI > 100: 该群体在此作品中的占比高于平台平均，是核心受众\n- TGI < 100: 该群体在此作品中的占比低于平台平均\n- TGI越高，说明该群体对此类内容越感兴趣\n\n**注意**: 如果某些数据为空或占比为0，可能原因：\n- 作品刚发布，样本量不足\n- 该维度暂无数据或数据未达到统计阈值\n- 某些地区或年龄段的用户较少\n\n### 数据价值:\n- **精准定位**: 了解核心受众群体特征\n- **内容优化**: 根据受众特点调整内容风格和主题\n- **发布时机**: 根据活跃时间优化发布时间\n- **地域策略**: 针对主要地域用户定制内容\n- **年龄适配**: 调整内容深度和表达方式\n- **性别偏好**: 理解不同性别用户的内容偏好\n\n### 应用场景:\n1. **内容定位**: 根据主要受众群体调整内容方向\n2. **发布优化**: 在目标受众活跃时段发布作品\n3. **地域营销**: 针对主要地域用户进行本地化内容创作\n4. **年龄策略**: 根据年龄分布调整内容复杂度和话题\n5. **性别营销**: 平衡或侧重特定性别受众的内容设计\n6. **受众拓展**: 识别潜力受众群体，扩大影响力\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get Douyin item audience portrait data\n- Understand viewer demographic characteristics\n- Includes active distribution, gender distribution, region distribution, age distribution\n- Help creators precisely target audiences and optimize content strategy\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- item_id: Item ID (required)\n\n### Return Data Description:\nReturns audience portrait data with multiple dimensions:\n\n**1. Active Distribution (active)**:\n- key: Time period identifier (\"2\"=morning, \"3\"=afternoon, \"4\"=evening, \"-1\"=other)\n- value: Active user ratio in this period (decimal between 0-1)\n\n**2. Gender Distribution (gender)**:\n- ratio_list: Gender ratio list\n  - key: \"male\" or \"female\"\n  - value: Gender user ratio (decimal between 0-1)\n- tgi_list: Gender TGI index list (Target Group Index)\n  - key: Gender identifier\n  - value: TGI value (100=average, >100=above average)\n\n**3. Region Distribution (province)**:\n- ratio_list: Province ratio list\n  - key: Province name (e.g., \"浙江\", \"广东\", \"北京\")\n  - value: Province user ratio (decimal between 0-1)\n- tgi_list: Province TGI index list\n  - key: Province name\n  - value: TGI value (reflects regional user activity)\n\n**4. Age Distribution (age)**:\n- ratio_list: Age range ratio list\n  - key: Age range (\"-18\", \"18-23\", \"24-30\", \"31-40\", \"41-50\", \"50-\")\n  - value: Age range user ratio (decimal between 0-1)\n- tgi_list: Age range TGI index list\n  - key: Age range\n  - value: TGI value (reflects age group preference)\n\n**5. Other Dimensions**:\n- career: Career distribution (may be empty)\n- city_level: City level distribution (contains ratio_list and tgi_list)\n- new_user: New user ratio (may be empty)\n\n**TGI Index Explanation**:\n- TGI = 100: Group performance matches platform average\n- TGI > 100: Group ratio is higher than platform average, core audience\n- TGI < 100: Group ratio is lower than platform average\n- Higher TGI indicates greater interest in this content type\n\n**Note**: If some data is empty or zero, possible reasons:\n- Item just published with insufficient sample size\n- No data available for this dimension or below statistical threshold\n- Few users in certain regions or age groups\n\n### Data Value:\n- **Precise Targeting**: Understand core audience characteristics\n- **Content Optimization**: Adjust content style based on audience traits\n- **Publishing Timing**: Optimize publish time based on active periods\n- **Regional Strategy**: Customize content for main regional users\n- **Age Adaptation**: Adjust content depth and expression\n- **Gender Preference**: Understand content preferences by gender\n\n### Application Scenarios:\n1. **Content Positioning**: Adjust content direction based on main audience\n2. **Publishing Optimization**: Publish during target audience active hours\n3. **Regional Marketing**: Create localized content for main regions\n4. **Age Strategy**: Adjust content complexity based on age distribution\n5. **Gender Marketing**: Balance or focus on specific gender audiences\n6. **Audience Expansion**: Identify potential audience groups to expand influence\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"item_id\": \"7559536212910853422\"\n}\n```\n\n### 返回数据示例/Response Example:\n```json\n{\n    \"active\": [\n        {\n            \"key\": \"2\",\n            \"value\": 0.0949367088607595\n        },\n        {\n            \"key\": \"3\",\n            \"value\": 0.15822784810126583\n        },\n        {\n            \"key\": \"4\",\n            \"value\": 0.6962025316455697\n        },\n        {\n            \"key\": \"-1\",\n            \"value\": 0.05063291139240506\n        }\n    ],\n    \"gender\": {\n        \"ratio_list\": [\n            {\n                \"key\": \"male\",\n                \"value\": 0.7612903225806451\n            },\n            {\n                \"key\": \"female\",\n                \"value\": 0.23870967741935484\n            }\n        ],\n        \"tgi_list\": [\n            {\n                \"key\": \"male\",\n                \"value\": 135.47066238136884\n            },\n            {\n                \"key\": \"female\",\n                \"value\": 54.49489346627035\n            }\n        ]\n    },\n    \"province\": {\n        \"ratio_list\": [\n            {\n                \"key\": \"浙江\",\n                \"value\": 0.24050632911392406\n            },\n            {\n                \"key\": \"江苏\",\n                \"value\": 0.12025316455696203\n            },\n            {\n                \"key\": \"广东\",\n                \"value\": 0.0759493670886076\n            },\n            {\n                \"key\": \"湖北\",\n                \"value\": 0.06329113924050633\n            }\n        ],\n        \"tgi_list\": [\n            {\n                \"key\": \"浙江\",\n                \"value\": 379.3041755346526\n            },\n            {\n                \"key\": \"江苏\",\n                \"value\": 169.70798949761055\n            },\n            {\n                \"key\": \"广东\",\n                \"value\": 70.0324843724158\n            },\n            {\n                \"key\": \"湖北\",\n                \"value\": 164.36825973059874\n            }\n        ]\n    },\n    \"age\": {\n        \"ratio_list\": [\n            {\n                \"key\": \"18-23\",\n                \"value\": 0.3548387096774194\n            },\n            {\n                \"key\": \"-18\",\n                \"value\": 0.1935483870967742\n            },\n            {\n                \"key\": \"31-40\",\n                \"value\": 0.14838709677419354\n            },\n            {\n                \"key\": \"50-\",\n                \"value\": 0.11612903225806452\n            },\n            {\n                \"key\": \"41-50\",\n                \"value\": 0.10967741935483871\n            },\n            {\n                \"key\": \"24-30\",\n                \"value\": 0.07741935483870968\n            }\n        ],\n        \"tgi_list\": [\n            {\n                \"key\": \"-18\",\n                \"value\": 563.217280988937\n            },\n            {\n                \"key\": \"18-23\",\n                \"value\": 191.33476395324902\n            },\n            {\n                \"key\": \"50-\",\n                \"value\": 80.07137972518639\n            },\n            {\n                \"key\": \"41-50\",\n                \"value\": 73.75840394976595\n            },\n            {\n                \"key\": \"31-40\",\n                \"value\": 49.79826524888418\n            },\n            {\n                \"key\": \"24-30\",\n                \"value\": 41.07687409864829\n            }\n        ]\n    },\n    \"career\": [],\n    \"city_level\": {\n        \"ratio_list\": [],\n        \"tgi_list\": []\n    },\n    \"new_user\": [],\n    \"status_code\": 0,\n    \"status_msg\": \"\"\n}\n```\n\n### 数据解读/Data Interpretation:\n**活跃分布 (active)**:\n- key=\"2\": 上午时段（通常指6:00-12:00）\n- key=\"3\": 下午时段（通常指12:00-18:00）\n- key=\"4\": 晚上时段（通常指18:00-24:00）\n- key=\"-1\": 其他时段或未分类\n- value值越高，说明该时段观众越多\n- 示例中晚上时段（key=\"4\"）占比69.6%，是主要观看时段\n\n**性别分布 (gender)**:\n- ratio_list显示实际性别占比\n- tgi_list显示性别偏好度（TGI>100表示该性别用户偏好此内容）\n- 示例中男性占比76.1%，TGI为135.5，说明男性用户是核心受众\n- 女性TGI仅54.5，低于平均水平，可考虑优化以吸引女性用户\n\n**地域分布 (province)**:\n- ratio_list显示各省份用户占比\n- tgi_list显示地域偏好度\n- 示例中浙江占比24%，TGI高达379，说明浙江用户特别喜欢此类内容\n- 江苏、湖北的TGI也较高（>160），是重点地域\n- 可针对高TGI地域制作本地化内容\n\n**年龄分布 (age)**:\n- \"-18\": 18岁以下，TGI高达563，说明未成年用户特别喜欢\n- \"18-23\": 18-23岁，占比35.5%，TGI为191，是主力受众\n- \"24-30\": 24-30岁，TGI仅41，低于平均水平\n- \"31-40\", \"41-50\", \"50-\": 中老年用户占比和TGI都较低\n- 此作品明显偏向年轻化受众\n\n**TGI指数应用**:\n- TGI>150: 高度偏好，是核心目标群体\n- TGI 100-150: 中度偏好，有潜力拓展\n- TGI 50-100: 低度偏好，需要优化内容吸引\n- TGI<50: 不匹配，可能不是目标受众\n\n### 优化建议/Optimization Suggestions:\n1. **时间优化**: 根据active数据，在高活跃时段发布（示例中晚上最佳）\n2. **内容适配**: 根据高TGI年龄段调整内容风格（示例应偏向18-23岁年轻化）\n3. **性别策略**: 针对高TGI性别深化内容，或优化以平衡性别受众\n4. **地域营销**: 为高TGI地域（如浙江、江苏）创作本地化内容或方言版本\n5. **受众拓展**: 关注TGI低的群体（如24-30岁），寻找增长机会\n6. **精准定位**: 聚焦TGI>150的群体，他们是最有价值的核心受众\n7. **内容调整**: 如果想拓展受众，需要调整内容以提升低TGI群体的兴趣\n8. **A/B测试**: 针对不同TGI群体制作差异化内容，测试效果\n\n### 注意事项/Notes:\n- 观众数据需要一定播放量才准确，建议作品有1000+播放后查看\n- 数据可能有延迟，通常在作品发布24-48小时后更新\n- Index值用于与平台均值对比，帮助识别特色受众\n- 结合作品内容特点和目标受众综合分析\n- 不同内容类型的受众特征差异较大，需要针对性优化","operationId":"fetch_item_audience_portrait_api_v1_douyin_creator_v2_fetch_item_audience_portrait_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAudiencePortraitRequest","description":"作品观众数据分析请求参数/Item audience portrait request parameters"},"example":{"cookie":"Your_Cookie_Here","item_id":"7559536212910853422"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_audience_others":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取作品观众其他数据分析/Fetch item audience others analysis","description":"# [中文]\n### 用途:\n- 获取抖音作品的观众其他数据分析，包括受众分布和受众关注词\n- 了解观众是否为粉丝，以及观众关注的兴趣话题\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- item_id: 作品ID（必填）\n\n### 返回数据说明:\n- **audience_distribution (受众分布)**:\n  - fan_list: 粉丝占比列表\n    - key: \"1\"=粉丝, \"0\"=非粉丝\n    - value: 占比（0-1之间的小数）\n\n- **audience_keyword (受众关注词)**:\n  - keyword_list: 观众关注的话题/关键词列表\n    - keyword: 关键词内容\n    - value: 该关键词的关注度占比\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get Douyin item audience other data analysis, including audience distribution and audience keywords\n- Understand whether the audience are fans and what topics they are interested in\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- item_id: Item ID (required)\n\n### Return Data Description:\n- **audience_distribution (Audience Distribution)**:\n  - fan_list: Fan proportion list\n    - key: \"1\"=Fan, \"0\"=Non-fan\n    - value: Proportion (decimal between 0-1)\n\n- **audience_keyword (Audience Keywords)**:\n  - keyword_list: List of topics/keywords that audiences are interested in\n    - keyword: Keyword content\n    - value: Interest proportion for this keyword\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"item_id\": \"7559536212910853422\"\n}\n```\n\n### 返回数据示例/Response Example:\n```json\n{\n    \"audience_distribution\": {\n        \"fan_list\": [\n            {\n                \"key\": \"1\",\n                \"value\": 0.156\n            },\n            {\n                \"key\": \"0\",\n                \"value\": 0.844\n            }\n        ]\n    },\n    \"audience_keyword\": {\n        \"keyword_list\": [\n            {\n                \"keyword\": \"美食\",\n                \"value\": 0.35\n            },\n            {\n                \"keyword\": \"旅游\",\n                \"value\": 0.28\n            },\n            {\n                \"keyword\": \"生活\",\n                \"value\": 0.22\n            },\n            {\n                \"keyword\": \"娱乐\",\n                \"value\": 0.15\n            }\n        ]\n    },\n    \"status_code\": 0,\n    \"status_msg\": \"\"\n}\n```\n\n### 数据解读/Data Interpretation:\n\n**受众分布 (audience_distribution)**:\n- key=\"1\": 表示粉丝，value=0.156 表示15.6%的观众是已关注的粉丝\n- key=\"0\": 表示非粉丝，value=0.844 表示84.4%的观众是未关注的路人\n- 粉丝占比高说明内容对现有粉丝吸引力强\n- 非粉丝占比高说明作品破圈能力强，吸引了很多新观众\n\n**受众关注词 (audience_keyword)**:\n- keyword_list展示观众群体关注的其他话题\n- 可以了解观众的兴趣偏好，用于内容规划\n- 示例中观众主要关注\"美食\"(35%)、\"旅游\"(28%)等话题\n- 可以结合这些关键词创作相关内容，提高吸引力\n\n### 优化建议/Optimization Suggestions:\n1. **粉丝维护**: 如果粉丝占比高(>30%)，说明内容符合粉丝预期，继续保持风格\n2. **破圈拓展**: 如果非粉丝占比高(>80%)，说明内容有爆款潜力，可加大推广\n3. **内容规划**: 根据audience_keyword规划相关主题内容，覆盖观众兴趣点\n4. **跨界合作**: 结合高占比关键词，进行跨领域内容创作\n5. **粉丝转化**: 对于非粉丝占比高的爆款作品，在评论区引导关注\n6. **兴趣匹配**: 关注观众兴趣词与作品内容的匹配度，调整内容方向\n7. **话题借势**: 利用观众关注的热门话题，制作相关内容蹭热度\n8. **受众画像**: 结合关注词描绘完整的受众兴趣画像\n\n### 注意事项/Notes:\n- 观众数据需要一定播放量才准确，建议作品有1000+播放后查看\n- 数据可能有延迟，通常在作品发布24-48小时后更新\n- 粉丝占比与作品是否爆款无关，重点看内容质量和推广效果\n- 受众关注词反映的是观众整体兴趣，不一定与当前作品主题相关\n- 如果返回空列表，说明该作品目前暂无足够数据\n- 结合其他数据（如观众画像）综合分析效果更好","operationId":"fetch_item_audience_others_api_v1_douyin_creator_v2_fetch_item_audience_others_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAudienceOthersRequest","description":"作品观众其他数据分析请求参数/Item audience others analysis request parameters"},"example":{"cookie":"Your_Cookie_Here","item_id":"7559536212910853422"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_analysis_involved_vertical":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取作品垂类标签/Fetch item analysis involved vertical","description":"# [中文]\n### 用途:\n- 获取指定时间段内投稿作品涉及的垂类标签\n- 用于后续调用投稿分析接口时的参数\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- start_date: 开始日期，格式YYYYMMDD（必填）\n- end_date: 结束日期，格式YYYYMMDD（必填）\n- **注意：日期范围最多90天**\n\n### 返回数据说明:\n- primary_verticals: 垂类标签列表\n  - 返回该账号在指定时间段内发布的作品涉及的垂类\n  - 例如：[\"动物\", \"美食\", \"旅游\"]\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get the vertical tags involved in submitted items within the specified time period\n- Used as parameters for subsequent calls to the submission analysis interface\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- start_date: Start date in YYYYMMDD format (required)\n- end_date: End date in YYYYMMDD format (required)\n- **Note: Date range maximum 90 days**\n\n### Return Data Description:\n- primary_verticals: List of vertical tags\n  - Returns the verticals involved in items published during the specified time period\n  - Example: [\"Animals\", \"Food\", \"Travel\"]\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"start_date\": \"20250713\",\n    \"end_date\": \"20251011\"\n}\n```\n\n### 返回数据示例/Response Example:\n```json\n{\n    \"primary_verticals\": [\"动物\", \"美食\", \"旅游\"],\n    \"status_code\": 0,\n    \"status_msg\": \"\"\n}\n```\n\n### 数据解读/Data Interpretation:\n- primary_verticals列表包含该账号投稿作品涉及的所有垂类\n- 如果返回空列表，说明该时间段内没有投稿或垂类未分类\n- 获取到垂类后，可用于投稿分析接口的primary_verticals参数\n\n### 注意事项/Notes:\n- 日期格式必须为YYYYMMDD（8位数字）\n- 时间跨度不能超过90天\n- 建议先调用此接口获取垂类，再调用投稿分析接口\n- 如果时间范围内无投稿，可能返回空列表","operationId":"fetch_item_analysis_involved_vertical_api_v1_douyin_creator_v2_fetch_item_analysis_involved_vertical_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnalysisInvolvedVerticalRequest","description":"作品垂类标签请求参数/Item analysis involved vertical request parameters"},"example":{"cookie":"Your_Cookie_Here","start_date":"20250713","end_date":"20251011"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_analysis_overview":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取投稿分析概览/Fetch item analysis overview","description":"# [中文]\n### 用途:\n- 获取账号投稿作品的综合分析数据\n- 包括不同体裁、垂类的投稿表现统计\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n- **建议先调用 fetch_item_analysis_involved_vertical 接口获取垂类标签**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- start_date: 开始日期，格式YYYYMMDD（必填）\n- end_date: 结束日期，格式YYYYMMDD（必填）\n- genres: 体裁类型列表（可选，默认包含所有体裁）\n  - 1: 1分钟以内视频\n  - 2: 1-3分钟视频\n  - 3: 3-5分钟视频\n  - 4: 5分钟以上视频\n  - 5: 图文\n  - 8: 长图文\n- primary_verticals: 垂类标签列表（必填，从 fetch_item_analysis_involved_vertical 接口获取）\n- **注意：日期范围最多90天**\n\n### 返回数据说明:\n- 包含不同体裁和垂类的投稿数据分析\n- 播放量、点赞量、评论量、分享量等指标\n- 不同体裁的内容表现对比\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get comprehensive analysis data for account submitted items\n- Including submission performance statistics for different genres and verticals\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n- **Recommend calling fetch_item_analysis_involved_vertical first to get vertical tags**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- start_date: Start date in YYYYMMDD format (required)\n- end_date: End date in YYYYMMDD format (required)\n- genres: Genre type list (optional, defaults to all genres)\n  - 1: Videos under 1 minute\n  - 2: 1-3 minute videos\n  - 3: 3-5 minute videos\n  - 4: Videos over 5 minutes\n  - 5: Photo posts\n  - 8: Long photo posts\n- primary_verticals: Vertical tag list (required, obtained from fetch_item_analysis_involved_vertical)\n- **Note: Date range maximum 90 days**\n\n### Return Data Description:\n- Contains submission data analysis for different genres and verticals\n- Metrics including views, likes, comments, shares, etc.\n- Performance comparison of different genres\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"start_date\": \"20250713\",\n    \"end_date\": \"20251011\",\n    \"genres\": [1, 2, 3, 4, 5, 8],\n    \"primary_verticals\": [\"动物\"]\n}\n```\n\n### 体裁类型说明/Genre Type Description:\n- **1**: 1分钟以内视频（短视频）\n- **2**: 1-3分钟视频（中短视频）\n- **3**: 3-5分钟视频（中视频）\n- **4**: 5分钟以上视频（长视频）\n- **5**: 图文（图片+文字）\n- **8**: 长图文（多图片+长文字）\n\n### 使用流程/Usage Flow:\n1. 先调用 `fetch_item_analysis_involved_vertical` 获取垂类标签\n2. 使用返回的 primary_verticals 作为参数\n3. 调用本接口获取投稿分析数据\n4. 分析不同体裁和垂类的表现\n\n### 数据解读/Data Interpretation:\n- 可以看到不同体裁内容的表现差异\n- 了解哪种体裁更受欢迎\n- 分析垂类内容的表现趋势\n- 优化内容创作方向\n\n### 优化建议/Optimization Suggestions:\n1. **体裁优化**: 根据数据选择表现更好的体裁类型\n2. **内容时长**: 分析观众偏好的视频时长\n3. **垂类聚焦**: 专注于表现好的垂类领域\n4. **内容多样化**: 尝试不同体裁和垂类的组合\n5. **发布策略**: 根据不同体裁的表现调整发布频率\n\n### 注意事项/Notes:\n- 日期格式必须为YYYYMMDD（8位数字）\n- 时间跨度不能超过90天\n- primary_verticals参数必须从 fetch_item_analysis_involved_vertical 接口获取\n- 如果时间范围内无投稿，可能返回空数据\n- genres参数可以自由组合，按需筛选体裁\n- 数据分析建议至少有7天以上的投稿数据","operationId":"fetch_item_analysis_overview_api_v1_douyin_creator_v2_fetch_item_analysis_overview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnalysisOverviewRequest","description":"投稿分析概览请求参数/Item analysis overview request parameters"},"example":{"cookie":"Your_Cookie_Here","start_date":"20250713","end_date":"20251011","genres":[1,2,3,4,5,8],"primary_verticals":["动物"]}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_analysis_item_performance":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取投稿表现数据/Fetch item analysis item performance","description":"# [中文]\n### 用途:\n- 获取投稿作品的表现数据，包括播放量、点赞量、评论量、分享量等指标\n- 分析不同体裁和垂类的内容表现\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n- **建议先调用 fetch_item_analysis_involved_vertical 接口获取垂类标签**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- start_date: 开始日期，格式YYYYMMDD（必填）\n- end_date: 结束日期，格式YYYYMMDD（必填）\n- genres: 体裁类型列表（可选，默认包含所有体裁）\n  - 1: 1分钟以内视频\n  - 2: 1-3分钟视频\n  - 3: 3-5分钟视频\n  - 4: 5分钟以上视频\n  - 5: 图文\n  - 8: 长图文\n- primary_verticals: 垂类标签列表（必填，从 fetch_item_analysis_involved_vertical 接口获取）\n- metric_type: 指标类型（可选，默认为1）\n  - 1: 播放量 (Views)\n  - 2: 点赞量 (Likes)\n  - 3: 评论量 (Comments)\n  - 4: 分享量 (Shares)\n- **注意：日期范围最多90天**\n\n### 返回数据说明:\n- 包含所选指标在不同体裁和垂类下的表现数据\n- 趋势分析、对比数据等\n- 帮助了解内容在各个维度的表现\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get performance data for submitted items, including views, likes, comments, shares, etc.\n- Analyze content performance across different genres and verticals\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n- **Recommend calling fetch_item_analysis_involved_vertical first to get vertical tags**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- start_date: Start date in YYYYMMDD format (required)\n- end_date: End date in YYYYMMDD format (required)\n- genres: Genre type list (optional, defaults to all genres)\n  - 1: Videos under 1 minute\n  - 2: 1-3 minute videos\n  - 3: 3-5 minute videos\n  - 4: Videos over 5 minutes\n  - 5: Photo posts\n  - 8: Long photo posts\n- primary_verticals: Vertical tag list (required, obtained from fetch_item_analysis_involved_vertical)\n- metric_type: Metric type (optional, defaults to 1)\n  - 1: Views\n  - 2: Likes\n  - 3: Comments\n  - 4: Shares\n- **Note: Date range maximum 90 days**\n\n### Return Data Description:\n- Contains performance data for selected metrics across different genres and verticals\n- Trend analysis and comparison data\n- Helps understand content performance across various dimensions\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"start_date\": \"20250713\",\n    \"end_date\": \"20251011\",\n    \"genres\": [2, 3, 4, 5, 8],\n    \"primary_verticals\": [\"动物\"],\n    \"metric_type\": 1\n}\n```\n\n### 指标类型说明/Metric Type Description:\n- **metric_type=1 (播放量/Views)**: 查看作品的播放量表现\n- **metric_type=2 (点赞量/Likes)**: 查看作品的点赞量表现\n- **metric_type=3 (评论量/Comments)**: 查看作品的评论量表现\n- **metric_type=4 (分享量/Shares)**: 查看作品的分享量表现\n\n### 体裁类型说明/Genre Type Description:\n- **1**: 1分钟以内视频（短视频）- 快速吸引注意力\n- **2**: 1-3分钟视频（中短视频）- 平衡内容与时长\n- **3**: 3-5分钟视频（中视频）- 深度内容展示\n- **4**: 5分钟以上视频（长视频）- 完整故事叙述\n- **5**: 图文（图片+文字）- 静态内容展示\n- **8**: 长图文（多图片+长文字）- 深度图文内容\n\n### 使用流程/Usage Flow:\n1. 先调用 `fetch_item_analysis_involved_vertical` 获取垂类标签\n2. 使用返回的 primary_verticals 作为参数\n3. 选择需要分析的指标类型 (metric_type)\n4. 调用本接口获取投稿表现数据\n5. 分析不同体裁和垂类的表现差异\n\n### 数据解读/Data Interpretation:\n- **播放量 (metric_type=1)**: 反映内容的曝光度和吸引力\n- **点赞量 (metric_type=2)**: 反映内容的质量和受欢迎程度\n- **评论量 (metric_type=3)**: 反映内容的互动性和话题性\n- **分享量 (metric_type=4)**: 反映内容的传播力和价值\n\n### 优化建议/Optimization Suggestions:\n1. **播放量优化**:\n   - 优化标题和封面，提高点击率\n   - 选择合适的发布时间\n   - 利用热门话题和标签\n\n2. **点赞量优化**:\n   - 提升内容质量，引发共鸣\n   - 在视频中引导点赞\n   - 创作有价值、有趣的内容\n\n3. **评论量优化**:\n   - 设置互动话题，引导评论\n   - 在评论区积极回复\n   - 创作有争议或讨论性的内容\n\n4. **分享量优化**:\n   - 创作有价值、实用的内容\n   - 制作有趣、有共鸣的内容\n   - 适当加入情感元素\n\n5. **体裁选择**:\n   - 根据不同指标表现选择合适的体裁\n   - 短视频适合快速传播\n   - 中长视频适合深度内容\n   - 图文适合知识分享\n\n6. **垂类聚焦**:\n   - 专注于表现好的垂类\n   - 分析垂类特点和受众偏好\n   - 持续优化内容方向\n\n### 注意事项/Notes:\n- 日期格式必须为YYYYMMDD（8位数字）\n- 时间跨度不能超过90天\n- primary_verticals参数必须从 fetch_item_analysis_involved_vertical 接口获取\n- 如果时间范围内无投稿，可能返回空数据\n- genres参数可以自由组合，按需筛选体裁\n- 不同metric_type展示不同维度的表现数据\n- 建议结合多个指标综合分析内容表现\n- 数据分析建议至少有7天以上的投稿数据","operationId":"fetch_item_analysis_item_performance_api_v1_douyin_creator_v2_fetch_item_analysis_item_performance_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAnalysisItemPerformanceRequest","description":"投稿表现数据请求参数/Item analysis item performance request parameters"},"example":{"cookie":"Your_Cookie_Here","start_date":"20250713","end_date":"20251011","genres":[2,3,4,5,8],"primary_verticals":["动物"],"metric_type":1}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_list":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取投稿作品列表/Fetch item list","description":"# [中文]\n### 用途:\n- 获取指定时间范围内发布的所有投稿作品列表\n- 支持分页查询，每次最多返回100条数据\n- 数据更新说明：\n  - **播放量、点赞量、评论量、分享量、收藏量实时更新**\n  - **其他指标每小时更新一次**\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- start_time: 开始时间戳，单位毫秒（必填）\n- end_time: 结束时间戳，单位毫秒（必填）\n- count: 每页返回的数量，默认10，最多100（可选）\n- order_by: 排序方式，支持26种排序（可选，默认1）\n- fields: 需要返回的字段，默认 \"metrics,review,visibility\"（可选）\n  - metrics: 流量指标（播放量、点赞量、评论量、分享量、收藏量等）\n  - review: 审核状态\n  - visibility: 可见性状态\n- need_cooperation: 是否需要合作信息，默认true（可选）\n- need_long_article: 是否包含长图文，默认true（可选）\n- cursor: 分页游标，首次请求不传，后续分页使用返回的cursor（可选）\n\n### 排序方式详解 (order_by):\n\n| 值 | 排序字段 | 排序方向 | 更新频率 | 说明 |\n|----|---------|---------|---------|------|\n| 1 | 发布时间 | 从新到旧 ↓ | - | 默认排序，最新发布的在前 |\n| 2 | 发布时间 | 从旧到新 ↑ | - | 最早发布的在前 |\n| 3 | 播放量 | 从高到低 ↓ | 实时 | 作品被观看的次数 |\n| 4 | 播放量 | 从低到高 ↑ | 实时 | 播放量最少的在前 |\n| 5 | 点赞量 | 从高到低 ↓ | 实时 | 作品获得点赞的次数 |\n| 6 | 点赞量 | 从低到高 ↑ | 实时 | 点赞量最少的在前 |\n| 7 | 评论量 | 从高到低 ↓ | 实时 | 作品获得评论的次数 |\n| 8 | 评论量 | 从低到高 ↑ | 实时 | 评论量最少的在前 |\n| 9 | 分享量 | 从高到低 ↓ | 实时 | 作品获得分享的次数 |\n| 10 | 分享量 | 从低到高 ↑ | 实时 | 分享量最少的在前 |\n| 11 | 收藏量 | 从高到低 ↓ | 实时 | 作品获得收藏的次数 |\n| 12 | 收藏量 | 从低到高 ↑ | 实时 | 收藏量最少的在前 |\n| 13 | 2s跳出率 | 从高到低 ↓ | 每小时 | 播放后2s内跳出的播放量/总播放量 |\n| 14 | 2s跳出率 | 从低到高 ↑ | 每小时 | 2s跳出率最低的在前 |\n| 15 | 5s完播率 | 从高到低 ↓ | 每小时 | 播放后超过5s的播放量/总播放量 |\n| 16 | 5s完播率 | 从低到高 ↑ | 每小时 | 5s完播率最低的在前 |\n| 17 | 完播率 | 从高到低 ↓ | 每小时 | 完整播完的播放量/总播放量 |\n| 18 | 完播率 | 从低到高 ↑ | 每小时 | 完播率最低的在前 |\n| 19 | 封面点击率 | 从高到低 ↓ | 每小时 | 作品封面的点击量/曝光量 |\n| 20 | 封面点击率 | 从低到高 ↑ | 每小时 | 封面点击率最低的在前 |\n| 21 | 平均播放时长 | 从高到低 ↓ | 每小时 | 视频被播放的平均时长 |\n| 22 | 平均播放时长 | 从低到高 ↑ | 每小时 | 平均播放时长最短的在前 |\n| 23 | 主页访问量 | 从高到低 ↓ | 每天 | 用户观看作品后访问主页的次数 |\n| 24 | 主页访问量 | 从低到高 ↑ | 每天 | 主页访问量最少的在前 |\n| 25 | 粉丝增量 | 从高到低 ↓ | 每小时 | 观众观看作品后关注作者的数量 |\n| 26 | 粉丝增量 | 从低到高 ↑ | 每小时 | 粉丝增量最少的在前 |\n\n### 排序使用建议:\n- **寻找爆款**: 使用 order_by=3 (播放量↓) 或 order_by=5 (点赞量↓)\n- **优化内容**: 使用 order_by=13 (2s跳出率↓) 找出需要优化的作品\n- **提升完播**: 使用 order_by=17 (完播率↓) 分析高完播率作品\n- **涨粉分析**: 使用 order_by=25 (粉丝增量↓) 找出涨粉效果好的作品\n- **封面优化**: 使用 order_by=19 (封面点击率↓) 分析封面吸引力\n\n### 返回:\n- 投稿作品列表数据，包含作品的详细指标信息\n- has_more: 是否还有更多数据\n- cursor: 下一页的游标，用于分页查询\n- items: 作品列表数组\n\n### 使用流程:\n1. **第一次请求**：不传cursor参数，获取第一页数据\n2. **检查has_more**：如果为true，说明还有更多数据\n3. **分页请求**：使用返回的cursor值作为下次请求的cursor参数\n4. **重复步骤2-3**：直到has_more为false\n\n### 功能限制:\n- 仅支持筛选：所选周期内，前100条作品的体裁\n- 如需导出更多数据，请使用 `/fetch_item_list_download` 接口（支持导出前1000条）\n\n### 时间戳转换:\n- JavaScript: `new Date('2025-07-01').getTime()` -> 1719763200000\n- Python: `int(datetime(2025, 7, 1).timestamp() * 1000)` -> 1719763200000\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get all published items within the specified time range\n- Support pagination query, maximum 100 items per request\n- Data update description:\n  - **Views, likes, comments, shares, favorites update in real-time**\n  - **Other metrics update hourly**\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- start_time: Start timestamp in milliseconds (required)\n- end_time: End timestamp in milliseconds (required)\n- count: Number of items per page, default 10, max 100 (optional)\n- order_by: Sort method, supports 26 types (optional, default 1)\n- fields: Fields to return, default \"metrics,review,visibility\" (optional)\n  - metrics: Traffic metrics (views, likes, comments, shares, favorites, etc.)\n  - review: Review status\n  - visibility: Visibility status\n- need_cooperation: Need cooperation info, default true (optional)\n- need_long_article: Include long articles, default true (optional)\n- cursor: Pagination cursor, don't pass for first request, use returned cursor for pagination (optional)\n\n### Sort Options (order_by):\n\n| Value | Sort Field | Direction | Update Freq | Description |\n|-------|-----------|-----------|-------------|-------------|\n| 1 | Publish Time | Desc ↓ | - | Default, newest first |\n| 2 | Publish Time | Asc ↑ | - | Oldest first |\n| 3 | Views | Desc ↓ | Real-time | Video views count |\n| 4 | Views | Asc ↑ | Real-time | Least views first |\n| 5 | Likes | Desc ↓ | Real-time | Likes count |\n| 6 | Likes | Asc ↑ | Real-time | Least likes first |\n| 7 | Comments | Desc ↓ | Real-time | Comments count |\n| 8 | Comments | Asc ↑ | Real-time | Least comments first |\n| 9 | Shares | Desc ↓ | Real-time | Shares count |\n| 10 | Shares | Asc ↑ | Real-time | Least shares first |\n| 11 | Favorites | Desc ↓ | Real-time | Favorites count |\n| 12 | Favorites | Asc ↑ | Real-time | Least favorites first |\n| 13 | 2s Bounce Rate | Desc ↓ | Hourly | Views bounced within 2s / total views |\n| 14 | 2s Bounce Rate | Asc ↑ | Hourly | Lowest bounce rate first |\n| 15 | 5s Completion | Desc ↓ | Hourly | Views over 5s / total views |\n| 16 | 5s Completion | Asc ↑ | Hourly | Lowest 5s completion first |\n| 17 | Completion Rate | Desc ↓ | Hourly | Full plays / total views |\n| 18 | Completion Rate | Asc ↑ | Hourly | Lowest completion rate first |\n| 19 | Cover CTR | Desc ↓ | Hourly | Cover clicks / cover impressions |\n| 20 | Cover CTR | Asc ↑ | Hourly | Lowest CTR first |\n| 21 | Avg Play Duration | Desc ↓ | Hourly | Average video play duration |\n| 22 | Avg Play Duration | Asc ↑ | Hourly | Shortest duration first |\n| 23 | Profile Visits | Desc ↓ | Daily | Profile visits after watching |\n| 24 | Profile Visits | Asc ↑ | Daily | Least profile visits first |\n| 25 | Follower Growth | Desc ↓ | Hourly | New followers from this video |\n| 26 | Follower Growth | Asc ↑ | Hourly | Least follower growth first |\n\n### Sort Usage Tips:\n- **Find Hits**: Use order_by=3 (Views↓) or order_by=5 (Likes↓)\n- **Content Optimization**: Use order_by=13 (Bounce Rate↓) to find videos to improve\n- **Improve Completion**: Use order_by=17 (Completion↓) to analyze high-completion videos\n- **Follower Analysis**: Use order_by=25 (Follower Growth↓) to find best performing videos\n- **Cover Optimization**: Use order_by=19 (Cover CTR↓) to analyze cover attractiveness\n\n### Return:\n- Item list data with detailed metric information\n- has_more: Whether there are more items\n- cursor: Cursor for next page, used for pagination\n- items: Array of items\n\n### Usage Flow:\n1. **First request**: Don't pass cursor parameter, get first page\n2. **Check has_more**: If true, there are more items\n3. **Paginate**: Use returned cursor value as cursor parameter for next request\n4. **Repeat steps 2-3**: Until has_more is false\n\n### Limitations:\n- Only supports filtering: Top 100 items by genre in selected period\n- For exporting more data, use `/fetch_item_list_download` API (supports top 1000 items)\n\n### Timestamp Conversion:\n- JavaScript: `new Date('2025-07-01').getTime()` -> 1719763200000\n- Python: `int(datetime(2025, 7, 1).timestamp() * 1000)` -> 1719763200000\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n### 基础请求/Basic Request (默认按发布时间排序):\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"start_time\": 1758988800000,\n    \"end_time\": 1760198399000,\n    \"count\": 10\n}\n```\n\n### 按播放量排序/Sort by Views (找爆款视频):\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"start_time\": 1758988800000,\n    \"end_time\": 1760198399000,\n    \"count\": 20,\n    \"order_by\": 3\n}\n```\n\n### 按完播率排序/Sort by Completion Rate (优质内容分析):\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"start_time\": 1758988800000,\n    \"end_time\": 1760198399000,\n    \"count\": 20,\n    \"order_by\": 17\n}\n```\n\n### 按粉丝增量排序/Sort by Follower Growth (涨粉效果分析):\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"start_time\": 1758988800000,\n    \"end_time\": 1760198399000,\n    \"count\": 20,\n    \"order_by\": 25\n}\n```\n\n### 分页请求/Pagination Request:\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"start_time\": 1758988800000,\n    \"end_time\": 1760198399000,\n    \"count\": 10,\n    \"cursor\": 1234567890\n}\n```\n\n### 返回数据示例/Response Example:\n```json\n{\n    \"has_more\": true,\n    \"cursor\": 1234567890,\n    \"items\": [\n        {\n            \"item_id\": \"7559536212910853422\",\n            \"metrics\": {\n                \"play_count\": 12345,\n                \"digg_count\": 678,\n                \"comment_count\": 90,\n                \"share_count\": 45,\n                \"collect_count\": 123\n            },\n            \"review\": {\n                \"status\": 2\n            },\n            \"visibility\": {\n                \"is_public\": true\n            }\n        }\n    ]\n}\n```\n\n### 注意事项/Notes:\n1. **时间范围**: 建议不要设置过长的时间范围，可能导致请求超时\n2. **分页查询**: 如果has_more=true，务必使用返回的cursor继续请求\n3. **数据更新频率**:\n   - 实时更新：播放量、点赞量、评论量、分享量、收藏量\n   - 每小时更新：跳出率、完播率、封面点击率、平均播放时长、粉丝增量\n   - 每天更新：主页访问量\n4. **数据量限制**: 单次请求最多返回100条，如需更多请使用分页或导出接口\n5. **体裁筛选**: 仅支持前100条作品的体裁筛选\n6. **排序选择**: 根据分析目标选择合适的排序方式（共26种）\n7. **Cookie有效性**: 如果返回错误，请检查Cookie是否过期\n8. **排序说明**: ↓表示从高到低，↑表示从低到高","operationId":"fetch_item_list_api_v1_douyin_creator_v2_fetch_item_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemListRequest","description":"投稿作品列表请求参数/Item list request parameters"},"example":{"cookie":"Your_Cookie_Here","start_time":1758988800000,"end_time":1760198399000,"count":10,"order_by":1,"fields":"metrics,review,visibility","need_cooperation":true,"need_long_article":true}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_item_list_download":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"导出投稿作品列表/Download item list","description":"# [中文]\n### 用途:\n- 导出指定时间范围内前1000条投稿作品的详细数据\n- 支持按体裁类型筛选导出内容\n- **此接口用于批量导出数据，不适合实时查询**\n- **导出任务为异步处理，需要等待服务器生成文件**\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- min_cursor: 最小游标，即开始时间戳（毫秒）（必填）\n- max_cursor: 最大游标，即结束时间戳（毫秒）（必填）\n- type_filters: 体裁类型过滤列表，默认全选 [1,2,3,4,5,8]（可选）\n  - **1**: 1分钟以内视频\n  - **2**: 1-3分钟视频\n  - **3**: 3-5分钟视频\n  - **4**: 5分钟以上视频\n  - **5**: 图文作品\n  - **8**: 长图文作品\n- need_long_article: 是否包含长图文，默认true（可选）\n\n### 返回:\n- **直接返回Excel文件流**，浏览器会自动下载\n- 文件名：作品列表导出.xlsx\n- 文件格式：Excel (.xlsx)\n- Content-Type: application/vnd.ms-excel\n\n### 使用流程:\n1. **发起导出请求**：提交时间范围和筛选条件\n2. **接收文件**：接口会直接返回Excel文件流\n3. **自动下载**：浏览器会自动触发文件下载\n4. **数据分析**：打开Excel文件进行数据分析\n\n### 功能限制:\n- 仅支持导出：所选周期内，前1000条作品的数据\n- 支持按体裁类型筛选（可选择1-6种体裁的任意组合）\n- 不支持实时查询，适合批量数据分析场景\n\n### 体裁类型说明:\n| 类型值 | 体裁名称 | 说明 | 使用场景 |\n|-------|---------|------|---------|\n| 1 | 1min以内视频 | 短视频 | 快速传播，高互动 |\n| 2 | 1-3min视频 | 中短视频 | 平衡内容与时长 |\n| 3 | 3-5min视频 | 中长视频 | 深度内容呈现 |\n| 4 | 5min+视频 | 长视频 | 专业内容，深度分析 |\n| 5 | 图文 | 图文作品 | 图片+文字形式 |\n| 8 | 长图文 | 长图文作品 | 深度图文内容 |\n\n### 导出数据包含:\n- 作品基本信息（ID、标题、发布时间等）\n- 流量指标（播放量、点赞量、评论量、分享量、收藏量）\n- 审核状态\n- 可见性设置\n- 其他创作者相关数据\n\n### 时间戳转换:\n- JavaScript: `new Date('2025-07-01').getTime()` -> 1719763200000\n- Python: `int(datetime(2025, 7, 1).timestamp() * 1000)` -> 1719763200000\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Export detailed data of top 1000 items within the specified time range\n- Support filtering export content by genre types\n- **This API is for batch export, not suitable for real-time queries**\n- **Export tasks are processed asynchronously, need to wait for server to generate file**\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- min_cursor: Min cursor, i.e., start timestamp in milliseconds (required)\n- max_cursor: Max cursor, i.e., end timestamp in milliseconds (required)\n- type_filters: Genre type filter list, default all [1,2,3,4,5,8] (optional)\n  - **1**: Videos under 1 minute\n  - **2**: 1-3 minute videos\n  - **3**: 3-5 minute videos\n  - **4**: Videos over 5 minutes\n  - **5**: Image posts\n  - **8**: Long image posts\n- need_long_article: Include long articles, default true (optional)\n\n### Return:\n- **Directly returns Excel file stream**, browser will auto-download\n- Filename: 作品列表导出.xlsx (Item List Export.xlsx)\n- File Format: Excel (.xlsx)\n- Content-Type: application/vnd.ms-excel\n\n### Usage Flow:\n1. **Initiate export request**: Submit time range and filter conditions\n2. **Receive file**: API returns Excel file stream directly\n3. **Auto download**: Browser automatically triggers file download\n4. **Data analysis**: Open Excel file for data analysis\n\n### Limitations:\n- Only supports exporting: Top 1000 items in selected period\n- Support filtering by genre types (can select any combination of 1-6 genres)\n- Not suitable for real-time queries, designed for batch data analysis\n\n### Genre Type Description:\n| Type | Genre Name | Description | Use Case |\n|------|-----------|-------------|----------|\n| 1 | <1min video | Short video | Fast spread, high engagement |\n| 2 | 1-3min video | Medium-short video | Balance content & duration |\n| 3 | 3-5min video | Medium-long video | Deep content presentation |\n| 4 | 5min+ video | Long video | Professional content, deep analysis |\n| 5 | Image post | Image post | Picture + text format |\n| 8 | Long image post | Long image post | Deep image-text content |\n\n### Export Data Includes:\n- Item basic info (ID, title, publish time, etc.)\n- Traffic metrics (views, likes, comments, shares, favorites)\n- Review status\n- Visibility settings\n- Other creator-related data\n\n### Timestamp Conversion:\n- JavaScript: `new Date('2025-07-01').getTime()` -> 1719763200000\n- Python: `int(datetime(2025, 7, 1).timestamp() * 1000)` -> 1719763200000\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n### 导出所有体裁/Export All Genres:\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"min_cursor\": 1752336000000,\n    \"max_cursor\": 1760198399000,\n    \"type_filters\": [1, 2, 3, 4, 5, 8],\n    \"need_long_article\": true\n}\n```\n\n### 仅导出视频作品/Export Only Videos:\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"min_cursor\": 1752336000000,\n    \"max_cursor\": 1760198399000,\n    \"type_filters\": [1, 2, 3, 4],\n    \"need_long_article\": false\n}\n```\n\n### 仅导出图文作品/Export Only Image Posts:\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"min_cursor\": 1752336000000,\n    \"max_cursor\": 1760198399000,\n    \"type_filters\": [5, 8],\n    \"need_long_article\": true\n}\n```\n\n### 返回数据说明/Response Description:\n- 此接口直接返回Excel文件流，不返回JSON数据\n- 响应头包含 `Content-Disposition: attachment; filename=\"作品列表导出.xlsx\"`\n- 浏览器会自动识别并触发文件下载\n- 文件内容为二进制流（application/vnd.ms-excel）\n\n### 使用方式示例/Usage Examples:\n\n**使用 cURL 下载:**\n```bash\ncurl -X POST \"https://your-api.com/api/v1/douyin_creator_v2/fetch_item_list_download\"       -H \"Authorization: Bearer YOUR_TOKEN\"       -H \"Content-Type: application/json\"       -d '{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"min_cursor\": 1752336000000,\n    \"max_cursor\": 1760198399000,\n    \"type_filters\": [1,2,3,4,5,8]\n  }'       -o \"作品列表导出.xlsx\"\n```\n\n**使用 Python requests:**\n```python\nimport requests\n\nresponse = requests.post(\n    \"https://your-api.com/api/v1/douyin_creator_v2/fetch_item_list_download\",\n    headers={\"Authorization\": \"Bearer YOUR_TOKEN\"},\n    json={\n        \"cookie\": \"Your_Cookie_Here\",\n        \"min_cursor\": 1752336000000,\n        \"max_cursor\": 1760198399000,\n        \"type_filters\": [1,2,3,4,5,8]\n    }\n)\n\n# 保存文件\nwith open(\"作品列表导出.xlsx\", \"wb\") as f:\n    f.write(response.content)\n```\n\n**使用 JavaScript (Axios):**\n```javascript\nconst axios = require('axios');\nconst fs = require('fs');\n\naxios.post('https://your-api.com/api/v1/douyin_creator_v2/fetch_item_list_download', {\n    cookie: 'Your_Cookie_Here',\n    min_cursor: 1752336000000,\n    max_cursor: 1760198399000,\n    type_filters: [1,2,3,4,5,8]\n}, {\n    headers: { 'Authorization': 'Bearer YOUR_TOKEN' },\n    responseType: 'arraybuffer'\n}).then(response => {\n    fs.writeFileSync('作品列表导出.xlsx', response.data);\n});\n```\n\n### 注意事项/Notes:\n1. **数据量限制**: 最多导出前1000条作品数据\n2. **即时生成**: 接口会立即生成Excel文件并返回，无需等待\n3. **时间范围**: 建议不要设置过长的时间范围，以免数据量过大导致超时\n4. **体裁筛选**: 可以根据分析需求选择特定体裁类型\n5. **文件格式**: Excel (.xlsx) 格式，兼容 Microsoft Excel、WPS、Google Sheets等\n6. **响应类型**: 返回二进制流，不是JSON，请使用正确的响应处理方式\n7. **Cookie有效性**: 如果返回错误，请检查Cookie是否过期\n8. **超时设置**: 建议设置较长的超时时间（60秒以上），因为需要生成文件\n9. **文件编码**: 文件名使用UTF-8编码，支持中文显示","operationId":"fetch_item_list_download_api_v1_douyin_creator_v2_fetch_item_list_download_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemListDownloadRequest","description":"投稿作品列表导出请求参数/Item list download request parameters"},"example":{"cookie":"Your_Cookie_Here","min_cursor":1752336000000,"max_cursor":1760198399000,"type_filters":[2,3,4,5,1,8],"need_long_article":true}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_live_room_history_list":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取直播场次历史记录/Fetch live room history list","description":"# [中文]\n### 用途:\n- 获取抖音创作者的直播场次历史记录\n- 查看指定时间范围内的所有直播场次数据\n- 支持查询正在进行的直播和历史直播记录\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n- start_date: 开始日期，格式为 YYYY-MM-DD（必填，例如: \"2025-09-11\"）\n- end_date: 结束日期，格式为 YYYY-MM-DD（必填，例如: \"2025-10-11\"）\n- limit: 每页数量限制，默认400，最多400条\n- need_living: 是否包含正在直播的场次（0=不包含, 1=包含，默认1）\n- download: 是否下载（0=不下载, 1=下载，默认0）\n\n### 返回数据说明:\n返回直播场次历史记录列表，数据位于 `data.data.series` 数组中，每个场次包含以下信息：\n\n**基本信息**:\n- roomID: 直播间ID\n- roomTitle: 直播标题\n- coverUri: 直播封面图片URL\n- startTime: 开始时间（格式: \"YYYY-MM-DD HH:mm:ss\"）\n- endTime: 结束时间（格式: \"YYYY-MM-DD HH:mm:ss\"）\n- liveDurationWithoutPause: 直播时长（不含暂停时间，格式如: \"1分钟5秒\"）\n- playStatus: 播放状态（4=已结束）\n\n**流量数据**:\n- watchCnt: 总观看人次\n- serverWatchUcntTdDirect: 直接观看用户数（来自服务端统计）\n- pcu: 峰值同时在线人数（Peak Concurrent Users）\n- liveServerWatchDurationTdPavg: 平均观看时长\n\n**互动数据**:\n- serverLikeCntTd: 点赞数\n- clientCommentUcntTd: 评论用户数\n- liveNewFollowUcnt: 新增关注数\n\n**消费/转化数据**:\n- liveConsumeUcnt: 消费用户数\n- liveFansConsumeUcntTd: 粉丝消费用户数\n- roomLiveEarnScore: 直播收益积分\n\n### 数据价值:\n- **历史回顾**: 查看所有直播场次的完整记录\n- **数据对比**: 对比不同场次的表现差异\n- **趋势分析**: 分析直播效果的变化趋势\n- **优化方向**: 找出高转化场次的共同特点\n- **时间规划**: 根据历史数据优化直播时间\n- **内容策略**: 根据不同主题的效果调整内容\n\n### 应用场景:\n1. **定期复盘**: 每周/每月查看直播数据进行总结\n2. **效果评估**: 评估不同时段、不同主题的直播效果\n3. **数据报表**: 生成直播数据报表供团队分析\n4. **策略优化**: 基于历史数据制定下一步直播策略\n5. **KPI追踪**: 追踪直播相关的关键指标完成情况\n6. **趋势预测**: 预测未来直播的潜在表现\n\n### 注意事项:\n1. **时间范围**: 建议查询时间不超过3个月，避免数据量过大\n2. **数量限制**: 单次最多返回400条记录\n3. **数据延迟**: 直播数据可能有1-2小时的延迟\n4. **正在直播**: 设置need_living=1可以查看当前正在进行的直播\n5. **Cookie有效性**: 确保Cookie未过期，否则无法获取数据\n6. **日期格式**: 必须使用YYYY-MM-DD格式，如2025-09-11\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get Douyin creator's live room history list\n- View all live session data within a specified time range\n- Support querying ongoing and historical live sessions\n- **This API requires users to provide valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie is transmitted in request body, more secure**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body)\n- start_date: Start date in YYYY-MM-DD format (required, e.g., \"2025-09-11\")\n- end_date: End date in YYYY-MM-DD format (required, e.g., \"2025-10-11\")\n- limit: Limit per page, default 400, max 400\n- need_living: Include ongoing live sessions (0=No, 1=Yes, default 1)\n- download: Download flag (0=No download, 1=Download, default 0)\n\n### Return Data Description:\nReturns a list of live session history, data is located in `data.data.series` array, each session includes:\n\n**Basic Info**:\n- roomID: Live room ID\n- roomTitle: Live title\n- coverUri: Live cover image URL\n- startTime: Start time (format: \"YYYY-MM-DD HH:mm:ss\")\n- endTime: End time (format: \"YYYY-MM-DD HH:mm:ss\")\n- liveDurationWithoutPause: Duration without pause (format: \"1 minute 5 seconds\")\n- playStatus: Play status (4=Ended)\n\n**Traffic Data**:\n- watchCnt: Total watch count\n- serverWatchUcntTdDirect: Direct watch user count (from server statistics)\n- pcu: Peak Concurrent Users\n- liveServerWatchDurationTdPavg: Average watch duration\n\n**Engagement Data**:\n- serverLikeCntTd: Likes count\n- clientCommentUcntTd: Comment user count\n- liveNewFollowUcnt: New followers count\n\n**Consumption/Conversion Data**:\n- liveConsumeUcnt: Consuming user count\n- liveFansConsumeUcntTd: Fan consuming user count\n- roomLiveEarnScore: Live room earn score\n\n### Data Value:\n- **History Review**: View complete records of all live sessions\n- **Data Comparison**: Compare performance across sessions\n- **Trend Analysis**: Analyze changes in live performance\n- **Optimization**: Identify common traits of high-conversion sessions\n- **Time Planning**: Optimize live timing based on historical data\n- **Content Strategy**: Adjust content based on theme performance\n\n### Use Cases:\n1. **Regular Review**: Weekly/monthly live data summary\n2. **Effect Evaluation**: Evaluate performance by time and theme\n3. **Data Reports**: Generate reports for team analysis\n4. **Strategy Optimization**: Develop strategies based on data\n5. **KPI Tracking**: Track live-related KPIs\n6. **Trend Prediction**: Predict future live performance\n\n### Notes:\n1. **Time Range**: Recommended not to exceed 3 months\n2. **Quantity Limit**: Max 400 records per request\n3. **Data Delay**: 1-2 hours delay possible\n4. **Ongoing Live**: Set need_living=1 to include current live\n5. **Cookie Validity**: Ensure Cookie is not expired\n6. **Date Format**: Must use YYYY-MM-DD format\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Find any request and copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\",\n    \"start_date\": \"2025-09-11\",\n    \"end_date\": \"2025-10-11\",\n    \"limit\": 400,\n    \"need_living\": 1,\n    \"download\": 0\n}\n```\n\n### 返回数据示例/Response Example:\n```json\n{\n    \"data\": {\n        \"code\": 0,\n        \"componentID\": \"\",\n        \"data\": {\n            \"series\": [\n                {\n                    \"clientCommentUcntTd\": \"0\",\n                    \"coverUri\": \"https://p3-webcast-sign.douyinpic.com/...\",\n                    \"endTime\": \"2025-11-20 13:52:20\",\n                    \"liveConsumeUcnt\": \"1\",\n                    \"liveDurationWithoutPause\": \"1分钟5秒\",\n                    \"liveFansConsumeUcntTd\": \"1\",\n                    \"liveNewFollowUcnt\": \"0\",\n                    \"liveServerWatchDurationTdPavg\": \"0.5666666666666667\",\n                    \"pcu\": \"1\",\n                    \"playStatus\": \"4\",\n                    \"roomID\": \"75746809889xxxxxx\",\n                    \"roomLiveEarnScore\": \"1\",\n                    \"roomTitle\": \"xxxxxxxx\",\n                    \"serverLikeCntTd\": \"0\",\n                    \"serverWatchUcntTdDirect\": \"1\",\n                    \"startTime\": \"2025-11-20 13:51:15\",\n                    \"watchCnt\": \"1\"\n                }\n            ]\n        },\n        \"meta\": \"\"\n    }\n}\n```\n\n### 数据解读/Data Interpretation:\n- **watchCnt**: 总观看人次，反映直播的曝光度和吸引力\n- **pcu**: 峰值同时在线人数（Peak Concurrent Users），反映直播的热度峰值\n- **liveServerWatchDurationTdPavg**: 平均观看时长，反映内容的吸引力\n- **liveNewFollowUcnt**: 新增关注数，反映直播的转粉效果\n- **roomLiveEarnScore**: 直播收益积分，反映直播的收益能力\n- **liveConsumeUcnt/liveFansConsumeUcntTd**: 消费用户数/粉丝消费用户数，反映直播的转化能力\n- **互动率**: (serverLikeCntTd+clientCommentUcntTd)/watchCnt，反映用户活跃度\n\n### 优化建议/Optimization Suggestions:\n1. **高峰分析**: 分析pcu最高出现的时间点，强化该时段的内容\n2. **留存优化**: 提升liveServerWatchDurationTdPavg平均观看时长，增加内容的连贯性和吸引力\n3. **互动引导**: 在直播中增加互动环节，提升serverLikeCntTd点赞数、clientCommentUcntTd评论数\n4. **转粉策略**: 在直播中适时引导关注，提升liveNewFollowUcnt新增关注数\n5. **消费转化**: 分析高roomLiveEarnScore场次的特点，优化直播策略\n6. **时间选择**: 根据历史数据选择watchCnt观看人次最多的时段开播","operationId":"fetch_live_room_history_list_api_v1_douyin_creator_v2_fetch_live_room_history_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiveRoomHistoryListRequest","description":"直播场次历史记录请求参数/Live room history list request parameters"},"example":{"cookie":"Your_Cookie_Here","start_date":"2025-09-11","end_date":"2025-10-11","limit":400,"need_living":1,"download":0}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/creator_v2/fetch_author_diagnosis":{"post":{"tags":["Douyin-Creator-V2-API"],"summary":"获取创作者账号诊断/Fetch author diagnosis","description":"# [中文]\n### 用途:\n- 获取抖音创作者账号的诊断数据和优化建议\n- 自动分析最近一周（从当天起往前7天）的账号表现\n- 提供完播率、互动指数等关键指标的评估和改进建议\n- 帮助创作者了解账号健康度，优化内容策略\n- **此接口需要用户提供有效的抖音创作者平台Cookie**\n- **使用 POST 方法，Cookie 在请求体中传输，更安全**\n- **无需指定时间范围，系统自动获取最近7天数据**\n\n### 请求体参数:\n- cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）\n\n### 数据更新时间:\n- **更新周期**: 次日12点更新昨日作品数据\n- **示例**: 2025年10月10日的作品数据会在2025年10月11日12点更新\n- **时间范围**: 自动获取最近一周的数据（从当天起往前7天）\n- **首次使用**: 获取权限后次日起生产数据\n\n### 数据指标含义:\n\n**名词定义**:\n- **同类创作者**: 具有相似创作领域或粉丝量级的创作者\n- **时间粒度**: 时间粒度是数据更新计算的周期\n- **抖音精选**: 包含精选APP+抖音电脑端+抖音APP_精选Tab的数据表现\n\n**账号诊断类指标**:\n- **投稿数**: 根据统计周期内发布的作品个数得出\n- **互动指数**: 作品的观看、点赞、评论、转发的综合得分\n- **视频播放量**: 作品被观看的次数\n- **视频完播率**: 作品完整播放次数的占比\n  - 每日完播率：当日完播浏览量与总浏览量的比值\n  - 每十分钟级完播率：累计完播浏览量与累计浏览量的比值\n- **粉丝净增量**: 账号净增粉丝数，通过涨粉数减去掉粉数得出\n\n### 返回数据说明:\n返回账号诊断数据，包括以下五个核心维度：\n\n**1. 互动指数 (Interact)**:\n- **OwnValue**: 账号自身的互动指数值（观看、点赞、评论、转发的综合得分）\n- **SimilarCount**: 同类创作者总数\n- **AuthorRank**: 账号在自身历史数据中的排名百分位（0-1之间，越大表示当前表现越好）\n- **SimilarRank**: 账号在同类创作者中的排名百分位（0-1之间，越大表示排名越靠前）\n- **SimilarValue**: 同类创作者的平均互动指数值\n- **解读**: AuthorRank=0.26表示当前互动指数超过了自己历史26%的时期\n- **解读**: SimilarRank=0.52表示在同类创作者中排名超过52%\n\n**2. 粉丝净增量 (NewFans)**:\n- **OwnValue**: 统计周期内账号净增粉丝数（涨粉数 - 掉粉数）\n- **SimilarCount**: 同类创作者总数\n- **AuthorRank**: 账号在自身历史涨粉数据中的排名百分位\n- **SimilarRank**: 账号在同类创作者中的涨粉排名百分位\n- **SimilarValue**: 同类创作者的平均粉丝净增量\n- **解读**: OwnValue=2表示本周期净增2个粉丝\n\n**3. 视频播放量 (PlayCnt)**:\n- **OwnValue**: 统计周期内作品被观看的总次数\n- **SimilarCount**: 同类创作者总数\n- **AuthorRank**: 账号在自身历史播放量中的排名百分位\n- **SimilarRank**: 账号在同类创作者中的播放量排名百分位\n- **SimilarValue**: 同类创作者的平均播放量\n- **解读**: OwnValue=192表示本周期总播放量为192次\n\n**4. 视频完播率 (PlayFinishRatio)**:\n- **OwnValue**: 作品完整播放次数的占比（0-1之间的小数）\n- **SimilarCount**: 同类创作者总数\n- **AuthorRank**: 账号在自身历史完播率中的排名百分位\n- **SimilarRank**: 账号在同类创作者中的完播率排名百分位\n- **SimilarValue**: 同类创作者的平均完播率\n- **解读**: OwnValue=0.15表示完播率为15%\n- **提升建议**: \"想要作品吸引人，前3秒钟是关键，可以多分析同行业热门作品的人设、镜头技巧和音乐\"\n\n**5. 投稿活跃度 (PublishActivation)**:\n- **OwnValue**: 统计周期内发布的作品个数\n- **SimilarCount**: 同类创作者总数\n- **AuthorRank**: 账号在自身历史投稿数据中的排名百分位\n- **SimilarRank**: 账号在同类创作者中的投稿活跃度排名百分位\n- **SimilarValue**: 同类创作者的平均投稿数\n- **解读**: OwnValue=2表示本周期发布了2个作品\n\n### 返回数据结构示例:\n```json\n{\n    \"code\": 0,\n    \"data\": {\n        \"Interact\": {\n            \"OwnValue\": 0.0052,\n            \"SimilarCount\": 1494654282,\n            \"AuthorRank\": 0.2633,\n            \"SimilarRank\": 0.5169,\n            \"SimilarValue\": 0.0909\n        },\n        \"NewFans\": {\n            \"OwnValue\": 2,\n            \"AuthorRank\": 0.7924,\n            \"SimilarRank\": 0.6343\n        },\n        \"PlayCnt\": {\n            \"OwnValue\": 192,\n            \"AuthorRank\": 0.8427,\n            \"SimilarRank\": 0.5132\n        },\n        \"PlayFinishRatio\": {\n            \"OwnValue\": 0.1545,\n            \"AuthorRank\": 0.3851,\n            \"SimilarRank\": 0.5086\n        },\n        \"PublishActivation\": {\n            \"OwnValue\": 2,\n            \"AuthorRank\": 0.7345,\n            \"SimilarRank\": 0.5675\n        }\n    }\n}\n```\n\n### 数据解读技巧:\n- **OwnValue**: 查看实际数值，了解账号当前表现\n- **AuthorRank**: 与自己过去比较，数值越高说明当前状态越好\n- **SimilarRank**: 与同行比较，数值越高说明在同类创作者中排名越靠前\n- **建议**: AuthorRank和SimilarRank都低于0.5时需要重点优化该项指标\n\n### Cookie 获取方式:\n1. 登录抖音创作者平台 (https://creator.douyin.com)\n2. 打开浏览器开发者工具（F12）\n3. 切换到 Network 标签\n4. 刷新页面或进行操作\n5. 找到任意请求，复制 Cookie 请求头的值\n\n# [English]\n### Purpose:\n- Get Douyin creator account diagnosis data and optimization suggestions\n- Automatically analyze account performance for the past 7 days\n- Provide assessment and improvement suggestions for key metrics\n- Help creators understand account health and optimize content strategy\n- **This API requires valid Douyin Creator Platform Cookie**\n- **Use POST method, Cookie transmitted in request body, more secure**\n- **No need to specify time range, system automatically fetches data for past 7 days**\n\n### Request Body Parameters:\n- cookie: User's Douyin Creator Platform Cookie (required)\n\n### Data Update Time:\n- **Update Cycle**: Yesterday's video data is updated at 12:00 noon the next day\n- **Example**: Video data from October 10, 2025 will be updated at 12:00 on October 11, 2025\n- **Time Range**: Automatically fetches data for the past 7 days\n- **First Use**: Data generation starts from the next day after obtaining permission\n\n### Data Metrics Definition:\n\n**Term Definitions**:\n- **Similar Creators**: Creators with similar creation fields or fan levels\n- **Time Granularity**: The period for data update calculations\n- **Douyin Featured**: Data performance including Featured APP + Douyin Desktop + Douyin APP Featured Tab\n\n**Account Diagnosis Metrics**:\n- **Submission Count**: Number of works published during the statistical period\n- **Engagement Index**: Comprehensive score of views, likes, comments, and shares\n- **Video Views**: Number of times the work has been viewed\n- **Video Completion Rate**: Proportion of complete playbacks\n  - Daily completion rate: Ratio of daily complete views to total views\n  - 10-minute completion rate: Ratio of cumulative complete views to cumulative views\n- **Net Fan Growth**: Net increase in account followers (new followers minus unfollowers)\n\n### Return Data Description:\nAccount diagnosis data including five core dimensions:\n\n**1. Engagement Index (Interact)**:\n- **OwnValue**: Account's own engagement index value (comprehensive score of views, likes, comments, shares)\n- **SimilarCount**: Total number of similar creators\n- **AuthorRank**: Ranking percentile in account's historical data (0-1, higher means better current performance)\n- **SimilarRank**: Ranking percentile among similar creators (0-1, higher means better ranking)\n- **SimilarValue**: Average engagement index value of similar creators\n- **Interpretation**: AuthorRank=0.26 means current engagement exceeds 26% of own history\n- **Interpretation**: SimilarRank=0.52 means ranking exceeds 52% of similar creators\n\n**2. Net Fan Growth (NewFans)**:\n- **OwnValue**: Net increase in followers during the period (new followers - unfollowers)\n- **SimilarCount**: Total number of similar creators\n- **AuthorRank**: Ranking percentile in account's historical fan growth data\n- **SimilarRank**: Fan growth ranking percentile among similar creators\n- **SimilarValue**: Average net fan growth of similar creators\n- **Interpretation**: OwnValue=2 means net gain of 2 followers in this period\n\n**3. Video Views (PlayCnt)**:\n- **OwnValue**: Total number of times works were viewed during the period\n- **SimilarCount**: Total number of similar creators\n- **AuthorRank**: Ranking percentile in account's historical view count\n- **SimilarRank**: View count ranking percentile among similar creators\n- **SimilarValue**: Average view count of similar creators\n- **Interpretation**: OwnValue=192 means total views of 192 in this period\n\n**4. Video Completion Rate (PlayFinishRatio)**:\n- **OwnValue**: Proportion of complete playbacks (decimal between 0-1)\n- **SimilarCount**: Total number of similar creators\n- **AuthorRank**: Ranking percentile in account's historical completion rate\n- **SimilarRank**: Completion rate ranking percentile among similar creators\n- **SimilarValue**: Average completion rate of similar creators\n- **Interpretation**: OwnValue=0.15 means 15% completion rate\n- **Tip**: Focus on first 3 seconds to improve retention\n\n**5. Publishing Activity (PublishActivation)**:\n- **OwnValue**: Number of works published during the period\n- **SimilarCount**: Total number of similar creators\n- **AuthorRank**: Ranking percentile in account's historical publishing data\n- **SimilarRank**: Publishing activity ranking percentile among similar creators\n- **SimilarValue**: Average number of submissions by similar creators\n- **Interpretation**: OwnValue=2 means published 2 works in this period\n\n### Return Data Structure Example:\n```json\n{\n    \"code\": 0,\n    \"data\": {\n        \"Interact\": {\n            \"OwnValue\": 0.0052,\n            \"SimilarCount\": 1494654282,\n            \"AuthorRank\": 0.2633,\n            \"SimilarRank\": 0.5169,\n            \"SimilarValue\": 0.0909\n        },\n        \"NewFans\": {\n            \"OwnValue\": 2,\n            \"AuthorRank\": 0.7924,\n            \"SimilarRank\": 0.6343\n        },\n        \"PlayCnt\": {\n            \"OwnValue\": 192,\n            \"AuthorRank\": 0.8427,\n            \"SimilarRank\": 0.5132\n        },\n        \"PlayFinishRatio\": {\n            \"OwnValue\": 0.1545,\n            \"AuthorRank\": 0.3851,\n            \"SimilarRank\": 0.5086\n        },\n        \"PublishActivation\": {\n            \"OwnValue\": 2,\n            \"AuthorRank\": 0.7345,\n            \"SimilarRank\": 0.5675\n        }\n    }\n}\n```\n\n### Data Interpretation Tips:\n- **OwnValue**: Check actual values to understand current account performance\n- **AuthorRank**: Compare with own past, higher value means better current status\n- **SimilarRank**: Compare with peers, higher value means better ranking among similar creators\n- **Recommendation**: Focus on optimizing metrics when both AuthorRank and SimilarRank are below 0.5\n\n### How to get Cookie:\n1. Login to Douyin Creator Platform (https://creator.douyin.com)\n2. Open browser developer tools (F12)\n3. Switch to Network tab\n4. Refresh page or perform operations\n5. Copy the Cookie header value\n\n# [示例/Example]\n```json\n{\n    \"cookie\": \"Your_Cookie_Here\"\n}\n```","operationId":"fetch_author_diagnosis_api_v1_douyin_creator_v2_fetch_author_diagnosis_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorDiagnosisRequest","description":"创作者账号诊断请求参数/Author diagnosis request parameters"},"example":{"cookie":"Your_Cookie_Here"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_general_search_v1":{"post":{"tags":["Douyin-Search-API"],"summary":"获取综合搜索 V1/Fetch general search V1","description":"# [中文]\n### 用途:\n- 获取抖音 App 中综合搜索栏的搜索结果（非单独视频搜索）。\n- 支持关键词、排序方式、发布时间、视频时长、内容类型等筛选条件。\n- 支持翻页查询，通过 `cursor`、`search_id` 和 `backtrace` 分页。\n\n### 备注:\n- 初次请求时 `cursor` 传入 0，`search_id` 和 `backtrace` 传空字符串。\n- 翻页时需从上一次响应中获取 `cursor`、`search_id` 和 `backtrace` 字段值。\n- 返回的内容包含视频、作者、话题标签、播放信息、音乐、互动数据等丰富信息。\n\n### 参数:\n- keyword: 搜索关键词，如 \"猫咪\"\n- cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）\n- sort_type: 排序方式\n    - `0`: 综合排序\n    - `1`: 最多点赞\n    - `2`: 最新发布\n- publish_time: 发布时间筛选\n    - `0`: 不限\n    - `1`: 最近一天\n    - `7`: 最近一周\n    - `180`: 最近半年\n- filter_duration: 视频时长筛选\n    - `0`: 不限\n    - `0-1`: 1 分钟以内\n    - `1-5`: 1-5 分钟\n    - `5-10000`: 5 分钟以上\n- content_type: 内容类型筛选\n    - `0`: 不限\n    - `1`: 视频\n    - `2`: 图片\n    - `3`: 文章\n- search_id: 搜索ID（首次请求传空，翻页时从上次响应获取）\n- backtrace: 翻页回溯标识（首次请求传空，翻页时从上次响应获取）\n\n### 请求体示例：\n```json\npayload = {\n  \"keyword\": \"猫咪\",\n  \"cursor\": 0,\n  \"sort_type\": \"0\",\n  \"publish_time\": \"0\",\n  \"filter_duration\": \"0\",\n  \"content_type\": \"0\",\n  \"search_id\": \"\",\n  \"backtrace\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `data`: 搜索结果列表\n- `type`: 结果类型（通常为 `1`）\n- `aweme_info`: 视频详细信息\n- `aweme_id`: 视频ID\n- `desc`: 视频描述内容\n- `author`: 作者信息\n  - `uid`: 用户唯一ID\n  - `nickname`: 用户昵称\n  - `is_verified`: 是否认证用户（True=已认证，False=未认证）\n  - `region`: 用户地区，如 \"CN\"\n  - `avatar_thumb.url_list`: 缩略头像地址列表\n  - `avatar_medium.url_list`: 中等尺寸头像地址列表\n  - `avatar_larger.url_list`: 高清头像地址列表\n- `music`: 背景音乐信息\n  - `id_str`: 音乐ID\n  - `title`: 音乐标题，如\"原创声音\"\n  - `author`: 音乐作者昵称\n  - `play_url.url_list`: 音乐播放地址列表\n- `cha_list`: 关联话题标签列表\n  - `cha_name`: 话题名（例如 \"#猫宝宝\"）\n  - `share_url`: 话题分享链接\n- `video`: 视频播放与封面信息\n  - `play_addr.url_list`: 视频播放地址列表\n  - `cover.url_list`: 视频封面地址列表\n  - `dynamic_cover.url_list`: 动态封面地址列表\n  - `origin_cover.url_list`: 原始封面地址列表\n  - `width`: 视频宽度（像素）\n  - `height`: 视频高度（像素）\n  - `ratio`: 视频分辨率比例（如540p）\n  - `duration`: 视频时长（单位：毫秒）\n  - `download_addr.url_list`: 带水印下载地址\n- `statistics`: 视频统计信息\n  - `comment_count`: 评论数\n  - `digg_count`: 点赞数\n  - `share_count`: 分享数\n  - `play_count`: 播放次数\n  - `collect_count`: 收藏次数\n- `status`: 视频发布状态\n  - `is_delete`: 是否被删除\n  - `is_private`: 是否设为私密\n  - `allow_share`: 是否允许分享\n  - `allow_comment`: 是否允许评论\n- `share_url`: 视频外部分享链接\n\n# [English]\n### Purpose:\n- Fetch search results from Douyin App's general search tab (not standalone video search).\n- Supports filtering by keyword, sort type, publish time, video duration, and content type.\n- Supports pagination through `cursor`, `search_id`, and `backtrace`.\n\n### Notes:\n- Set `cursor` to 0, `search_id` and `backtrace` to empty strings for the first request.\n- For pagination, obtain `cursor`, `search_id`, and `backtrace` values from the previous response.\n- The response contains rich information including video details, author info, music, hashtags, playback info, and interaction metrics.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"cat\"\n- cursor: Pagination cursor (0 for the first page, use the last response cursor for subsequent pages)\n- sort_type: Sorting method\n    - `0`: Comprehensive\n    - `1`: Most likes\n    - `2`: Latest\n- publish_time: Publish time filter\n    - `0`: Unlimited\n    - `1`: Last day\n    - `7`: Last week\n    - `180`: Last half year\n- filter_duration: Video duration filter\n    - `0`: Unlimited\n    - `0-1`: Within 1 minute\n    - `1-5`: 1 to 5 minutes\n    - `5-10000`: More than 5 minutes\n- content_type: Content type filter\n    - `0`: Unlimited\n    - `1`: Video\n    - `2`: Picture\n    - `3`: Article\n- search_id: Search ID (empty for first request, obtained from previous response for pagination)\n- backtrace: Backtrace identifier (empty for first request, obtained from previous response for pagination)\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"cat\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\",\n    \"backtrace\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `data`: List of search result items\n- `type`: Result type (usually `1`)\n- `aweme_info`: Video detailed information\n- `aweme_id`: Video ID\n- `desc`: Video description\n- `author`:\n  - `uid`: Author's user ID\n  - `nickname`: Author's nickname\n  - `is_verified`: Whether the author is verified\n  - `region`: Author's region\n  - `avatar_thumb.url_list`: List of thumbnail avatar URLs\n  - `avatar_medium.url_list`: List of medium size avatar URLs\n  - `avatar_larger.url_list`: List of large size avatar URLs\n- `music`:\n  - `id_str`: Music ID\n  - `title`: Music title\n  - `author`: Music creator's name\n  - `play_url.url_list`: List of music play URLs\n- `cha_list`:\n  - `cha_name`: Hashtag name\n  - `share_url`: Hashtag share URL\n- `video`:\n  - `play_addr.url_list`: List of video play URLs\n  - `cover.url_list`: List of cover image URLs\n  - `dynamic_cover.url_list`: List of dynamic cover URLs\n  - `origin_cover.url_list`: List of original cover URLs\n  - `width`: Video width (pixels)\n  - `height`: Video height (pixels)\n  - `ratio`: Resolution ratio (e.g., 540p)\n  - `duration`: Duration in milliseconds\n  - `download_addr.url_list`: List of video download URLs\n- `statistics`:\n  - `comment_count`: Number of comments\n  - `digg_count`: Number of likes\n  - `share_count`: Number of shares\n  - `play_count`: Number of plays\n  - `collect_count`: Number of collects\n- `status`:\n  - `is_delete`: Whether the video is deleted\n  - `is_private`: Whether the video is private\n  - `allow_share`: Whether sharing is allowed\n  - `allow_comment`: Whether commenting is allowed\n- `share_url`: External share link","operationId":"fetch_general_search_v1_api_v1_douyin_search_fetch_general_search_v1_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSearchV1Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_general_search_v2":{"post":{"tags":["Douyin-Search-API"],"summary":"获取综合搜索 V2/Fetch general search V2","description":"# [中文]\n### 用途:\n- 获取抖音 App 中综合搜索栏的搜索结果（非单独视频搜索）。\n- 此接口稳定性可能不如 V1版本，作为备用接口。\n- 支持关键词、排序方式、发布时间、视频时长、内容类型等筛选条件。\n- 支持翻页查询，通过 `cursor`、`search_id` 和 `backtrace` 分页。\n\n### 备注:\n- 初次请求时 `cursor` 传入 0，`search_id` 和 `backtrace` 传空字符串。\n- 翻页时需从上一次响应中获取 `cursor`、`search_id` 和 `backtrace` 字段值。\n- 返回的内容包含视频、作者、话题标签、播放信息、音乐、互动数据等丰富信息。\n\n### 参数:\n- keyword: 搜索关键词，如 \"猫咪\"\n- cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）\n- sort_type: 排序方式\n    - `0`: 综合排序\n    - `1`: 最多点赞\n    - `2`: 最新发布\n- publish_time: 发布时间筛选\n    - `0`: 不限\n    - `1`: 最近一天\n    - `7`: 最近一周\n    - `180`: 最近半年\n- filter_duration: 视频时长筛选\n    - `0`: 不限\n    - `0-1`: 1 分钟以内\n    - `1-5`: 1-5 分钟\n    - `5-10000`: 5 分钟以上\n- content_type: 内容类型筛选\n    - `0`: 不限\n    - `1`: 视频\n    - `2`: 图片\n    - `3`: 文章\n- search_id: 搜索ID（首次请求传空，翻页时从上次响应获取）\n- backtrace: 翻页回溯标识（首次请求传空，翻页时从上次响应获取）\n\n### 请求体示例：\n```json\npayload = {\n  \"keyword\": \"猫咪\",\n  \"cursor\": 0,\n  \"sort_type\": \"0\",\n  \"publish_time\": \"0\",\n  \"filter_duration\": \"0\",\n  \"content_type\": \"0\",\n  \"search_id\": \"\",\n  \"backtrace\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `data`: 搜索结果列表\n- `type`: 结果类型（通常为 `1`）\n- `aweme_info`: 视频详细信息\n- `aweme_id`: 视频ID\n- `desc`: 视频描述内容\n- `author`: 作者信息\n  - `uid`: 用户唯一ID\n  - `nickname`: 用户昵称\n  - `is_verified`: 是否认证用户（True=已认证，False=未认证）\n  - `region`: 用户地区，如 \"CN\"\n  - `avatar_thumb.url_list`: 缩略头像地址列表\n  - `avatar_medium.url_list`: 中等尺寸头像地址列表\n  - `avatar_larger.url_list`: 高清头像地址列表\n- `music`: 背景音乐信息\n  - `id_str`: 音乐ID\n  - `title`: 音乐标题，如\"原创声音\"\n  - `author`: 音乐作者昵称\n  - `play_url.url_list`: 音乐播放地址列表\n- `cha_list`: 关联话题标签列表\n  - `cha_name`: 话题名（例如 \"#猫宝宝\"）\n  - `share_url`: 话题分享链接\n- `video`: 视频播放与封面信息\n  - `play_addr.url_list`: 视频播放地址列表\n  - `cover.url_list`: 视频封面地址列表\n  - `dynamic_cover.url_list`: 动态封面地址列表\n  - `origin_cover.url_list`: 原始封面地址列表\n  - `width`: 视频宽度（像素）\n  - `height`: 视频高度（像素）\n  - `ratio`: 视频分辨率比例（如540p）\n  - `duration`: 视频时长（单位：毫秒）\n  - `download_addr.url_list`: 带水印下载地址\n- `statistics`: 视频统计信息\n  - `comment_count`: 评论数\n  - `digg_count`: 点赞数\n  - `share_count`: 分享数\n  - `play_count`: 播放次数\n  - `collect_count`: 收藏次数\n- `status`: 视频发布状态\n  - `is_delete`: 是否被删除\n  - `is_private`: 是否设为私密\n  - `allow_share`: 是否允许分享\n  - `allow_comment`: 是否允许评论\n- `share_url`: 视频外部分享链接\n\n# [English]\n### Purpose:\n- Fetch search results from Douyin App's general search tab (not standalone video search).\n- This API may be less stable than V1, serving as a backup.\n- Supports filtering by keyword, sort type, publish time, video duration, and content type.\n- Supports pagination through `cursor`, `search_id`, and `backtrace`.\n\n### Notes:\n- Set `cursor` to 0, `search_id` and `backtrace` to empty strings for the first request.\n- For pagination, obtain `cursor`, `search_id`, and `backtrace` values from the previous response.\n- The response contains rich information including video details, author info, music, hashtags, playback info, and interaction metrics.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"cat\"\n- cursor: Pagination cursor (0 for the first page, use the last response cursor for subsequent pages)\n- sort_type: Sorting method\n    - `0`: Comprehensive\n    - `1`: Most likes\n    - `2`: Latest\n- publish_time: Publish time filter\n    - `0`: Unlimited\n    - `1`: Last day\n    - `7`: Last week\n    - `180`: Last half year\n- filter_duration: Video duration filter\n    - `0`: Unlimited\n    - `0-1`: Within 1 minute\n    - `1-5`: 1 to 5 minutes\n    - `5-10000`: More than 5 minutes\n- content_type: Content type filter\n    - `0`: Unlimited\n    - `1`: Video\n    - `2`: Picture\n    - `3`: Article\n- search_id: Search ID (empty for first request, obtained from previous response for pagination)\n- backtrace: Backtrace identifier (empty for first request, obtained from previous response for pagination)\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"cat\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\",\n    \"backtrace\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `data`: List of search result items\n- `type`: Result type (usually `1`)\n- `aweme_info`: Video detailed information\n- `aweme_id`: Video ID\n- `desc`: Video description\n- `author`:\n  - `uid`: Author's user ID\n  - `nickname`: Author's nickname\n  - `is_verified`: Whether the author is verified\n  - `region`: Author's region\n  - `avatar_thumb.url_list`: List of thumbnail avatar URLs\n  - `avatar_medium.url_list`: List of medium size avatar URLs\n  - `avatar_larger.url_list`: List of large size avatar URLs\n- `music`:\n  - `id_str`: Music ID\n  - `title`: Music title\n  - `author`: Music creator's name\n  - `play_url.url_list`: List of music play URLs\n- `cha_list`:\n  - `cha_name`: Hashtag name\n  - `share_url`: Hashtag share URL\n- `video`:\n  - `play_addr.url_list`: List of video play URLs\n  - `cover.url_list`: List of cover image URLs\n  - `dynamic_cover.url_list`: List of dynamic cover URLs\n  - `origin_cover.url_list`: List of original cover URLs\n  - `width`: Video width (pixels)\n  - `height`: Video height (pixels)\n  - `ratio`: Resolution ratio (e.g., 540p)\n  - `duration`: Duration in milliseconds\n  - `download_addr.url_list`: List of video download URLs\n- `statistics`:\n  - `comment_count`: Number of comments\n  - `digg_count`: Number of likes\n  - `share_count`: Number of shares\n  - `play_count`: Number of plays\n  - `collect_count`: Number of collects\n- `status`:\n  - `is_delete`: Whether the video is deleted\n  - `is_private`: Whether the video is private\n  - `allow_share`: Whether sharing is allowed\n  - `allow_comment`: Whether commenting is allowed\n- `share_url`: External share link","operationId":"fetch_general_search_v2_api_v1_douyin_search_fetch_general_search_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSearchV2Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_search_suggest":{"post":{"tags":["Douyin-Search-API"],"summary":"获取搜索关键词推荐/Fetch search keyword suggestions","description":"# [中文]\n### 用途:\n- 获取抖音 App 中搜索关键词的联想推荐结果。\n- 根据用户输入的关键词，返回相关搜索词建议，用于提升搜索体验。\n\n### 备注:\n- 通常用于实现搜索框实时推荐（如输入时下拉补全）。\n- 返回的推荐词经过抖音推荐系统内部打分排序。\n\n### 参数:\n- keyword: 输入的关键词，如 \"人工智能\"\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"人工智能\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `status_code`: 状态码（0 表示成功）\n- `status_msg`: 返回信息（一般为空）\n- `rid`: 请求ID\n- `sug_list[]`: 搜索建议列表\n  - `content`: 推荐的搜索关键词（如 \"人工智能ai软件免费版下载\"）\n  - `sug_type`: 建议类型（一般为空，预留字段）\n  - `pos[]`: 匹配位置（标记关键词在原搜索词中的起止位置）\n    - `begin`: 开始字符位置\n    - `end`: 结束字符位置\n  - `word_record`:\n    - `group_id`: 推荐词组ID\n    - `words_position`: 在本次推荐列表中的位置\n    - `words_content`: 词内容（同 `content`）\n    - `words_source`: 词来源（通常为 \"sug\"）\n  - `extra_info`:\n    - `client_server_extra`: 附加配置信息（JSON字符串）\n    - `poi_id`: 关联POI ID（通常为空）\n    - `search_params`: 搜索参数（带内部推荐得分）\n- `words_query_record`:\n  - `info`: 附加信息（通常为空）\n  - `words_source`: 推荐来源\n  - `query_id`: 推荐查询ID\n- `extra`:\n  - `now`: 当前服务器时间戳（毫秒）\n  - `logid`: 日志ID\n  - `fatal_item_ids`: 错误项列表（通常为空）\n  - `search_request_id`: 搜索请求ID（通常为空）\n- `log_pb`:\n  - `impr_id`: 曝光日志ID\n- `time_cost`:\n  - `stream_inner`: 内部处理耗时（毫秒）\n  - `server_engine_cost`: 搜索引擎处理耗时（毫秒）\n- `cache_conf`:\n  - `enable`: 是否命中缓存（布尔值）\n\n# [English]\n### Purpose:\n- Fetch keyword suggestion results from Douyin App.\n- Based on the user's input, returns a list of recommended search keywords to improve search experience.\n\n### Notes:\n- Typically used for real-time keyword suggestions in the search box.\n- The returned suggestions are scored and sorted internally by Douyin's recommendation system.\n\n### Parameters:\n- keyword: Input keyword, e.g., \"Artificial Intelligence\"\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"Artificial Intelligence\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `status_code`: Status code (0 means success)\n- `status_msg`: Response message (usually empty)\n- `rid`: Request ID\n- `sug_list[]`: List of suggested search keywords\n  - `content`: Suggested keyword (e.g., \"AI software free download\")\n  - `sug_type`: Suggestion type (usually empty, reserved field)\n  - `pos[]`: Position marking\n    - `begin`: Begin character position\n    - `end`: End character position\n  - `word_record`:\n    - `group_id`: Suggestion group ID\n    - `words_position`: Position in the current suggestion list\n    - `words_content`: The word content (same as `content`)\n    - `words_source`: Word source (typically \"sug\")\n  - `extra_info`:\n    - `client_server_extra`: Extra client-server config (JSON string)\n    - `poi_id`: Related POI ID (usually empty)\n    - `search_params`: Search parameters (with recommendation scores)\n- `words_query_record`:\n  - `info`: Additional info (usually empty)\n  - `words_source`: Source of suggestions\n  - `query_id`: Suggestion query ID\n- `extra`:\n  - `now`: Current server timestamp (milliseconds)\n  - `logid`: Log ID\n  - `fatal_item_ids`: List of fatal error items (usually empty)\n  - `search_request_id`: Search request ID (usually empty)\n- `log_pb`:\n  - `impr_id`: Impression log ID\n- `time_cost`:\n  - `stream_inner`: Internal stream processing time (milliseconds)\n  - `server_engine_cost`: Server search engine processing time (milliseconds)\n- `cache_conf`:\n  - `enable`: Whether cache was hit (boolean)","operationId":"fetch_search_suggest_api_v1_douyin_search_fetch_search_suggest_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSuggestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_video_search_v1":{"post":{"tags":["Douyin-Search-API"],"summary":"获取视频搜索 V1/Fetch video search V1","description":"# [中文]\n### 用途:\n- 获取抖音 App 中通过关键词搜索到的视频内容。\n- 专注于视频内容的搜索结果，不包含其他类型。\n\n### 备注:\n- 初次请求时 `cursor` 传 0，`search_id` 传空字符串。\n- 返回的视频包含作者信息、播放地址、封面、互动数据等。\n- 同时返回一组关键词推荐 (`guide_search_words`) 用于引导用户继续搜索。\n\n### 参数:\n- keyword: 搜索关键词，例如 \"人工智能\"\n- cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）\n- sort_type: 排序方式\n    - `0`: 综合排序\n    - `1`: 最多点赞\n    - `2`: 最新发布\n- publish_time: 发布时间筛选\n    - `0`: 不限\n    - `1`: 最近一天\n    - `7`: 最近一周\n    - `180`: 最近半年\n- filter_duration: 视频时长筛选\n    - `0`: 不限\n    - `0-1`: 1 分钟以内\n    - `1-5`: 1-5 分钟\n    - `5-10000`: 5 分钟以上\n- content_type: 内容类型筛选\n    - `0`: 不限\n    - `1`: 视频\n    - `2`: 图片\n    - `3`: 文章\n- search_id: 搜索ID（分页时使用，从上一次响应获取）\n- backtrace: 翻页回溯标识（分页时使用，从上一次响应获取）\n\n#### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"人工智能\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\",\n    \"backtrace\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `status_code`: 响应状态码（0表示成功）\n- `cursor`: 下一页的游标\n- `has_more`: 是否还有更多数据（1=有，0=没有）\n- `data[]`: 搜索到的视频内容列表\n  - `type`: 结果类型（通常为 `1`）\n  - `aweme_info`: 视频详细信息\n    - 基本信息:\n      - `aweme_id`: 视频ID\n      - `desc`: 视频描述文字\n      - `create_time`: 发布时间（时间戳）\n    - 作者信息 (`author`):\n      - `uid`: 用户ID\n      - `nickname`: 昵称\n      - `is_verified`: 是否认证\n      - `region`: 地区，如 \"CN\"\n      - `avatar_thumb.url_list`: 缩略头像列表\n      - `follower_count`: 粉丝数\n      - `enterprise_verify_reason`: 企业认证信息（如\"央视新闻\"）\n    - 音乐信息 (`music`):\n      - `id_str`: 音乐ID\n      - `title`: 音乐标题\n      - `author`: 音乐作者\n      - `play_url.url_list`: 音乐播放链接\n    - 视频播放信息 (`video`):\n      - `play_addr.url_list`: 视频播放地址（高清）\n      - `cover.url_list`: 视频封面\n      - `dynamic_cover.url_list`: 动态封面\n      - `origin_cover.url_list`: 原始封面\n      - `ratio`: 视频分辨率，如 \"720p\"\n      - `duration`: 视频时长（单位：毫秒）\n      - `bit_rate[]`: 不同清晰度播放源\n        - `gear_name`: 清晰度名称（如\"540_2_2\"）\n        - `bit_rate`: 比特率\n        - `play_addr.url_list`: 对应播放地址\n    - 互动数据 (`statistics`):\n      - `comment_count`: 评论数\n      - `digg_count`: 点赞数\n      - `share_count`: 分享数\n      - `play_count`: 播放次数\n    - 视频状态 (`status`):\n      - `is_delete`: 是否删除\n      - `is_private`: 是否私密\n      - `allow_share`: 是否允许分享\n      - `allow_comment`: 是否允许评论\n    - 其他字段:\n      - `share_url`: 视频分享外链\n      - `user_digged`: 用户是否点赞（0=未点赞，1=已点赞）\n\n- `guide_search_words[]`: 推荐的搜索关键词\n  - `id`: 推荐词ID\n  - `word`: 推荐的关键词内容\n  - `type`: 推荐类型（通常为 `recom`）\n  - `query_id`: 推荐请求ID\n\n- `extra`:\n  - `now`: 当前服务器时间戳（毫秒）\n  - `logid`: 日志ID\n\n# [English]\n### Purpose:\n- Fetch video content search results from Douyin App based on a keyword.\n- This API is focused on video search results only.\n\n### Notes:\n- Set `cursor` to 0 and `search_id` to an empty string for the first request.\n- Each returned video includes rich details: author, video info, music, statistics, etc.\n- Also returns a set of suggested keywords (`guide_search_words`) for user guidance.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"Artificial Intelligence\"\n- cursor: Pagination cursor (0 for the first page, use the last response cursor for subsequent pages)\n- sort_type: Sorting method\n    - `0`: Comprehensive\n    - `1`: Most likes\n    - `2`: Latest\n- publish_time: Publish time filter\n    - `0`: Unlimited\n    - `1`: Last day\n    - `7`: Last week\n    - `180`: Last half year\n- filter_duration: Video duration filter\n    - `0`: Unlimited\n    - `0-1`: Within 1 minute\n    - `1-5`: 1 to 5 minutes\n    - `5-10000`: More than 5 minutes\n- content_type: Content type filter\n    - `0`: Unlimited\n    - `1`: Video\n    - `2`: Picture\n    - `3`: Article\n- search_id: Search ID used for pagination(obtained from the last response)\n- backtrace: Backtrace identifier used for pagination(obtained from the last response)\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"Artificial Intelligence\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\",\n    \"backtrace\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `status_code`: Response status code (0 = success)\n- `cursor`: Cursor for the next page\n- `has_more`: Whether more data is available (1=Yes, 0=No)\n- `data[]`: List of video search results\n  - `type`: Result type (usually `1`)\n  - `aweme_info`: Detailed video information\n    - Basic info:\n      - `aweme_id`: Video ID\n      - `desc`: Description\n      - `create_time`: Publish timestamp\n    - Author (`author`):\n      - `uid`: User ID\n      - `nickname`: Nickname\n      - `is_verified`: Whether verified\n      - `region`: Region\n      - `avatar_thumb.url_list`: Thumbnail avatars\n      - `follower_count`: Follower count\n      - `enterprise_verify_reason`: Enterprise verification reason\n    - Music (`music`):\n      - `id_str`: Music ID\n      - `title`: Music title\n      - `author`: Music creator\n      - `play_url.url_list`: Music play URLs\n    - Video (`video`):\n      - `play_addr.url_list`: Play URLs\n      - `cover.url_list`: Cover images\n      - `dynamic_cover.url_list`: Dynamic covers\n      - `origin_cover.url_list`: Original covers\n      - `ratio`: Resolution, e.g., \"720p\"\n      - `duration`: Video duration (ms)\n      - `bit_rate[]`: Multiple resolution sources\n        - `gear_name`: Gear name\n        - `bit_rate`: Bit rate\n        - `play_addr.url_list`: Play URLs\n    - Statistics (`statistics`):\n      - `comment_count`: Number of comments\n      - `digg_count`: Number of likes\n      - `share_count`: Number of shares\n      - `play_count`: Number of plays\n    - Status (`status`):\n      - `is_delete`: Whether deleted\n      - `is_private`: Whether private\n      - `allow_share`: Whether sharing is allowed\n      - `allow_comment`: Whether commenting is allowed\n    - Other fields:\n      - `share_url`: External share link\n      - `user_digged`: Whether liked (0=No, 1=Yes)\n\n- `guide_search_words[]`: Suggested keywords\n  - `id`: Suggestion ID\n  - `word`: Suggested keyword\n  - `type`: Suggestion type (usually `recom`)\n  - `query_id`: Suggestion query ID\n\n- `extra`:\n  - `now`: Current server timestamp\n  - `logid`: Log ID","operationId":"fetch_video_search_v1_api_v1_douyin_search_fetch_video_search_v1_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoSearchV1Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_video_search_v2":{"post":{"tags":["Douyin-Search-API"],"summary":"获取视频搜索 V2/Fetch video search V2","description":"# [中文]\n### 用途:\n- 获取抖音 App 中通过关键词搜索到的视频内容（V2版本接口）。\n- 相较于 V1，返回字段更加详细，包括作者资料、视频多清晰度播放源、标签列表等。\n\n### 备注:\n- 初次请求时 `cursor` 传入0，`search_id`传空字符串。\n- 返回的视频内容丰富，可用于推荐展示、内容抓取、智能分析等应用场景。\n\n### 参数:\n- keyword: 搜索关键词，如 \"机器人\"\n- cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）\n- sort_type: 排序方式\n    - `0`: 综合排序\n    - `1`: 最多点赞\n    - `2`: 最新发布\n- publish_time: 发布时间筛选\n    - `0`: 不限\n    - `1`: 最近一天\n    - `7`: 最近一周\n    - `180`: 最近半年\n- filter_duration: 视频时长筛选\n    - `0`: 不限\n    - `0-1`: 1 分钟以内\n    - `1-5`: 1-5 分钟\n    - `5-10000`: 5 分钟以上\n- content_type: 内容类型筛选\n    - `0`: 不限\n    - `1`: 视频\n    - `2`: 图片\n    - `3`: 文章\n- search_id: 搜索ID（分页时使用，从上一次响应获取）\n- backtrace: 翻页回溯标识（分页时使用，从上一次响应获取）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"机器人\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\",\n    \"backtrace\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `business_data[]`: 搜索返回的数据列表\n  - `data_id`: 数据编号（字符串，如 \"0\"）\n  - `type`: 数据类型（1=视频）\n  - `data`:\n    - `type`: 同上（1）\n    - `aweme_info`: 视频详细信息\n      - 基础信息:\n        - `aweme_id`: 视频ID\n        - `desc`: 视频描述\n        - `create_time`: 发布时间（时间戳）\n      - 作者信息 (`author`):\n        - `uid`: 用户唯一ID\n        - `short_id`: 用户短ID\n        - `nickname`: 用户昵称\n        - `signature`: 个性签名\n        - `follower_count`: 粉丝数\n        - `is_verified`: 是否认证\n        - `region`: 地区，如 \"CN\"\n        - `avatar_thumb.url_list`: 小头像URL列表\n        - `avatar_medium.url_list`: 中头像URL列表\n        - `avatar_larger.url_list`: 大头像URL列表\n        - `enterprise_verify_reason`: 企业认证信息（如\"店铺账号\"）\n      - 背景音乐 (`music`):\n        - `id_str`: 音乐ID\n        - `title`: 音乐标题\n        - `author`: 音乐创作者昵称\n        - `play_url.url_list`: 音乐播放链接列表\n      - 视频播放信息 (`video`):\n        - `play_addr.url_list`: 播放地址列表（支持高清播放）\n        - `cover.url_list`: 封面图片列表\n        - `dynamic_cover.url_list`: 动态封面列表\n        - `origin_cover.url_list`: 原始封面列表\n        - `duration`: 时长（毫秒）\n        - `ratio`: 分辨率（如\"720p\"）\n        - `bit_rate[]`: 多码率播放信息\n          - `gear_name`: 清晰度名称（如\"540_2_2\"）\n          - `bit_rate`: 码率（单位bps）\n          - `play_addr.url_list`: 对应清晰度播放地址列表\n      - 标签列表 (`cha_list[]`):\n        - `cha_name`: 话题名（如 \"#宇树科技\"）\n        - `cid`: 话题ID\n        - `share_url`: 话题分享链接\n      - 统计信息 (`statistics`):\n        - `comment_count`: 评论数\n        - `digg_count`: 点赞数\n        - `share_count`: 分享数\n        - `play_count`: 播放次数\n        - `collect_count`: 收藏次数\n      - 状态信息 (`status`):\n        - `is_delete`: 是否被删除\n        - `is_private`: 是否私密\n        - `allow_share`: 是否允许分享\n        - `allow_comment`: 是否允许评论\n      - 其他字段:\n        - `share_url`: 视频外链\n        - `user_digged`: 当前用户是否点赞（0=否，1=是）\n\n- `cursor`: 翻页游标（用于下次请求）\n- `has_more`: 是否还有更多数据（1=有，0=无）\n\n# [English]\n### Purpose:\n- Fetch video search results from Douyin App using V2 API version.\n- Compared to V1, returns more detailed information including author details, multi-resolution video sources, and hashtags.\n\n### Notes:\n- Set `cursor` to 0 and `search_id` to an empty string for the first request.\n- The response contains rich video data, suitable for display, content scraping, or intelligent analysis.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"robot\"\n- cursor: Pagination cursor (0 for the first page, use the last response cursor for subsequent pages)\n- sort_type: Sorting method\n    - `0`: Comprehensive\n    - `1`: Most likes\n    - `2`: Latest\n- publish_time: Publish time filter\n    - `0`: Unlimited\n    - `1`: Last day\n    - `7`: Last week\n    - `180`: Last half year\n- filter_duration: Video duration filter\n    - `0`: Unlimited\n    - `0-1`: Within 1 minute\n    - `1-5`: 1 to 5 minutes\n    - `5-10000`: More than 5 minutes\n- content_type: Content type filter\n    - `0`: Unlimited\n    - `1`: Video\n    - `2`: Picture\n    - `3`: Article\n- search_id: Search ID used for pagination(obtained from the last response)\n- backtrace: Backtrace identifier used for pagination(obtained from the last response)\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"robot\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\",\n    \"backtrace\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `business_data[]`: List of returned data items\n  - `data_id`: Data ID (string, e.g., \"0\")\n  - `type`: Data type (1=Video)\n  - `data`:\n    - `type`: Same as above (1)\n    - `aweme_info`: Detailed video information\n      - Basic Info:\n        - `aweme_id`: Video ID\n        - `desc`: Video description\n        - `create_time`: Creation timestamp\n      - Author Info (`author`):\n        - `uid`: Unique User ID\n        - `short_id`: Short ID\n        - `nickname`: Nickname\n        - `signature`: Bio\n        - `follower_count`: Follower count\n        - `is_verified`: Whether verified\n        - `region`: Region, e.g., \"CN\"\n        - `avatar_thumb.url_list`: Thumbnail avatar URLs\n        - `avatar_medium.url_list`: Medium avatar URLs\n        - `avatar_larger.url_list`: Large avatar URLs\n        - `enterprise_verify_reason`: Enterprise verification info\n      - Music (`music`):\n        - `id_str`: Music ID\n        - `title`: Music title\n        - `author`: Music creator nickname\n        - `play_url.url_list`: List of play URLs\n      - Video (`video`):\n        - `play_addr.url_list`: Play URLs (supports HD)\n        - `cover.url_list`: Cover images\n        - `dynamic_cover.url_list`: Dynamic covers\n        - `origin_cover.url_list`: Original covers\n        - `duration`: Duration (milliseconds)\n        - `ratio`: Resolution (e.g., \"720p\")\n        - `bit_rate[]`: Multiple bitrates\n          - `gear_name`: Gear name\n          - `bit_rate`: Bitrate (bps)\n          - `play_addr.url_list`: Play URLs\n      - Hashtags (`cha_list[]`):\n        - `cha_name`: Hashtag name (e.g., \"#UnitreeRobot\")\n        - `cid`: Hashtag ID\n        - `share_url`: Hashtag share link\n      - Statistics (`statistics`):\n        - `comment_count`: Number of comments\n        - `digg_count`: Number of likes\n        - `share_count`: Number of shares\n        - `play_count`: Number of plays\n        - `collect_count`: Number of collects\n      - Status (`status`):\n        - `is_delete`: Whether deleted\n        - `is_private`: Whether private\n        - `allow_share`: Whether sharing is allowed\n        - `allow_comment`: Whether commenting is allowed\n      - Other fields:\n        - `share_url`: Video external share link\n        - `user_digged`: Whether the user has liked (0=No, 1=Yes)\n\n- `cursor`: Cursor for next page\n- `has_more`: Whether more data is available (1=Yes, 0=No)","operationId":"fetch_video_search_v2_api_v1_douyin_search_fetch_video_search_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoSearchV2Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_multi_search":{"post":{"tags":["Douyin-Search-API"],"summary":"获取多重搜索/Fetch multi-type search","description":"# [中文]\n### 用途:\n- 获取抖音 App 中多种类型（视频、用户、音乐、话题等）的综合搜索结果。\n\n### 备注:\n- 初次请求 `cursor` 传 0，`search_id` 传空字符串。\n- 返回内容丰富，适合搭建搜索聚合页、推荐页等场景。\n\n### 参数:\n- keyword: 搜索关键词，如 \"人工智能\"\n- cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）\n- sort_type: 排序方式\n    - `0`: 综合排序\n    - `1`: 最多点赞\n    - `2`: 最新发布\n- publish_time: 发布时间筛选\n    - `0`: 不限\n    - `1`: 最近一天\n    - `7`: 最近一周\n    - `180`: 最近半年\n- filter_duration: 视频时长筛选\n    - `0`: 不限\n    - `0-1`: 1 分钟以内\n    - `1-5`: 1-5 分钟\n    - `5-10000`: 5 分钟以上\n- content_type: 内容类型筛选\n    - `0`: 不限\n    - `1`: 视频\n    - `2`: 图片\n    - `3`: 文章\n- search_id: 搜索ID（分页时使用）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"人工智能\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `cursor`: 下一页翻页游标\n- `has_more`: 是否还有更多数据（1=有，0=无）\n- `business_data[]`: 搜索结果列表\n  - `data_id`: 结果数据编号\n  - `type`: 结果类型\n    - `1`: 视频（aweme_info）\n    - `2`: 用户（user_info）\n    - `4`: 音乐（music_info）\n    - `6`: 话题（cha_info）\n  - `data`: 具体数据内容，按type类型解析\n    - 如果 type = 1（视频）:\n      - `aweme_info`:\n        - `aweme_id`: 视频ID\n        - `desc`: 视频描述\n        - `author`: 作者信息\n          - `uid`: 用户ID\n          - `nickname`: 用户昵称\n          - `avatar_thumb.url_list`: 小头像\n          - `is_verified`: 是否认证\n          - `region`: 地区\n        - `music`: 音乐信息\n          - `id_str`: 音乐ID\n          - `title`: 音乐标题\n        - `video`: 视频播放与封面信息\n          - `play_addr.url_list`: 播放地址\n          - `cover.url_list`: 封面\n          - `duration`: 视频时长（毫秒）\n        - `statistics`:\n          - `comment_count`: 评论数\n          - `digg_count`: 点赞数\n          - `share_count`: 分享数\n          - `play_count`: 播放数\n        - `status`:\n          - `is_delete`: 是否被删除\n          - `is_private`: 是否私密\n        - `share_url`: 视频外链\n    - 如果 type = 2（用户）:\n      - `user_info`:\n        - `uid`: 用户ID\n        - `nickname`: 用户昵称\n        - `signature`: 个人签名\n        - `follower_count`: 粉丝数\n        - `avatar_thumb.url_list`: 小头像\n        - `region`: 地区\n        - `is_verified`: 是否认证\n    - 如果 type = 4（音乐）:\n      - `music_info`:\n        - `id_str`: 音乐ID\n        - `title`: 音乐标题\n        - `author`: 作者名\n        - `play_url.url_list`: 播放地址\n    - 如果 type = 6（话题）:\n      - `cha_info`:\n        - `cha_name`: 话题名\n        - `desc`: 话题描述\n        - `share_url`: 话题分享链接\n        - `user_count`: 话题参与人数\n        - `view_count`: 话题浏览次数\n\n- `extra`:\n  - `now`: 当前服务器时间戳\n  - `logid`: 请求日志ID\n\n# [English]\n### Purpose:\n- Fetch multiple types of search results (videos, users, music, hashtags, etc.) from Douyin App.\n\n### Notes:\n- Set `cursor` to 0 and `search_id` to an empty string for the first request.\n- Suitable for search aggregation pages, discovery modules, and recommendations.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"Artificial Intelligence\"\n- cursor: Pagination cursor (0 for the first page, use the last response cursor for subsequent pages)\n- sort_type: Sorting method\n    - `0`: Comprehensive\n    - `1`: Most likes\n    - `2`: Latest\n- publish_time: Publish time filter\n    - `0`: Unlimited\n    - `1`: Last day\n    - `7`: Last week\n    - `180`: Last half year\n- filter_duration: Video duration filter\n    - `0`: Unlimited\n    - `0-1`: Within 1 minute\n    - `1-5`: 1 to 5 minutes\n    - `5-10000`: More than 5 minutes\n- content_type: Content type filter\n    - `0`: Unlimited\n    - `1`: Video\n    - `2`: Picture\n    - `3`: Article\n- search_id: Search ID used for pagination\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"Artificial Intelligence\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `cursor`: Cursor for the next page\n- `has_more`: Whether there are more results (1=Yes, 0=No)\n- `business_data[]`: List of search result items\n  - `data_id`: Data ID\n  - `type`: Result type\n    - `1`: Video (aweme_info)\n    - `2`: User (user_info)\n    - `4`: Music (music_info)\n    - `6`: Hashtag (cha_info)\n  - `data`: Content depending on `type`\n    - if type = 1 (video):\n      - `aweme_info`: Detailed video info\n    - if type = 2 (user):\n      - `user_info`: Detailed user info\n    - if type = 4 (music):\n      - `music_info`: Music details\n    - if type = 6 (hashtag):\n      - `cha_info`: Hashtag details\n\n- `extra`:\n  - `now`: Current server timestamp\n  - `logid`: Request log ID","operationId":"fetch_multi_search_api_v1_douyin_search_fetch_multi_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_user_search":{"post":{"tags":["Douyin-Search-API"],"summary":"获取用户搜索/Fetch user search","description":"# [中文]\n### 用途:\n- 获取抖音 App 中根据关键词搜索到的用户列表。\n- 支持通过粉丝数量、用户类型进行筛选查询。\n\n### 备注:\n- 初次请求 `cursor` 传 0，`search_id` 传空字符串。\n- 返回的数据仅包含「用户信息」，不包括视频、话题、音乐等内容。\n\n### 参数:\n- keyword: 搜索关键词，如 \"人工智能\"\n- cursor: 翻页游标（首次请求传0）\n- douyin_user_fans: 粉丝数量筛选\n  - 为空: 不限\n  - \"0_1k\": 1000以下\n  - \"1k_1w\": 1000到1万\n  - \"1w_10w\": 1万到10万\n  - \"10w_100w\": 10万到100万\n  - \"100w_\": 100万以上\n- douyin_user_type: 用户类型筛选\n  - 为空: 不限\n  - \"common_user\": 普通用户\n  - \"enterprise_user\": 企业认证用户\n  - \"personal_user\": 个人认证用户\n- search_id: 搜索ID（翻页使用）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"人工智能\",\n    \"cursor\": 0,\n    \"douyin_user_fans\": \"\",\n    \"douyin_user_type\": \"\",\n    \"search_id\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `cursor`: 下一页游标\n- `has_more`: 是否还有更多数据（1=有，0=无）\n- `user_list[]`: 用户列表\n  - `user_info`:\n    - `uid`: 用户ID\n    - `nickname`: 用户昵称\n    - `gender`: 性别（0=未知，1=男，2=女）\n    - `unique_id`: 抖音号\n    - `sec_uid`: 安全UID\n    - `signature`: 个性签名\n    - `follower_count`: 粉丝数量\n    - `avatar_thumb.url_list`: 小头像地址\n    - `avatar_medium.url_list`: 中头像地址\n    - `avatar_larger.url_list`: 大头像地址\n    - `follow_status`: 是否已关注\n    - `live_status`: 是否正在直播（0=否，1=是）\n    - `enterprise_verify_reason`: 企业认证信息（若有）\n    - `versatile_display`: 抖音号展示文案（例如\"抖音号：xxx\"）\n- `extra`:\n  - `now`: 当前服务器时间戳\n  - `logid`: 请求日志ID\n  - `search_request_id`: 搜索请求ID\n\n# [English]\n### Purpose:\n- Fetch a list of users from Douyin App based on search keywords.\n- Supports filtering by fan count and user type.\n\n### Notes:\n- Set `cursor` to 0 and `search_id` to an empty string for the first request.\n- Only user information is returned. No videos, music, or hashtags.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"AI\"\n- cursor: Pagination cursor (0 for first page)\n- douyin_user_fans: Fan count filter\n  - Empty: No limit\n  - \"0_1k\": Below 1000 fans\n  - \"1k_1w\": 1,000 to 10,000 fans\n  - \"1w_10w\": 10,000 to 100,000 fans\n  - \"10w_100w\": 100,000 to 1,000,000 fans\n  - \"100w_\": Above 1,000,000 fans\n- douyin_user_type: User type filter\n  - Empty: No limit\n  - \"common_user\": Regular user\n  - \"enterprise_user\": Enterprise-verified user\n  - \"personal_user\": Personal-verified user\n- search_id: Search session ID for pagination\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"AI\",\n    \"cursor\": 0,\n    \"douyin_user_fans\": \"\",\n    \"douyin_user_type\": \"\",\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `cursor`: Cursor for next page\n- `has_more`: Whether more data is available (1=Yes, 0=No)\n- `user_list[]`: List of users\n  - `user_info`:\n    - `uid`: User ID\n    - `nickname`: Nickname\n    - `gender`: Gender (0=Unknown, 1=Male, 2=Female)\n    - `unique_id`: Douyin ID\n    - `sec_uid`: Secured UID\n    - `signature`: Personal bio\n    - `follower_count`: Number of followers\n    - `avatar_thumb.url_list`: List of thumbnail avatar URLs\n    - `avatar_medium.url_list`: List of medium avatar URLs\n    - `avatar_larger.url_list`: List of large avatar URLs\n    - `follow_status`: Whether followed\n    - `live_status`: Whether live\n    - `enterprise_verify_reason`: Enterprise verification info (if any)\n    - `versatile_display`: Display text (e.g., \"Douyin ID: xxx\")\n- `extra`:\n  - `now`: Current server timestamp\n  - `logid`: Request log ID\n  - `search_request_id`: Search request ID","operationId":"fetch_user_search_api_v1_douyin_search_fetch_user_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_user_search_v2":{"post":{"tags":["Douyin-Search-API"],"summary":"获取用户搜索 V2/Fetch user search V2","description":"# [中文]\n### 用途:\n- 获取抖音 App 中根据关键词搜索到的用户列表。\n- 不支持粉丝数量、用户类型筛选查询。\n\n### 备注:\n- 初次请求 `cursor` 传 0。\n- 返回的数据仅包含「用户信息」，不包括视频、话题、音乐等内容。\n\n### 参数:\n- keyword: 搜索关键词，如 \"人工智能\"\n- cursor: 翻页游标（首次请求传0）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"人工智能\",\n    \"cursor\": 0\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `cursor`: 下一页游标\n- `has_more`: 是否还有更多数据（1=有，0=无）\n- `user_list[]`: 用户列表\n  - `user_info`:\n    - `uid`: 用户ID\n    - `nickname`: 用户昵称\n    - `gender`: 性别（0=未知，1=男，2=女）\n    - `unique_id`: 抖音号\n    - `sec_uid`: 安全UID\n    - `signature`: 个性签名\n    - `follower_count`: 粉丝数量\n    - `avatar_thumb.url_list`: 小头像地址\n    - `avatar_medium.url_list`: 中头像地址\n    - `avatar_larger.url_list`: 大头像地址\n    - `follow_status`: 是否已关注\n    - `live_status`: 是否正在直播（0=否，1=是）\n    - `enterprise_verify_reason`: 企业认证信息（若有）\n    - `versatile_display`: 抖音号展示文案（例如\"抖音号：xxx\"）\n- `extra`:\n  - `now`: 当前服务器时间戳\n  - `logid`: 请求日志ID\n  - `search_request_id`: 搜索请求ID\n\n# [English]\n### Purpose:\n- Fetch a list of users from Douyin App based on search keywords.\n- Supports filtering by fan count and user type.\n\n### Notes:\n- Set `cursor` to 0.\n- Only user information is returned. No videos, music, or hashtags.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"AI\"\n- cursor: Pagination cursor (0 for first page)\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"AI\",\n    \"cursor\": 0\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `cursor`: Cursor for next page\n- `has_more`: Whether more data is available (1=Yes, 0=No)\n- `user_list[]`: List of users\n  - `user_info`:\n    - `uid`: User ID\n    - `nickname`: Nickname\n    - `gender`: Gender (0=Unknown, 1=Male, 2=Female)\n    - `unique_id`: Douyin ID\n    - `sec_uid`: Secured UID\n    - `signature`: Personal bio\n    - `follower_count`: Number of followers\n    - `avatar_thumb.url_list`: List of thumbnail avatar URLs\n    - `avatar_medium.url_list`: List of medium avatar URLs\n    - `avatar_larger.url_list`: List of large avatar URLs\n    - `follow_status`: Whether followed\n    - `live_status`: Whether live\n    - `enterprise_verify_reason`: Enterprise verification info (if any)\n    - `versatile_display`: Display text (e.g., \"Douyin ID: xxx\")\n- `extra`:\n  - `now`: Current server timestamp\n  - `logid`: Request log ID\n  - `search_request_id`: Search request ID","operationId":"fetch_user_search_v2_api_v1_douyin_search_fetch_user_search_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSearchRequestV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_image_search":{"post":{"tags":["Douyin-Search-API"],"summary":"获取图片搜索/Fetch image search","description":"# [中文]\n### 用途:\n- 获取抖音 App 中图片内容搜索的结果。\n- 主要返回带有多张图片的帖子（图片合集）。\n\n### 备注:\n- 仅返回图片类型的内容，适用于图片展示类应用场景。\n- 初次请求 `cursor` 传 0，`search_id` 传空字符串。\n- 翻页时使用上一次响应中的 `cursor` 和 `search_id`。\n\n### 参数:\n- keyword: 搜索关键词，如 \"猫咪\"\n- cursor: 翻页游标（首次请求传0）\n- sort_type: 排序方式\n  - `0`: 综合排序\n  - `1`: 最多点赞\n  - `2`: 最新发布\n- publish_time: 发布时间筛选\n  - `0`: 不限\n  - `1`: 最近一天\n  - `7`: 最近一周\n  - `180`: 最近半年\n- filter_duration: 视频时长筛选\n  - `0`: 不限\n- content_type: 内容类型（固定传 2 表示图片内容）\n- search_id: 搜索ID（翻页使用）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"猫咪\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"2\",\n    \"search_id\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `cursor`: 下一页游标\n- `has_more`: 是否还有更多数据（1=有，0=无）\n- `data[]`: 图片内容列表\n  - `aweme_info`:\n    - `aweme_id`: 内容ID\n    - `desc`: 帖子描述文字\n    - `create_time`: 创建时间戳\n    - `author`:\n      - `uid`: 作者ID\n      - `nickname`: 昵称\n      - `is_verified`: 是否认证\n      - `avatar_thumb.url_list`: 缩略头像URL列表\n      - `avatar_medium.url_list`: 中等头像URL列表\n      - `avatar_larger.url_list`: 高清头像URL列表\n    - `image_post_info`:\n      - `images[]`: 图片列表\n        - `url_list`: 图片地址数组（通常包含webp/jpg）\n        - `width`: 图片宽度（像素）\n        - `height`: 图片高度（像素）\n    - `statistics`:\n      - `comment_count`: 评论数\n      - `digg_count`: 点赞数\n      - `share_count`: 分享数\n      - `play_count`: 播放数\n      - `collect_count`: 收藏数\n    - `status`:\n      - `is_delete`: 是否删除\n      - `is_private`: 是否私密\n    - `share_url`: 外部分享链接\n\n- `extra`:\n  - `now`: 当前服务器时间戳\n  - `logid`: 请求日志ID\n  - `search_request_id`: 搜索请求ID\n\n# [English]\n### Purpose:\n- Fetch image-based search results from Douyin App.\n- Mainly returns posts containing image collections.\n\n### Notes:\n- Only image posts are returned. Suitable for gallery-style applications.\n- For the first request, set `cursor` to 0 and `search_id` to an empty string.\n- For pagination, use the `cursor` and `search_id` from the last response.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"cat\"\n- cursor: Pagination cursor (0 for first request)\n- sort_type: Sorting method\n  - `0`: Comprehensive\n  - `1`: Most likes\n  - `2`: Latest\n- publish_time: Publish time filter\n  - `0`: Unlimited\n  - `1`: Last day\n  - `7`: Last week\n  - `180`: Last half year\n- filter_duration: Video duration filter\n  - `0`: Unlimited\n- content_type: Content type (Fixed to 2 for images)\n- search_id: Search ID for pagination\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"cat\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"2\",\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `cursor`: Cursor for next page\n- `has_more`: Whether there are more results (1=Yes, 0=No)\n- `data[]`: List of image posts\n  - `aweme_info`:\n    - `aweme_id`: Content ID\n    - `desc`: Post description\n    - `create_time`: Creation timestamp\n    - `author`:\n      - `uid`: Author ID\n      - `nickname`: Nickname\n      - `is_verified`: Verified status\n      - `avatar_thumb.url_list`: Thumbnail avatar URLs\n      - `avatar_medium.url_list`: Medium avatar URLs\n      - `avatar_larger.url_list`: High-res avatar URLs\n    - `image_post_info`:\n      - `images[]`: List of images\n        - `url_list`: Image URLs (webp/jpg)\n        - `width`: Width (pixels)\n        - `height`: Height (pixels)\n    - `statistics`:\n      - `comment_count`: Comment count\n      - `digg_count`: Like count\n      - `share_count`: Share count\n      - `play_count`: Play count\n      - `collect_count`: Collect count\n    - `status`:\n      - `is_delete`: Whether deleted\n      - `is_private`: Whether private\n    - `share_url`: Shareable external link\n- `extra`:\n  - `now`: Current server timestamp\n  - `logid`: Request log ID\n  - `search_request_id`: Search session ID","operationId":"fetch_image_search_api_v1_douyin_search_fetch_image_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_image_search_v3":{"post":{"tags":["Douyin-Search-API"],"summary":"获取图文搜索 V3/Fetch image-text search V3","description":"# [中文]\n### 用途:\n- 获取抖音 App 中图文内容搜索的结果。\n- 返回带有多张图片的帖子（aweme_type=68），适用于图文展示类应用场景。\n\n### 备注:\n- 该接口与 `fetch_image_search` 使用不同的数据源，返回结果可能有所差异。\n- 推荐用于需要高质量图文内容的场景。\n- 初次请求时 `cursor` 传 0，`search_id` 传空字符串。\n- 翻页请求时，使用上一次响应返回的 `cursor` 和 `search_id`。\n- 每页返回约 12 条数据。\n\n### 参数:\n- keyword: 搜索关键词，如 \"美食\"\n- cursor: 翻页游标（首次请求传 0）\n- search_id: 搜索ID（翻页时使用上次响应中的值）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"美食\",\n    \"cursor\": 0,\n    \"search_id\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `status_code`: 状态码（0=成功）\n- `business_data[]`: 图文内容列表\n  - `data`:\n    - `aweme_list[]`: 内容列表\n      - `aweme_id`: 内容ID\n      - `aweme_type`: 内容类型（68=图文）\n      - `desc`: 帖子描述文字\n      - `create_time`: 创建时间戳\n      - `author`:\n        - `uid`: 作者ID\n        - `nickname`: 昵称\n        - `avatar_thumb.url_list`: 缩略头像URL列表\n      - `image_post_info`:\n        - `images[]`: 图片列表\n          - `url_list`: 图片地址数组\n          - `width`: 图片宽度（像素）\n          - `height`: 图片高度（像素）\n      - `statistics`:\n        - `comment_count`: 评论数\n        - `digg_count`: 点赞数\n        - `share_count`: 分享数\n        - `collect_count`: 收藏数\n      - `share_url`: 外部分享链接\n- `extra`:\n  - `now`: 当前服务器时间戳\n  - `logid`: 请求日志ID\n\n---\n\n# [English]\n### Purpose:\n- Fetch image-text content search results from Douyin App.\n- Returns posts with multiple images (aweme_type=68), suitable for gallery-style applications.\n\n### Notes:\n- This endpoint uses a different data source than `fetch_image_search`, results may vary.\n- Recommended for scenarios requiring high-quality image-text content.\n- For the first request, set `cursor` to 0 and `search_id` to an empty string.\n- For pagination, use the `cursor` and `search_id` from the last response.\n- Returns approximately 12 items per page.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"food\"\n- cursor: Pagination cursor (0 for first request)\n- search_id: Search ID for pagination (use value from previous response)\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"food\",\n    \"cursor\": 0,\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `status_code`: Status code (0=success)\n- `business_data[]`: Image-text content list\n  - `data`:\n    - `aweme_list[]`: Content list\n      - `aweme_id`: Content ID\n      - `aweme_type`: Content type (68=image-text)\n      - `desc`: Post description\n      - `create_time`: Creation timestamp\n      - `author`:\n        - `uid`: Author ID\n        - `nickname`: Nickname\n        - `avatar_thumb.url_list`: Thumbnail avatar URLs\n      - `image_post_info`:\n        - `images[]`: Image list\n          - `url_list`: Image URLs array\n          - `width`: Width (pixels)\n          - `height`: Height (pixels)\n      - `statistics`:\n        - `comment_count`: Comment count\n        - `digg_count`: Like count\n        - `share_count`: Share count\n        - `collect_count`: Collect count\n      - `share_url`: Shareable external link\n- `extra`:\n  - `now`: Current server timestamp\n  - `logid`: Request log ID","operationId":"fetch_image_search_v3_api_v1_douyin_search_fetch_image_search_v3_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageSearchV3Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_live_search_v1":{"post":{"tags":["Douyin-Search-API"],"summary":"获取直播搜索 V1/Fetch live search V1","description":"# [中文]\n### 用途:\n- 获取抖音 App 中直播搜索结果。\n- 返回正在直播的房间信息，包括主播资料、直播间封面、观众人数、拉流地址等。\n\n### 备注:\n- 仅返回直播类型内容。\n- 初次请求时 `cursor` 传0，`search_id` 传空字符串。\n- 翻页请求时，使用上一次响应返回的 `cursor` 和 `search_id`。\n\n### 参数:\n- keyword: 搜索关键词，如 \"游戏\"\n- cursor: 翻页游标（首次请求传0）\n- sort_type: 排序方式\n  - `0`: 综合排序\n  - `1`: 最多点赞\n  - `2`: 最新发布\n- publish_time: 发布时间筛选\n  - `0`: 不限\n  - `1`: 最近一天\n  - `7`: 最近一周\n  - `180`: 最近半年\n- filter_duration: 视频时长过滤\n  - `0`: 不限\n- content_type: 内容类型（固定传直播类型）\n- search_id: 搜索ID（翻页时使用）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"游戏\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"1\",\n    \"search_id\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `cursor`: 下一页游标\n- `has_more`: 是否有更多数据（1=有，0=无）\n- `data[]`: 直播房间列表\n  - `type`: 返回内容类型（固定为1）\n  - `lives`:\n    - `aweme_id`: 直播对应的内容ID\n    - `group_id`: 群组ID（与aweme_id类似，可用于跳转）\n    - `author`:\n      - `uid`: 主播用户ID\n      - `nickname`: 主播昵称\n      - `short_id`: 主播短ID\n      - `avatar_thumb.url_list`: 缩略头像URL列表\n      - `avatar_medium.url_list`: 中等头像URL列表\n      - `avatar_larger.url_list`: 高清头像URL列表\n      - `room_id`: 当前直播间ID\n      - `room_cover.url_list`: 直播封面图URL列表\n    - `video`:\n      - `tags[]`: 直播标签（如“游戏”、“聊天”等）\n        - `title`: 标签标题\n        - `url.url_list`: 标签图标URL列表\n    - `rawdata`: 直播详细数据（结构化JSON字符串，可解析得到以下信息）\n      - `title`: 直播标题\n      - `user_count`: 当前在线观众数\n      - `stream_url`: 拉流信息\n        - `flv_pull_url`: 拉流地址列表（不同清晰度）\n          - `SD1`: 标清\n          - `SD2`: 高清\n          - `HD1`: 超清\n          - `FULL_HD1`: 蓝光\n          - `ORIGION`: 原画\n        - `hls_pull_url`: HLS播放地址（部分直播间可能存在）\n      - `cover.url_list`: 直播间封面图\n      - `size`: 分辨率（如1920x1080）\n      - `stats.total_user`: 在线观众数\n\n- `extra`:\n  - `now`: 当前服务器时间戳\n  - `logid`: 请求日志ID\n  - `search_request_id`: 搜索请求唯一ID\n\n# [English]\n### Purpose:\n- Fetch live stream search results from Douyin App.\n- Returns information about live rooms including streamer profile, cover image, viewer count, and stream URLs.\n\n### Notes:\n- Only live streaming content is returned.\n- Set `cursor` to 0 and `search_id` to an empty string for the first request.\n- Use the last response's `cursor` and `search_id` for pagination.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"games\"\n- cursor: Pagination cursor (0 for first request)\n- sort_type: Sorting method\n  - `0`: Comprehensive\n  - `1`: Most likes\n  - `2`: Latest\n- publish_time: Publish time filter\n  - `0`: Unlimited\n  - `1`: Last day\n  - `7`: Last week\n  - `180`: Last half year\n- filter_duration: Video duration filter\n  - `0`: Unlimited\n- content_type: Content type (fixed for live stream)\n- search_id: Search ID for pagination\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"games\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"1\",\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `cursor`: Cursor for next page\n- `has_more`: Whether there are more results (1=Yes, 0=No)\n- `data[]`: List of live stream rooms\n  - `type`: Result type (fixed to 1)\n  - `lives`:\n    - `aweme_id`: Related content ID\n    - `group_id`: Group ID\n    - `author`:\n      - `uid`: Streamer's user ID\n      - `nickname`: Streamer's nickname\n      - `short_id`: Streamer's short ID\n      - `avatar_thumb.url_list`: Thumbnail avatar URLs\n      - `avatar_medium.url_list`: Medium avatar URLs\n      - `avatar_larger.url_list`: Large avatar URLs\n      - `room_id`: Room ID\n      - `room_cover.url_list`: Room cover image URLs\n    - `video`:\n      - `tags[]`: Live tags (e.g., \"Gaming\", \"Chatting\")\n        - `title`: Tag title\n        - `url.url_list`: Tag icon URLs\n    - `rawdata`: Raw live room data (as JSON string)\n      - `title`: Live title\n      - `user_count`: Current viewer count\n      - `stream_url`: Stream URLs\n        - `flv_pull_url`: FLV stream URLs by resolution\n        - `hls_pull_url`: HLS stream URL (optional)\n      - `cover.url_list`: Room cover image\n      - `size`: Resolution (e.g., 1920x1080)\n      - `stats.total_user`: Viewer count\n- `extra`:\n  - `now`: Current server timestamp\n  - `logid`: Request log ID\n  - `search_request_id`: Unique search session ID","operationId":"fetch_live_search_v1_api_v1_douyin_search_fetch_live_search_v1_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LiveSearchV1Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_challenge_search_v1":{"post":{"tags":["Douyin-Search-API"],"summary":"获取话题搜索 V1/Fetch hashtag search V1","description":"# [中文]\n### 用途:\n- 获取抖音 App 中的话题（挑战/标签）搜索结果。\n- 根据关键词返回关联的话题列表，包含话题热度、封面、参与人数等信息。\n\n### 备注:\n- 仅返回话题类型内容。\n- 初次请求时 `cursor` 传 0，`search_id` 传空字符串。\n- 翻页查询时使用上次响应返回的 `cursor` 和 `search_id`。\n\n### 参数:\n- keyword: 搜索关键词，例如 \"美食\"\n- cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）\n- sort_type: 排序方式\n    - `0`: 综合排序\n    - `1`: 最多点赞\n    - `2`: 最新发布\n- publish_time: 发布时间筛选\n    - `0`: 不限\n    - `1`: 最近一天\n    - `7`: 最近一周\n    - `180`: 最近半年\n- filter_duration: 视频时长筛选\n    - `0`: 不限\n    - `0-1`: 1 分钟以内\n    - `1-5`: 1-5 分钟\n    - `5-10000`: 5 分钟以上\n- content_type: 内容类型筛选\n    - `0`: 不限\n    - `1`: 视频\n    - `2`: 图片\n    - `3`: 文章\n- search_id: 搜索ID（分页时使用）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"美食\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `cursor`: 翻页游标（用于下次请求）\n- `has_more`: 是否还有更多数据（1=有，0=无）\n- `challenge_list[]`: 话题列表\n  - `challenge_info`:\n    - `cid`: 话题ID\n    - `cha_name`: 话题名称（如 \"#美食探店\"）\n    - `desc`: 话题描述（通常为空）\n    - `schema`: 抖音内部跳转链接（schema协议）\n    - `share_info`:\n      - `share_url`: 话题分享H5链接\n      - `share_title`: 分享标题\n      - `share_desc`: 分享描述\n    - `view_count`: 话题总浏览量\n    - `user_count`: 话题参与人数\n    - `hashtag_profile`: 话题封面图URL\n    - `challenge_status`: 话题状态（1=正常，0=异常）\n  - `author`:\n    - `uid`: 创建者用户ID\n    - `nickname`: 创建者昵称\n    - `follower_count`: 粉丝数量\n    - `is_verified`: 是否认证\n    - `region`: 地区\n    - `avatar_thumb.url_list`: 小头像URL列表\n    - `avatar_medium.url_list`: 中头像URL列表\n    - `avatar_larger.url_list`: 高清头像URL列表\n\n- `extra`:\n  - `now`: 当前服务器时间戳（毫秒）\n  - `search_request_id`: 搜索请求唯一ID\n\n# [English]\n### Purpose:\n- Fetch hashtag/challenge search results from Douyin App.\n- Returns related hashtag topics including name, view count, participants, and cover images.\n\n### Notes:\n- Only hashtag type content is returned.\n- Set `cursor` to 0 and `search_id` to an empty string for the first request.\n- For pagination, use `cursor` and `search_id` from the last response.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"food\"\n- cursor: Pagination cursor (0 for first request)\n- sort_type: Sorting method\n    - `0`: Comprehensive\n    - `1`: Most likes\n    - `2`: Latest\n- publish_time: Publish time filter\n    - `0`: Unlimited\n    - `1`: Last day\n    - `7`: Last week\n    - `180`: Last half year\n- filter_duration: Video duration filter\n    - `0`: Unlimited\n    - `0-1`: Under 1 minute\n    - `1-5`: 1-5 minutes\n    - `5-10000`: Over 5 minutes\n- content_type: Content type filter\n    - `0`: Unlimited\n    - `1`: Video\n    - `2`: Image\n    - `3`: Article\n- search_id: Search ID for pagination\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"food\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `cursor`: Cursor for next page\n- `has_more`: Whether more results are available (1=Yes, 0=No)\n- `challenge_list[]`: List of hashtags\n  - `challenge_info`:\n    - `cid`: Challenge ID\n    - `cha_name`: Challenge name (e.g., \"#FoodHunt\")\n    - `desc`: Challenge description\n    - `schema`: Deep link for Douyin App\n    - `share_info`:\n      - `share_url`: H5 shareable link\n      - `share_title`: Share title\n      - `share_desc`: Share description\n    - `view_count`: Total view count\n    - `user_count`: Total participant count\n    - `hashtag_profile`: Cover image URL\n    - `challenge_status`: Challenge status (1=Normal, 0=Abnormal)\n  - `author`:\n    - `uid`: Author's user ID\n    - `nickname`: Author's nickname\n    - `follower_count`: Follower count\n    - `is_verified`: Verified status\n    - `region`: Region\n    - `avatar_thumb.url_list`: Thumbnail avatar URLs\n    - `avatar_medium.url_list`: Medium avatar URLs\n    - `avatar_larger.url_list`: Large avatar URLs\n\n- `extra`:\n  - `now`: Server timestamp\n  - `search_request_id`: Unique search session ID","operationId":"fetch_challenge_search_v1_api_v1_douyin_search_fetch_challenge_search_v1_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeSearchV1Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_challenge_search_v2":{"post":{"tags":["Douyin-Search-API"],"summary":"获取话题搜索 V2/Fetch hashtag search V2","description":"# [中文]\n### 用途:\n- 获取抖音 App 中话题(挑战/标签)搜索的结果，使用 V2 版本 API。\n- 支持关键词搜索，返回匹配的话题详情，包括话题名称、话题封面、浏览量、参与人数等。\n\n### 备注:\n- 本接口专注于搜索话题（Challenge/Hashtag）内容，不包含视频或直播等其他类型。\n- 初次请求时 `cursor` 传入 0，`search_id` 传空字符串，后续翻页请使用上一次返回的 `cursor` 和 `search_id`。\n\n### 参数:\n- keyword: 搜索关键词，如 \"游戏\"\n- cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）\n- sort_type: 排序方式\n    - `0`: 综合排序\n    - `1`: 最多点赞\n    - `2`: 最新发布\n- publish_time: 发布时间筛选\n    - `0`: 不限\n    - `1`: 最近一天\n    - `7`: 最近一周\n    - `180`: 最近半年\n- filter_duration: 视频时长筛选\n    - `0`: 不限\n    - `0-1`: 1 分钟以内\n    - `1-5`: 1-5 分钟\n    - `5-10000`: 5 分钟以上\n- content_type: 内容类型筛选\n    - `0`: 不限\n    - `1`: 视频\n    - `2`: 图片\n    - `3`: 文章\n- search_id: 搜索ID（分页时使用）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"游戏\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `business_data`（话题搜索结果列表）\n  - `data_id`: 结果的唯一编号\n  - `type`: 数据类型（固定为 `2`）\n  - `data.challenge_info`:\n    - `cid`: 话题ID\n    - `cha_name`: 话题名称\n    - `desc`: 话题描述\n    - `schema`: 话题跳转链接（aweme://开头，可跳转抖音 App 内话题详情）\n    - `hashtag_profile`: 话题封面图 URL\n    - `user_count`: 参与人数\n    - `view_count`: 话题浏览量\n    - `challenge_status`: 话题状态（1=正常，其他=异常）\n    - `author`: 创建者信息\n      - `uid`: 创建者抖音用户ID\n      - `nickname`: 昵称\n      - `avatar_thumb.url_list`: 缩略头像URL列表\n      - `is_verified`: 是否认证\n      - `follower_count`: 粉丝数\n    - `share_info`:\n      - `share_url`: 话题分享链接\n      - `share_title`: 分享标题\n      - `share_desc`: 分享描述\n\n# [English]\n### Purpose:\n- Fetch hashtag/challenge search results from Douyin App using V2 API.\n- Supports searching by keyword and returns detailed challenge information, including name, cover image, view count, and participant count.\n\n### Notes:\n- This API focuses on searching challenges (hashtags), not including videos or live streams.\n- Set `cursor` to 0 and `search_id` to an empty string for the first request. For pagination, use the cursor and search_id from the last response.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"game\"\n- cursor: Pagination cursor (0 for first request)\n- sort_type: Sorting method\n    - `0`: Comprehensive\n    - `1`: Most likes\n    - `2`: Latest\n- publish_time: Publish time filter\n    - `0`: Unlimited\n    - `1`: Last day\n    - `7`: Last week\n    - `180`: Last half year\n- filter_duration: Video duration filter\n    - `0`: Unlimited\n    - `0-1`: Under 1 minute\n    - `1-5`: 1-5 minutes\n    - `5-10000`: Over 5 minutes\n- content_type: Content type filter\n    - `0`: Unlimited\n    - `1`: Video\n    - `2`: Image\n    - `3`: Article\n- search_id: Search ID for pagination\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"game\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `business_data` (list of hashtag search results)\n  - `data_id`: Unique identifier for the result\n  - `type`: Data type (fixed `2`)\n  - `data.challenge_info`:\n    - `cid`: Challenge ID\n    - `cha_name`: Challenge name\n    - `desc`: Challenge description\n    - `schema`: Challenge detail schema link (aweme:// schema, used to deep link inside Douyin App)\n    - `hashtag_profile`: URL of the hashtag cover image\n    - `user_count`: Number of participants\n    - `view_count`: Number of views\n    - `challenge_status`: Status (1 = active, others = abnormal)\n    - `author`: Creator info\n      - `uid`: User ID\n      - `nickname`: Nickname\n      - `avatar_thumb.url_list`: Thumbnail avatar URLs\n      - `is_verified`: Whether the creator is verified\n      - `follower_count`: Number of followers\n    - `share_info`:\n      - `share_url`: Shareable URL\n      - `share_title`: Title for sharing\n      - `share_desc`: Description for sharing","operationId":"fetch_challenge_search_v2_api_v1_douyin_search_fetch_challenge_search_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeSearchV2Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_challenge_suggest":{"post":{"tags":["Douyin-Search-API"],"summary":"获取话题推荐搜索/Fetch hashtag suggestions","description":"# [中文]\n### 用途:\n- 获取抖音 App 中话题(挑战/标签)的推荐搜索结果。\n- 根据输入的关键词，返回相关的话题建议列表，包含话题名称、浏览量等信息。\n\n### 备注:\n- 本接口可用于话题联想推荐场景，如输入关键词实时展示相关热门话题。\n- 初次请求时 `cursor` 传入 0，`search_id` 传空字符串。\n\n### 参数:\n- keyword: 搜索关键词，如 \"游戏\"\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"游戏\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `sug_list[]`: 推荐话题列表\n  - `cha_name`: 话题名称（如 \"#游戏\"）\n  - `view_count`: 话题总浏览量\n  - `cid`: 话题ID\n  - `group_id`: 话题关联的群组ID（可以用于跳转）\n  - `tag`: 话题标签分类（0=普通话题，1=流量风向标）\n- `status_code`: 状态码（0=成功）\n- `status_msg`: 状态信息（通常为空）\n- `rid`: 请求ID\n- `words_query_record`:\n  - `info`: 额外信息（目前为空）\n  - `words_source`: 关键词来源（固定\"sug\"）\n  - `query_id`: 查询ID（通常为空）\n- `extra`:\n  - `now`: 当前服务器时间戳\n  - `logid`: 日志ID\n  - `fatal_item_ids`: 错误项目ID列表（通常为空）\n  - `search_request_id`: 搜索请求ID（通常为空）\n- `log_pb`:\n  - `impr_id`: 曝光ID（日志追踪用）\n\n# [English]\n### Purpose:\n- Fetch hashtag/challenge suggestions from Douyin App based on the input keyword.\n- Returns a list of related hashtags including name and view count.\n\n### Notes:\n- Suitable for implementing keyword suggestion features in search bars.\n- Set `cursor` to 0 and `search_id` to an empty string for the first request.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"game\"\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"game\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `sug_list[]`: List of suggested hashtags\n  - `cha_name`: Hashtag name (e.g., \"#game\")\n  - `view_count`: Total view count\n  - `cid`: Challenge ID\n  - `group_id`: Associated group ID\n  - `tag`: Tag category (0=normal, 1=hot trend)\n- `status_code`: Status code (0=success)\n- `status_msg`: Status message (usually empty)\n- `rid`: Request ID\n- `words_query_record`:\n  - `info`: Additional info (currently empty)\n  - `words_source`: Words source (\"sug\")\n  - `query_id`: Query ID (usually empty)\n- `extra`:\n  - `now`: Server timestamp\n  - `logid`: Log ID\n  - `fatal_item_ids`: List of fatal item IDs (usually empty)\n  - `search_request_id`: Search request ID (usually empty)\n- `log_pb`:\n  - `impr_id`: Impression ID (for logging)","operationId":"fetch_challenge_suggest_api_v1_douyin_search_fetch_challenge_suggest_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChallengeSuggestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_experience_search":{"post":{"tags":["Douyin-Search-API"],"summary":"获取经验搜索/Fetch experience search","description":"# [中文]\n### 用途:\n- 获取抖音 App 中经验（知识/教程）内容的搜索结果。\n- 支持通过关键词检索，与经验类内容（如攻略、教程、分享等）相关的视频信息。\n\n### 备注:\n- 此接口专注于经验类内容，不包含其他类型的内容。\n- 初次请求时，`cursor` 应传 0，`search_id` 传空字符串，翻页时使用上次响应返回的 cursor 和 search_id。\n- 返回的结果中包含视频详情、作者信息、背景音乐、话题标签、播放地址、互动数据等。\n\n### 参数:\n- keyword: 搜索关键词，例如 \"游戏攻略\"\n- cursor: 翻页游标，首次请求传 0\n- sort_type: 排序方式\n  - `0`: 综合排序\n  - `1`: 最多点赞\n  - `2`: 最新发布\n- publish_time: 发布时间筛选\n  - `0`: 不限\n  - `1`: 最近一天\n  - `7`: 最近一周\n  - `180`: 最近半年\n- filter_duration: 视频时长筛选\n  - `0`: 不限\n  - `0-1`: 1分钟以内\n  - `1-5`: 1-5分钟\n  - `5-10000`: 5分钟以上\n- content_type: 内容类型筛选（通常固定为视频）\n- search_id: 分页查询时需要传上次响应返回的 `search_id`\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"游戏攻略\",\n    \"cursor\": 0,\n    \"sort_type\": 0,\n    \"publish_time\": 0,\n    \"filter_duration\": 0,\n    \"content_type\": 1,\n    \"search_id\": \"\"\n}\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- business_data: 搜索结果业务数据列表\n  - data_id: 数据块ID\n  - type: 数据类型（如 999 表示内容列表）\n  - data:\n    - height: 显示区域高度\n    - aweme_list: 视频列表\n      - aweme_id: 视频ID\n      - desc: 视频描述内容\n      - create_time: 视频发布时间（时间戳）\n      - author: 作者信息\n        - uid: 作者UID\n        - nickname: 作者昵称\n        - avatar_thumb.url_list: 作者头像缩略图\n        - is_verified: 是否是认证账号\n        - follower_count: 粉丝数\n      - music: 背景音乐信息\n        - id_str: 音乐ID\n        - title: 音乐标题\n        - author: 音乐作者昵称\n      - cha_list: 关联的话题标签列表\n        - cha_name: 话题名称\n      - video: 视频播放信息\n        - play_addr.url_list: 视频播放地址列表\n        - cover.url_list: 视频封面图地址\n        - width: 视频宽度\n        - height: 视频高度\n        - duration: 视频时长（单位毫秒）\n      - statistics: 视频互动数据\n        - digg_count: 点赞数\n        - comment_count: 评论数\n        - share_count: 分享数\n        - play_count: 播放次数\n      - status: 视频状态信息\n        - is_delete: 是否已删除\n        - is_private: 是否私密\n      - share_url: 视频外部分享链接\n\n# [English]\n### Purpose:\n- Fetch experience (knowledge/tutorial) content search results from Douyin App.\n- Retrieves video results related to knowledge sharing, tutorials, or tips based on the input keyword.\n\n### Notes:\n- This API focuses on experience-related videos and does not include other content types.\n- Set `cursor` to 0 and `search_id` to an empty string for the first request; for pagination, use the previous cursor and search_id.\n- The response includes rich information such as video details, author profile, background music, hashtags, video URLs, and engagement statistics.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"gaming guide\"\n- cursor: Pagination cursor (0 for first page)\n- sort_type: Sorting method\n  - `0`: Comprehensive\n  - `1`: Most likes\n  - `2`: Latest\n- publish_time: Publish time filter\n  - `0`: Unlimited\n  - `1`: Last day\n  - `7`: Last week\n  - `180`: Last half year\n- filter_duration: Video duration filter\n  - `0`: Unlimited\n  - `0-1`: Within 1 minute\n  - `1-5`: 1 to 5 minutes\n  - `5-10000`: More than 5 minutes\n- content_type: Content type filter (usually fixed to video)\n- search_id: Search ID for pagination\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"gaming guide\",\n    \"cursor\": 0,\n    \"sort_type\": 0,\n    \"publish_time\": 0,\n    \"filter_duration\": 0,\n    \"content_type\": 1,\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- business_data: List of business data blocks\n  - data_id: Data block ID\n  - type: Data type (e.g., 999 for content list)\n  - data:\n    - height: Display height\n    - aweme_list: List of videos\n      - aweme_id: Video ID\n      - desc: Video description\n      - create_time: Creation timestamp\n      - author: Author profile\n        - uid: User ID\n        - nickname: User nickname\n        - avatar_thumb.url_list: Thumbnail avatar URLs\n        - is_verified: Whether the author is verified\n        - follower_count: Number of followers\n      - music: Background music information\n        - id_str: Music ID\n        - title: Music title\n        - author: Music author's name\n      - cha_list: Associated hashtags\n        - cha_name: Hashtag name\n      - video: Video playback info\n        - play_addr.url_list: List of video play URLs\n        - cover.url_list: List of video cover image URLs\n        - width: Video width\n        - height: Video height\n        - duration: Video duration in milliseconds\n      - statistics: Video engagement data\n        - digg_count: Number of likes\n        - comment_count: Number of comments\n        - share_count: Number of shares\n        - play_count: Number of plays\n      - status: Video status information\n        - is_delete: Whether the video was deleted\n        - is_private: Whether the video is private\n      - share_url: External share link of the video","operationId":"fetch_experience_search_api_v1_douyin_search_fetch_experience_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperienceSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_music_search":{"post":{"tags":["Douyin-Search-API"],"summary":"获取音乐搜索/Fetch music search","description":"# [中文]\n### 用途:\n- 获取抖音 App 中音乐内容的搜索结果。\n- 支持关键词、排序方式、筛选条件等。\n\n### 备注:\n- 本接口专注于音乐类内容搜索，不包含其他类型内容。\n- 初次请求时 `cursor` 传 0，`search_id` 传空字符串。\n- 返回内容包含音乐基本信息、作者信息、封面、播放地址、标签等。\n\n### 参数:\n- keyword: 搜索关键词，例如 \"游戏背景音乐\"\n- cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）\n- sort_type: 排序方式\n    - `0`: 综合排序\n    - `1`: 最多点赞\n    - `2`: 最新发布\n- publish_time: 发布时间筛选\n    - `0`: 不限\n    - `1`: 最近一天\n    - `7`: 最近一周\n    - `180`: 最近半年\n- filter_duration: 视频时长筛选\n    - `0`: 不限\n    - `0-1`: 1 分钟以内\n    - `1-5`: 1-5 分钟\n    - `5-10000`: 5 分钟以上\n- content_type: 内容类型筛选\n    - `0`: 不限\n    - `1`: 视频\n    - `2`: 图片\n    - `3`: 文章\n- search_id: 搜索ID（分页时使用）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"游戏背景音乐\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `music`: 音乐结果列表\n  - `id_str`: 音乐ID（字符串格式）\n  - `title`: 音乐标题\n  - `author`: 音乐作者昵称\n  - `album`: 所属专辑（如果有）\n  - `play_url.url_list`: 音乐播放地址列表\n  - `duration`: 音乐时长（秒）\n  - `cover_thumb.url_list`: 缩略封面图片列表\n  - `cover_medium.url_list`: 中尺寸封面图片列表\n  - `cover_large.url_list`: 高清封面图片列表\n  - `user_count`: 使用该音乐的作品数量\n  - `is_original`: 是否原创音乐\n  - `is_commerce_music`: 是否为商业授权音乐\n  - `lyric_url`: 歌词文件链接（如果有）\n  - `strong_beat_url.url_list`: 音乐节奏点文件链接\n  - `tags`: 音乐标签\n    - 如：主题（如游戏、Vlog）、情绪（如Funny）、风格（如8-bit, Electronic）\n  - `artists`: 音乐关联的创作者列表（如果有）\n    - `artist_name`: 艺人昵称\n    - `uid`: 艺人UID\n  - `cover_color_hsv`: 封面主色调HSV值\n  - `can_background_play`: 是否支持后台播放\n\n# [English]\n### Purpose:\n- Fetch music content search results from Douyin App.\n- Supports filtering by keyword, sort type, etc.\n\n### Notes:\n- This API focuses on music content search, excluding other types.\n- Set `cursor` to 0 and `search_id` to an empty string for the first request.\n- Response includes music basic info, artist info, covers, play URLs, tags, etc.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"game background music\"\n- cursor: Pagination cursor (0 for first request)\n- sort_type: Sorting method\n    - `0`: Comprehensive\n    - `1`: Most likes\n    - `2`: Latest\n- publish_time: Publish time filter\n    - `0`: Unlimited\n    - `1`: Last day\n    - `7`: Last week\n    - `180`: Last half year\n- filter_duration: Video duration filter\n    - `0`: Unlimited\n    - `0-1`: Under 1 minute\n    - `1-5`: 1 to 5 minutes\n    - `5-10000`: Over 5 minutes\n- content_type: Content type filter\n    - `0`: Unlimited\n    - `1`: Video\n    - `2`: Image\n    - `3`: Article\n- search_id: Search ID for pagination\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"game background music\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `music`: List of music search results\n  - `id_str`: Music ID (as string)\n  - `title`: Music title\n  - `author`: Music author's nickname\n  - `album`: Album name (if any)\n  - `play_url.url_list`: List of music play URLs\n  - `duration`: Duration in seconds\n  - `cover_thumb.url_list`: List of thumbnail cover URLs\n  - `cover_medium.url_list`: List of medium-sized cover URLs\n  - `cover_large.url_list`: List of large-sized cover URLs\n  - `user_count`: Number of videos using this music\n  - `is_original`: Whether it is original music\n  - `is_commerce_music`: Whether it is commercial music\n  - `lyric_url`: Lyrics file URL (if available)\n  - `strong_beat_url.url_list`: Beat timing file URLs\n  - `tags`: Music tags\n    - Themes (e.g., Game, Vlog), Moods (e.g., Funny), Genres (e.g., 8-bit, Electronic)\n  - `artists`: List of associated artists (if any)\n    - `artist_name`: Artist name\n    - `uid`: Artist UID\n  - `cover_color_hsv`: Dominant HSV color of the cover\n  - `can_background_play`: Whether background playback is supported","operationId":"fetch_music_search_api_v1_douyin_search_fetch_music_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_discuss_search":{"post":{"tags":["Douyin-Search-API"],"summary":"获取讨论搜索/Fetch discussion search","description":"# [中文]\n### 用途:\n- 获取抖音 App 中讨论区/问答内容的搜索结果。\n- 支持关键词、排序方式、发布时间、内容类型等筛选条件。\n\n### 备注:\n- 此接口专注于讨论区内容搜索（如问答讨论视频），不包含其他类型的内容。\n- 初次请求时 `cursor` 传入 0，`search_id` 传空字符串。\n- 返回内容包括视频信息、作者信息、播放信息、互动数据、话题标签等。\n\n### 参数:\n- keyword: 搜索关键词，例如 \"出国留学\"\n- cursor: 翻页游标（首次请求传 0，翻页时使用上次响应的 cursor）\n- sort_type: 排序方式\n  - `0`: 综合排序\n  - `1`: 最多点赞\n  - `2`: 最新发布\n- publish_time: 发布时间筛选\n  - `0`: 不限\n  - `1`: 最近一天\n  - `7`: 最近一周\n  - `180`: 最近半年\n- filter_duration: 视频时长筛选\n  - `0`: 不限\n  - `0-1`: 1 分钟以内\n  - `1-5`: 1-5 分钟\n  - `5-10000`: 5 分钟以上\n- content_type: 内容类型筛选\n  - `0`: 不限\n  - `1`: 视频\n  - `2`: 图片\n  - `3`: 文章\n- search_id: 搜索ID（分页时使用）\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"出国留学\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `data`: 搜索结果列表\n  - `type`: 结果类型（一般为 `1`）\n  - `aweme_info`: 视频信息\n    - `aweme_id`: 视频ID\n    - `desc`: 视频描述内容\n    - `author`: 作者信息\n      - `uid`: 用户唯一ID\n      - `nickname`: 用户昵称\n      - `is_verified`: 是否认证用户\n      - `region`: 用户地区\n      - `avatar_thumb.url_list`: 缩略头像列表\n      - `avatar_medium.url_list`: 中等尺寸头像列表\n      - `avatar_larger.url_list`: 高清头像列表\n    - `video`: 视频播放与封面信息\n      - `play_addr.url_list`: 播放地址列表\n      - `cover.url_list`: 视频封面列表\n      - `dynamic_cover.url_list`: 动态封面列表\n      - `origin_cover.url_list`: 原始封面列表\n      - `width`: 视频宽度（像素）\n      - `height`: 视频高度（像素）\n      - `ratio`: 视频分辨率比例（如540p）\n      - `duration`: 视频时长（毫秒）\n      - `download_addr.url_list`: 带水印下载地址\n    - `statistics`: 视频数据\n      - `comment_count`: 评论数\n      - `digg_count`: 点赞数\n      - `share_count`: 分享数\n      - `play_count`: 播放次数\n      - `collect_count`: 收藏次数\n    - `cha_list`: 话题标签\n      - `cha_name`: 标签名称\n      - `share_url`: 标签分享链接\n    - `music`: 音乐信息\n      - `id_str`: 音乐ID\n      - `title`: 音乐标题\n      - `author`: 音乐作者昵称\n      - `play_url.url_list`: 音乐播放链接列表\n    - `status`: 视频状态\n      - `is_delete`: 是否被删除\n      - `is_private`: 是否设为私密\n      - `allow_share`: 是否允许分享\n      - `allow_comment`: 是否允许评论\n    - `share_url`: 视频外部分享链接\n\n# [English]\n### Purpose:\n- Fetch discussion/Q&A search results from Douyin App.\n- Supports filtering by keyword, sort type, publish time, content type, etc.\n\n### Notes:\n- This API focuses on discussion and Q&A content, not including other content types.\n- Set `cursor` to 0 and `search_id` to an empty string for the first request.\n- The response includes video details, author info, playback info, statistics, hashtags, etc.\n\n### Parameters:\n- keyword: Search keyword, e.g., \"study abroad\"\n- cursor: Pagination cursor (0 for first page, use the last response cursor for subsequent pages)\n- sort_type: Sorting method\n  - `0`: Comprehensive\n  - `1`: Most likes\n  - `2`: Latest\n- publish_time: Publish time filter\n  - `0`: Unlimited\n  - `1`: Last day\n  - `7`: Last week\n  - `180`: Last half year\n- filter_duration: Video duration filter\n  - `0`: Unlimited\n  - `0-1`: Within 1 minute\n  - `1-5`: 1 to 5 minutes\n  - `5-10000`: More than 5 minutes\n- content_type: Content type filter\n  - `0`: Unlimited\n  - `1`: Video\n  - `2`: Picture\n  - `3`: Article\n- search_id: Search ID used for pagination\n\n### Request Body Example:\n```json\npayload = {\n    \"keyword\": \"study abroad\",\n    \"cursor\": 0,\n    \"sort_type\": \"0\",\n    \"publish_time\": \"0\",\n    \"filter_duration\": \"0\",\n    \"content_type\": \"0\",\n    \"search_id\": \"\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `data`: List of search result items\n  - `type`: Result type (usually `1`)\n  - `aweme_info`: Video information\n    - `aweme_id`: Video ID\n    - `desc`: Description\n    - `author`:\n      - `uid`: User ID\n      - `nickname`: User nickname\n      - `is_verified`: Verified user or not\n      - `region`: User region\n      - `avatar_thumb.url_list`: Thumbnail avatar URLs\n      - `avatar_medium.url_list`: Medium avatar URLs\n      - `avatar_larger.url_list`: Large avatar URLs\n    - `video`:\n      - `play_addr.url_list`: Video playback URLs\n      - `cover.url_list`: Video cover URLs\n      - `dynamic_cover.url_list`: Dynamic cover URLs\n      - `origin_cover.url_list`: Original cover URLs\n      - `width`: Width in pixels\n      - `height`: Height in pixels\n      - `ratio`: Resolution ratio (e.g., 540p)\n      - `duration`: Duration in milliseconds\n      - `download_addr.url_list`: Download URLs with watermark\n    - `statistics`:\n      - `comment_count`: Number of comments\n      - `digg_count`: Number of likes\n      - `share_count`: Number of shares\n      - `play_count`: Number of plays\n      - `collect_count`: Number of collections\n    - `cha_list`:\n      - `cha_name`: Hashtag name\n      - `share_url`: Hashtag share link\n    - `music`:\n      - `id_str`: Music ID\n      - `title`: Music title\n      - `author`: Music creator name\n      - `play_url.url_list`: List of music playback URLs\n    - `status`:\n      - `is_delete`: Whether deleted\n      - `is_private`: Whether private\n      - `allow_share`: Allow sharing\n      - `allow_comment`: Allow commenting\n    - `share_url`: External video share link","operationId":"fetch_discuss_search_api_v1_douyin_search_fetch_discuss_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscussSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_school_search":{"post":{"tags":["Douyin-Search-API"],"summary":"获取学校搜索/Fetch school search","description":"# [中文]\n### 用途:\n- 获取抖音 App 中学校信息的搜索结果。\n- 根据关键词返回学校名称列表，常用于用户设置学校资料、兴趣推荐等场景。\n\n### 备注:\n- 本接口专注于学校信息搜索，仅返回学校的名称字段。\n- 初次请求时 `cursor` 应传 0，分页时使用上一次返回的 `cursor`。\n- 本接口响应体较简单，适合快速检索学校数据。\n\n### 参数:\n- keyword: 搜索关键词，如学校名称 \"北京大学\"、地区名 \"北京\"\n\n### 请求体示例：\n```json\npayload = {\n    \"keyword\": \"北京大学\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `schools[]`: 学校列表\n  - `name`: 学校名称（如 \"北京大学\"、\"北京四中\"）\n- `extra`:\n  - `now`: 当前服务器时间戳（毫秒）\n  - `logid`: 请求日志ID\n  - `fatal_item_ids`: 错误项目ID列表（通常为空）\n- `log_pb`:\n  - `impr_id`: 曝光追踪ID（用于链路追踪）\n- `status_code`: 状态码（0=成功）\n- `status_msg`: 状态信息（通常为空）\n\n# [English]\n### Purpose:\n- Fetch school information search results from Douyin App.\n- Returns a list of school names based on the input keyword, useful for user profile settings, school recommendations, etc.\n\n### Notes:\n- This API focuses on school information search, and only returns school names.\n- Set `cursor` to 0 for the first request; for pagination, use the cursor from the last response.\n- The response structure is simple and lightweight for fast lookup.\n\n### Parameters:\n- keyword: Search keyword, e.g., school name \"Peking University\" or city \"Beijing\"\n\n### Example Request Body:\n```json\npayload = {\n    \"keyword\": \"Peking University\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `schools[]`: List of schools\n  - `name`: School name (e.g., \"Peking University\", \"Beijing No.4 High School\")\n- `extra`:\n  - `now`: Server timestamp in milliseconds\n  - `logid`: Log ID for request tracing\n  - `fatal_item_ids`: List of fatal item IDs (usually empty)\n- `log_pb`:\n  - `impr_id`: Impression ID for tracking\n- `status_code`: Status code (0=success)\n- `status_msg`: Status message (usually empty)","operationId":"fetch_school_search_api_v1_douyin_search_fetch_school_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchoolSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/search/fetch_vision_search":{"post":{"tags":["Douyin-Search-API"],"summary":"获取图像识别搜索/Fetch vision search (image-based search)","description":"# [中文]\n### 用途:\n- 抖音APP图像识别搜索（以图搜图/视觉搜索）。\n- 通过图片进行视觉搜索，返回相似的视频/图文内容。\n- `image_uri` 可从抖音其他接口的返回数据中获取（如视频详情、搜索结果、用户主页等接口的图片uri字段）。\n\n### 备注:\n- 初次请求时 `cursor` 传入 0，`search_id` 传空字符串。\n- 翻页时需从上一次响应中获取 `cursor` 和 `search_id` 字段值。\n- `image_uri` 是必填参数，需要先通过抖音图片上传接口获取，或在单一视频接口中获取，其他途径如各类搜索接口返回的图片URI均可使用。\n- `detection` 表示图片中需要识别的区域，格式为 \"x1,y1,x2,y2\"，默认 \"0.1,0.1,0.9,0.9\" 表示全图。\n\n### 参数:\n- image_uri: 图片URI，通过图片上传接口获取，或在单一视频接口中获取，其他途径如各类搜索接口返回的图片URI均可使用。（必填）\n- cursor: 翻页游标（首次请求传 0）\n- search_id: 搜索ID（首次请求传空，翻页时从上次响应获取）\n- search_source: 搜索来源\n    - `graphic_detail`: 图片详情页搜索（默认）\n    - `visual_normal_search`: 带关键词追加搜索（需要传入 user_query）\n- detection: 检测区域坐标，格式为 \"x1,y1,x2,y2\"\n- detection_index: 检测索引，默认 0\n- user_query: 搜索关键词，仅当 search_source=\"visual_normal_search\" 时使用\n- aweme_id: 原视频ID，仅当 search_source=\"visual_normal_search\" 时使用\n\n### 请求体示例：\n基础图片搜索：\n```json\npayload = {\n    \"image_uri\": \"20251221204239F0C21D7645F172B6085C\",\n    \"cursor\": 0,\n    \"search_id\": \"\",\n    \"search_source\": \"graphic_detail\",\n    \"detection\": \"0.1,0.1,0.9,0.9\",\n    \"detection_index\": 0\n}\n```\n\n带关键词的追加搜索：\n```json\npayload = {\n    \"image_uri\": \"20251221204239F0C21D7645F172B6085C\",\n    \"cursor\": 0,\n    \"search_id\": \"2025122120452038252994F25A4BAEB043\",\n    \"search_source\": \"visual_normal_search\",\n    \"detection\": \"0.1,0.1,0.9,0.9\",\n    \"detection_index\": 0,\n    \"user_query\": \"游戏\",\n    \"aweme_id\": \"7523532488087817529\"\n}\n```\n\n### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:\n- `status_code`: 响应状态码（0为成功）\n- `cursor`: 下一页游标\n- `has_more`: 是否还有更多数据（1=有，0=无）\n- `search_id`: 搜索ID，翻页时使用\n- `data[]`: 搜索结果列表\n  - `type`: 结果类型\n  - `aweme_info`: 视频/图文详细信息\n    - `aweme_id`: 视频ID\n    - `desc`: 视频描述\n    - `author`: 作者信息\n    - `video`: 视频播放信息\n    - `statistics`: 互动统计\n\n# [English]\n### Purpose:\n- Douyin APP vision search (image-based search / reverse image search).\n- Search for similar videos/images using an image.\n- The `image_uri` can be obtained from other Douyin API responses (such as video details, search results, user profile, etc.), and used directly for vision search.\n\n### Notes:\n- Set `cursor` to 0 and `search_id` to empty string for the first request.\n- For pagination, obtain `cursor` and `search_id` values from the previous response.\n- `image_uri` is a required parameter. It can be obtained from Douyin API responses that contain image information, such as video details API, general search API, user profile API, etc. These responses typically include image URIs that can be used directly for vision search.\n- `detection` represents the area to be recognized in the image, format \"x1,y1,x2,y2\", default \"0.1,0.1,0.9,0.9\" means the whole image.\n\n### Parameters:\n- image_uri: Image URI obtained from other Douyin API responses (e.g., video details, search results, user profile) (required)\n- cursor: Pagination cursor (0 for the first page)\n- search_id: Search ID (empty for first request, obtained from previous response for pagination)\n- search_source: Search source\n    - `graphic_detail`: Image detail page search (default)\n    - `visual_normal_search`: Search with keyword append (requires user_query)\n- detection: Detection area coordinates, format \"x1,y1,x2,y2\"\n- detection_index: Detection index, default 0\n- user_query: Search keyword, only used when search_source=\"visual_normal_search\"\n- aweme_id: Original video ID, only used when search_source=\"visual_normal_search\"\n\n### Request Body Example:\nBasic image search:\n```json\npayload = {\n    \"image_uri\": \"20251221204239F0C21D7645F172B6085C\",\n    \"cursor\": 0,\n    \"search_id\": \"\",\n    \"search_source\": \"graphic_detail\",\n    \"detection\": \"0.1,0.1,0.9,0.9\",\n    \"detection_index\": 0\n}\n```\n\nSearch with keyword append:\n```json\npayload = {\n    \"image_uri\": \"20251221204239F0C21D7645F172B6085C\",\n    \"cursor\": 0,\n    \"search_id\": \"2025122120452038252994F25A4BAEB043\",\n    \"search_source\": \"visual_normal_search\",\n    \"detection\": \"0.1,0.1,0.9,0.9\",\n    \"detection_index\": 0,\n    \"user_query\": \"game\",\n    \"aweme_id\": \"7523532488087817529\"\n}\n```\n\n### Response (common fields, actual response may contain more fields):\n- `status_code`: Response status code (0 means success)\n- `cursor`: Cursor for next page\n- `has_more`: Whether more data is available (1=Yes, 0=No)\n- `search_id`: Search ID for pagination\n- `data[]`: List of search results\n  - `type`: Result type\n  - `aweme_info`: Video/image post details\n    - `aweme_id`: Video ID\n    - `desc`: Video description\n    - `author`: Author information\n    - `video`: Video playback information\n    - `statistics`: Interaction statistics","operationId":"fetch_vision_search_api_v1_douyin_search_fetch_vision_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VisionSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_city_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取中国城市列表/Fetch Chinese city list","description":"# [中文]\n### 用途:\n- 获取城市列表\n### 参数:\n- 无\n### 返回:\n- 中国城市列表\n\n# [English]\n### Purpose:\n- Get city list\n### Parameters:\n- None\n### Return:\n- Chinese city list","operationId":"fetch_city_list_api_v1_douyin_billboard_fetch_city_list_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_content_tag":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取垂类内容标签/Fetch vertical content tags","description":"# [中文]\n### 用途:\n- 获取垂类内容标签\n### 参数:\n- 无\n### 返回:\n- 垂类内容标签\n### 注意:\n- 该接口用于获取垂类内容标签，用于query_tag参数构建\n### 示例:\n已知顶级垂类内容标签 `美食`，它的顶级垂类id为 `628`；`美食` 的子垂类标签 `品酒教学`，它的子垂类id为 `62802`。\n那么构建标签查询参数为 `{\"value\": 628, \"children\": [{\"value\": 62808}]}`\n\n如果需要多个子垂类标签，所有的美食子垂类标签为 `{\"value\":628,\"children\":[{\"value\":62808},{\"value\":62804},{\"value\":62806},{\"value\":62803},{\"value\":62802},{\"value\":62801},{\"value\":62811},{\"value\":62807},{\"value\":62805},{\"value\":62810}]}`\n\n# [English]\n### Purpose:\n- Get vertical content tags\n### Parameters:\n- None\n### Return:\n- Vertical content tags\n### Note:\n- This interface is used to obtain vertical content tags, used to construct the query_tag parameter\n### Example:\nGiven the top-level vertical content tag `Food`, its top-level vertical id is `628`; `Food`'s sub-vertical tag `Wine Tasting`, its sub-vertical id is `62802`.\nThen the constructed tag query parameter is `{\"value\": 628, \"children\": [{\"value\": 62808}]}`\n\nIf you need multiple sub-vertical tags, all food sub-vertical tags are `{\"value\":628,\"children\":[{\"value\":62808},{\"value\":62804},{\"value\":62806},{\"value\":62803},{\"value\":62802},{\"value\":62801},{\"value\":62811},{\"value\":62807},{\"value\":62805},{\"value\":62810}]}`","operationId":"fetch_content_tag_api_v1_douyin_billboard_fetch_content_tag_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_category_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取热点榜分类/Fetch hot list category","description":"# [中文]\n### 用途:\n- 获取热点榜分类的id与热度\n- 注意：使用start_date和end_date参数需要移除snapshot_time参数才可以生效\n### 参数:\n- billboard_type: 榜单类型\n    - rise 上升热点榜\n    - city 城市热点榜\n    - total 热点总榜\n- snapshot_time: 快照时间\n- start_date: 快照开始时间\n- end_date: 快照结束时间\n- keyword: 热点搜索词\n### 返回:\n- 热点榜分类\n\n# [English]\n### Purpose:\n- Get the id and popularity of the hot list category\n- Note: Using start_date and end_date parameters requires removing the snapshot_time parameter\n- Note: snapshot_time and start_date, end_date parameters cannot be empty at the same time\n### Parameters:\n- billboard_type: Billboard type\n    - rise Rising hot list\n    - city City hot list\n    - total Total hot list\n- snapshot_time: Snapshot time\n- start_date: Snapshot start time\n- end_date: Snapshot end time\n- keyword: Hot search term\n### Return:\n- Hot category list","operationId":"fetch_hot_category_list_api_v1_douyin_billboard_fetch_hot_category_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"billboard_type","in":"query","required":true,"schema":{"type":"string","description":"榜单类型","title":"Billboard Type"},"description":"榜单类型","example":"rise"},{"name":"snapshot_time","in":"query","required":false,"schema":{"type":"string","description":"快照时间 格式yyyyMMddHHmmss","default":"20250106151500","title":"Snapshot Time"},"description":"快照时间 格式yyyyMMddHHmmss"},{"name":"start_date","in":"query","required":false,"schema":{"type":"string","description":"快照开始时间 格式yyyyMMdd","default":"","title":"Start Date"},"description":"快照开始时间 格式yyyyMMdd"},{"name":"end_date","in":"query","required":false,"schema":{"type":"string","description":"快照结束时间 格式yyyyMMdd","default":"","title":"End Date"},"description":"快照结束时间 格式yyyyMMdd"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"热点搜索词","default":"","title":"Keyword"},"description":"热点搜索词"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_rise_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取上升热点榜/Fetch rising hot list","description":"# [中文]\n### 用途:\n- 获取上升热点榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- order: 排序方式\n    - rank 按热度排序\n    - rank_diff 按排名变化\n- sentence_tag: 热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部\n- keyword: 热点搜索词\n### 返回:\n- 上升热点榜\n\n# [English]\n### Purpose:\n- Get the rising hot list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- order: Sorting method\n    - rank Sort by popularity\n    - rank_diff Sort by ranking change\n- sentence_tag: Hot category tag, get from hot list category, multiple categories separated by commas, empty for all\n- keyword: Hot search term\n### Return:\n- Rising hot list","operationId":"fetch_hot_rise_list_api_v1_douyin_billboard_fetch_hot_rise_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","description":"页码","title":"Page"},"description":"页码","example":1},{"name":"page_size","in":"query","required":true,"schema":{"type":"integer","description":"每页数量","title":"Page Size"},"description":"每页数量","example":10},{"name":"order","in":"query","required":true,"schema":{"type":"string","description":"排序方式","title":"Order"},"description":"排序方式","example":"rank"},{"name":"sentence_tag","in":"query","required":false,"schema":{"type":"string","description":"热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部","default":"","title":"Sentence Tag"},"description":"热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"热点搜索词","default":"","title":"Keyword"},"description":"热点搜索词"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_city_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取同城热点榜/Fetch city hot list","description":"# [中文]\n### 用途:\n- 获取同城热点榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- order: 排序方式\n    - rank 按热度排序\n    - rank_diff 按排名变化\n- city_code: 城市编码，从城市列表获取，空为全部\n- sentence_tag: 热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部\n- keyword: 热点搜索词\n### 返回:\n- 同城热点榜\n\n# [English]\n### Purpose:\n- Get the city hot list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- order: Sorting method\n    - rank Sort by popularity\n    - rank_diff Sort by ranking change\n- city_code: City code, get from city list, empty for all\n- sentence_tag: Hot category tag, get from hot list category, multiple categories separated by commas, empty for all\n- keyword: Hot search term\n### Return:\n- City hot list","operationId":"fetch_hot_city_list_api_v1_douyin_billboard_fetch_hot_city_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","description":"页码","title":"Page"},"description":"页码","example":1},{"name":"page_size","in":"query","required":true,"schema":{"type":"integer","description":"每页数量","title":"Page Size"},"description":"每页数量","example":10},{"name":"order","in":"query","required":true,"schema":{"type":"string","description":"排序方式","examples":["rank","rank_diff"],"title":"Order"},"description":"排序方式"},{"name":"city_code","in":"query","required":false,"schema":{"type":"string","description":"城市编码，从城市列表获取，空为全部","default":"","title":"City Code"},"description":"城市编码，从城市列表获取，空为全部"},{"name":"sentence_tag","in":"query","required":false,"schema":{"type":"string","description":"热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部","default":"","title":"Sentence Tag"},"description":"热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"热点搜索词","default":"","title":"Keyword"},"description":"热点搜索词"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_challenge_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取挑战热榜/Fetch hot challenge list","description":"# [中文]\n### 用途:\n- 获取挑战榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- keyword: 热点搜索词\n### 返回:\n- 挑战榜\n\n# [English]\n### Purpose:\n- Get the challenge list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- keyword: Hot search term\n### Return:\n- Challenge list","operationId":"fetch_hot_challenge_list_api_v1_douyin_billboard_fetch_hot_challenge_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","description":"页码","title":"Page"},"description":"页码","example":1},{"name":"page_size","in":"query","required":true,"schema":{"type":"integer","description":"每页数量","title":"Page Size"},"description":"每页数量","example":10},{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"热点搜索词","default":"","title":"Keyword"},"description":"热点搜索词"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_total_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取热点总榜/Fetch total hot list","description":"# [中文]\n### 用途:\n- 获取热点总榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- type: 快照类型 snapshot 按时刻查看 range 按时间范围。\n    - 备注：snapshot_time 在 snapshot时有效，start_date 和 end_date 在 range 时有效\n- snapshot_time: 快照时间 格式yyyyMMddHHmmss\n- start_date: 快照开始时间 格式yyyyMMdd\n- end_date: 快照结束时间 格式yyyyMMdd\n- sentence_tag: 热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部\n- keyword: 热点搜索词\n### 返回:\n- 热点总榜\n\n# [English]\n### Purpose:\n- Get the total hot list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- type: Snapshot type snapshot view by time range view by time range.\n    - Note: snapshot_time is valid when snapshot, start_date and end_date are valid when range\n- snapshot_time: Snapshot time format yyyyMMddHHmmss\n- start_date: Snapshot start time format yyyyMMdd\n- end_date: Snapshot end time format yyyyMMdd\n- sentence_tag: Hot category tag, get from hot list category, multiple categories separated by commas, empty for all\n- keyword: Hot search term\n### Return:\n- Total hot list","operationId":"fetch_hot_total_list_api_v1_douyin_billboard_fetch_hot_total_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":true,"schema":{"type":"integer","description":"页码","title":"Page"},"description":"页码","example":1},{"name":"page_size","in":"query","required":true,"schema":{"type":"integer","description":"每页数量","title":"Page Size"},"description":"每页数量","example":10},{"name":"type","in":"query","required":true,"schema":{"type":"string","description":"快照类型 snapshot 按时刻查看 range 按时间范围","examples":["snapshot","range"],"title":"Type"},"description":"快照类型 snapshot 按时刻查看 range 按时间范围"},{"name":"snapshot_time","in":"query","required":false,"schema":{"type":"string","description":"快照时间 格式yyyyMMddHHmmss","default":"20250106151500","title":"Snapshot Time"},"description":"快照时间 格式yyyyMMddHHmmss"},{"name":"start_date","in":"query","required":false,"schema":{"type":"string","description":"快照开始时间 格式yyyyMMdd","default":"","title":"Start Date"},"description":"快照开始时间 格式yyyyMMdd"},{"name":"end_date","in":"query","required":false,"schema":{"type":"string","description":"快照结束时间 格式yyyyMMdd","default":"","title":"End Date"},"description":"快照结束时间 格式yyyyMMdd"},{"name":"sentence_tag","in":"query","required":false,"schema":{"type":"string","description":"热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部","default":"","title":"Sentence Tag"},"description":"热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string","description":"热点搜索词","default":"","title":"Keyword"},"description":"热点搜索词"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_calendar_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取活动日历/Fetch activity calendar","description":"# [中文]\n### 用途:\n- 获取活动日历\n### 参数:\n- city_code: 城市编码，从城市列表获取，空为全部\n- category_code: 热点榜分类编码，从热点榜分类获取，空为全部\n- end_date: 快照结束时间 格式10位时间戳\n- start_date: 快照开始时间 格式10位时间戳\n### 返回:\n- 活动日历\n\n# [English]\n### Purpose:\n- Get the activity calendar\n### Parameters:\n- city_code: City code, get from city list, empty for all\n- category_code: Hot list category code, get from hot list category, empty for all\n- end_date: Snapshot end time format 10 digit timestamp\n- start_date: Snapshot start time format 10 digit timestamp\n### Return:\n- Activity calendar","operationId":"fetch_hot_calendar_list_api_v1_douyin_billboard_fetch_hot_calendar_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_calendar_list_api_v1_douyin_billboard_fetch_hot_calendar_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_calendar_detail":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取活动日历详情/Fetch activity calendar detail","description":"# [中文]\n### 用途:\n- 获取活动日历详情\n### 参数:\n- calendar_id: 活动id\n### 返回:\n- 活动日历详情\n\n# [English]\n### Purpose:\n- Get the activity calendar details\n### Parameters:\n- calendar_id: Activity id\n### Return:\n- Activity calendar details","operationId":"fetch_hot_calendar_detail_api_v1_douyin_billboard_fetch_hot_calendar_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"calendar_id","in":"query","required":true,"schema":{"type":"string","description":"活动id","title":"Calendar Id"},"description":"活动id","example":"1720"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_user_portrait_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取作品点赞观众画像-仅限热门榜/Fetch work like audience portrait - hot list only","description":"# [中文]\n### 用途:\n- 获取作品点赞观众画像\n### 参数:\n- aweme_id: 作品id\n- option: 选项，1 手机价格分布 2 性别分布 3 年龄分布 4 地域分布-省份 5 地域分布-城市 6 城市等级 7 手机品牌分布\n### 返回:\n- 作品点赞观众画像\n\n# [English]\n### Purpose:\n- Get the work like audience portrait\n### Parameters:\n- aweme_id: Work id\n- option: Option\n    - 1 Mobile price\n    - 2 Gender distribution\n    - 3 Age distribution\n    - 4 Regional distribution - province\n    - 5 Regional distribution - city\n    - 6 City level\n    - 7 Mobile brand distribution\n### Return:\n- Work like audience portrait","operationId":"fetch_hot_user_portrait_list_api_v1_douyin_billboard_fetch_hot_user_portrait_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id","title":"Aweme Id"},"description":"作品id","example":"7456035425539329340"},{"name":"option","in":"query","required":false,"schema":{"type":"integer","description":"选项，1 手机价格分布 2 性别分布 3 年龄分布 4 地域分布-省份 5 地域分布-城市 6 城市等级 7 手机品牌分布","examples":[1,2,3,4,5,6,7],"default":4,"title":"Option"},"description":"选项，1 手机价格分布 2 性别分布 3 年龄分布 4 地域分布-省份 5 地域分布-城市 6 城市等级 7 手机品牌分布"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_comment_word_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取作品评论分析-词云权重/Fetch work comment analysis word cloud weight","description":"# [中文]\n### 用途:\n- 获取作品评论分析-词云权重\n### 参数:\n- aweme_id: 作品id\n### 返回:\n- 作品评论分析-词云权重\n\n# [English]\n### Purpose:\n- Get the work comment analysis word cloud weight\n### Parameters:\n- aweme_id: Work id\n### Return:\n- Work comment analysis word cloud weight","operationId":"fetch_hot_comment_word_list_api_v1_douyin_billboard_fetch_hot_comment_word_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品id","title":"Aweme Id"},"description":"作品id","example":"7456035425539329340"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_item_trends_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取作品数据趋势/Fetch post data trend","description":"# [中文]\n### 用途:\n- 获取作品数据趋势\n### 参数:\n- aweme_id: 作品id\n- option: 选项，7 点赞量 8 分享量 9 评论量\n- date_window: 时间窗口，1 按小时 2 按天\n### 返回:\n- 作品数据趋势\n\n# [English]\n### Purpose:\n- Get the work data trend\n### Parameters:\n- aweme_id: Work id\n- option: Option, 7 Like 8 Share 9 Comment\n- date_window: Time window, 1 by hour 2 by day\n### Return:\n- Work data trend","operationId":"fetch_hot_item_trends_list_api_v1_douyin_billboard_fetch_hot_item_trends_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":false,"schema":{"type":"string","description":"作品id","default":"","title":"Aweme Id"},"description":"作品id"},{"name":"option","in":"query","required":false,"schema":{"type":"integer","description":"选项，7 点赞量 8 分享量 9 评论量","examples":[7,8,9],"default":7,"title":"Option"},"description":"选项，7 点赞量 8 分享量 9 评论量"},{"name":"date_window","in":"query","required":false,"schema":{"type":"integer","description":"时间窗口，1 按小时 2 按天","examples":[1,2],"default":1,"title":"Date Window"},"description":"时间窗口，1 按小时 2 按天"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_account_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取热门账号/Fetch hot account list","description":"# [中文]\n### 用途:\n- 获取热门账号\n### 参数:\n- date_window: 时间窗口，格式 小时，默认24小时\n- page_num: 页码，默认1\n- page_size: 每页数量，默认20\n- query_tag: 子级垂类标签，空则为全部，多个标签需传入\n{\"value\": \"{顶级垂类标签id}\", \"children\": [\n    {\"value\": \"{子级垂类标签id}\"},\n    {\"value\": \"{子级垂类标签id}\"}\n]}\n### 返回:\n- 热门账号\n\n# [English]\n### Purpose:\n- Get the hot account\n### Parameters:\n- date_window: Time window, format hour, default 24 hours\n- page_num: Page number, default 1\n- page_size: Number of items per page, default 20\n- query_tag: Sub-level vertical category tag, empty for all, multiple tags need to be passed in\n{\"value\": \"{top-level vertical category id}\", \"children\": [\n    {\"value\": \"{sub-level vertical category id}\"},\n    {\"value\": \"{sub-level vertical category id}\"}\n]}\n### Return:\n- Hot account","operationId":"fetch_hot_account_list_api_v1_douyin_billboard_fetch_hot_account_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_account_list_api_v1_douyin_billboard_fetch_hot_account_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_account_search_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"搜索用户名或抖音号/Fetch account search list","description":"# [中文]\n### 用途:\n- 获取搜索用户名或抖音号\n### 参数:\n- keyword: 搜索的用户名或抖音号\n- cursor: 游标，默认空\n### 返回:\n- 搜索结果\n\n# [English]\n### Purpose:\n- Get the search username or Douyin number\n### Parameters:\n- keyword: Search username or Douyin number\n- cursor: Cursor, default empty\n### Return:\n- Search result","operationId":"fetch_hot_account_search_list_api_v1_douyin_billboard_fetch_hot_account_search_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索的用户名或抖音号","title":"Keyword"},"description":"搜索的用户名或抖音号","example":"rmrbxmt"},{"name":"cursor","in":"query","required":true,"schema":{"type":"integer","description":"游标，默认空","title":"Cursor"},"description":"游标，默认空","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_account_trends_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取账号粉丝数据趋势/Fetch account fan data trend","description":"# [中文]\n### 用途:\n- 获取账号粉丝数据趋势\n### 参数:\n- sec_uid: 用户sec_id\n- option: 选项，2 新增点赞量 3 新增作品量 4 新增评论量 5 新增分享量\n- date_window: 时间窗口，1 按小时 2 按天\n### 返回:\n- 账号粉丝数据趋势\n\n# [English]\n### Purpose:\n- Get the account fan data trend\n### Parameters:\n- sec_uid: User sec_id\n- option: Option, 2 New like 3 New work 4 New comment 5 New share\n- date_window: Time window, 1 by hour 2 by day\n### Return:\n- Account fan data trend","operationId":"fetch_hot_account_trends_list_api_v1_douyin_billboard_fetch_hot_account_trends_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_id","title":"Sec Uid"},"description":"用户sec_id","example":"MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4"},{"name":"option","in":"query","required":false,"schema":{"type":"integer","description":"选项，2 新增点赞量 3 新增作品量 4 新增评论量 5 新增分享量","examples":[2,3,4,5],"default":2,"title":"Option"},"description":"选项，2 新增点赞量 3 新增作品量 4 新增评论量 5 新增分享量"},{"name":"date_window","in":"query","required":false,"schema":{"type":"integer","description":"时间窗口，1 按小时 2 按天","default":24,"title":"Date Window"},"description":"时间窗口，1 按小时 2 按天","example":24}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_account_item_analysis_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取账号作品分析-上周/Fetch account work analysis - last week","description":"# [中文]\n### 用途:\n- 获取账号作品分析\n### 参数:\n- sec_uid: 用户sec_id\n- day: 天数，默认7天\n### 返回:\n- 账号作品分析\n\n# [English]\n### Purpose:\n- Get the account work analysis\n### Parameters:\n- sec_uid: User sec_id\n- day: Number of days, default 7 days\n### Return:\n- Account work analysis","operationId":"fetch_hot_account_item_analysis_list_api_v1_douyin_billboard_fetch_hot_account_item_analysis_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_id","title":"Sec Uid"},"description":"用户sec_id","example":"MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_account_fans_portrait_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取粉丝画像/Fetch fan portrait","description":"# [中文]\n### 用途:\n- 获取粉丝画像\n### 参数:\n- sec_uid: 用户sec_id\n- option: 选项，默认值为：1 手机价格分布\n    - `1` = 手机价格分布\n    - `2` = 性别分布\n    - `3` = 年龄分布\n    - `4` = 地域分布-省份\n    - `5` = 地域分布-城市\n    - `6` = 城市等级\n    - `7` = 手机品牌分布\n    - `8` = 兴趣标签分析 百分比\n### 返回:\n- 粉丝画像\n\n# [English]\n### Purpose:\n- Get the fan portrait\n### Parameters:\n- sec_uid: User sec_id\n- option: Option\n    - 1 Mobile price\n    - 2 Gender distribution\n    - 3 Age distribution\n    - 4 Regional distribution - province\n    - 5 Regional distribution - city\n    - 6 City level\n    - 7 Mobile brand distribution\n    - 8 Interest tag analysis percentage\n### Return:\n- Fan portrait","operationId":"fetch_hot_account_fans_portrait_list_api_v1_douyin_billboard_fetch_hot_account_fans_portrait_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_id","title":"Sec Uid"},"description":"用户sec_id","example":"MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4"},{"name":"option","in":"query","required":false,"schema":{"type":"integer","description":"选项，1 手机价格分布 2 性别分布 3 年龄分布 4 地域分布-省份 5 地域分布-城市 6 城市等级 7 手机品牌分布 8 兴趣标签分析 百分比","default":1,"title":"Option"},"description":"选项，1 手机价格分布 2 性别分布 3 年龄分布 4 地域分布-省份 5 地域分布-城市 6 城市等级 7 手机品牌分布 8 兴趣标签分析 百分比","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_account_fans_interest_account_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取粉丝兴趣作者 20个用户/Fetch fan interest author 20 users","description":"# [中文]\n### 用途:\n- 获取粉丝兴趣作者 20个用户\n### 参数:\n- sec_uid: 用户sec_id\n### 返回:\n- 粉丝兴趣作者 20个用户\n\n# [English]\n### Purpose:\n- Get the fan interest author 20 users\n### Parameters:\n- sec_uid: User sec_id\n### Return:\n- Fan interest author 20 users","operationId":"fetch_hot_account_fans_interest_account_list_api_v1_douyin_billboard_fetch_hot_account_fans_interest_account_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_id","title":"Sec Uid"},"description":"用户sec_id","example":"MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_account_fans_interest_topic_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取粉丝近3天感兴趣的话题 10个话题/Fetch fan interest topic in the last 3 days 10 topics","description":"# [中文]\n### 用途:\n- 获取粉丝近3天感兴趣的话题 10个话题\n### 参数:\n- sec_uid: 用户sec_id\n### 返回:\n- 粉丝近3天感兴趣的话题 10个话题\n\n# [English]\n### Purpose:\n- Get the fan interest topic in the last 3 days 10 topics\n### Parameters:\n- sec_uid: User sec_id\n### Return:\n- Fan interest topic in the last 3 days 10 topics","operationId":"fetch_hot_account_fans_interest_topic_list_api_v1_douyin_billboard_fetch_hot_account_fans_interest_topic_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_id","title":"Sec Uid"},"description":"用户sec_id","example":"MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_account_fans_interest_search_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取粉丝近3天搜索词 10个搜索词/Fetch fan interest search term in the last 3 days 10 search terms","description":"# [中文]\n### 用途:\n- 获取粉丝近3天搜索词 10个搜索词\n### 参数:\n- sec_uid: 用户sec_id\n### 返回:\n- 粉丝近3天搜索词 10个搜索词\n\n# [English]\n### Purpose:\n- Get the fan interest search term in the last 3 days 10 search terms\n### Parameters:\n- sec_uid: User sec_id\n### Return:\n- Fan interest search term in the last 3 days 10 search terms","operationId":"fetch_hot_account_fans_interest_search_list_api_v1_douyin_billboard_fetch_hot_account_fans_interest_search_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_uid","in":"query","required":true,"schema":{"type":"string","description":"用户sec_id","title":"Sec Uid"},"description":"用户sec_id","example":"MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/billboard/fetch_hot_total_video_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取视频热榜/Fetch video hot list","description":"# [中文]\n### 用途:\n- 获取视频榜\n### 参数:\n- page: 页码，默认1\n- page_size: 每页数量，默认10\n- date_window: 时间窗口，1 按小时 2 按天\n- sub_type: 榜单分类，1001 视频总榜 1002 低粉爆款 1003 高完播率 1004 高涨粉率 1005 高点赞率\n- tags: 子级垂类标签，空则为全部，多个标签需传入\n    {\"value\": \"{顶级垂类标签id}\", \"children\": [\n        {\"value\": \"{子级垂类标签id}\"},\n        {\"value\": \"{子级垂类标签id}\"}\n    ]}\n### 返回:\n- 视频榜\n\n# [English]\n### Purpose:\n- Get the video list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- sub_type: List category, 1001 Video total list 1002 Low fan explosion 1003 High completion rate 1004 High fan growth rate 1005 High like rate\n- tags: Sub-level vertical category tag, empty for all, multiple tags need to be passed in\n    {\"value\": \"{top-level vertical category id}\", \"children\": [\n        {\"value\": \"{sub-level vertical category id}\"},\n        {\"value\": \"{sub-level vertical category id}\"}\n    ]}\n### Return:\n- Video list","operationId":"fetch_hot_total_video_list_api_v1_douyin_billboard_fetch_hot_total_video_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_video_list_api_v1_douyin_billboard_fetch_hot_total_video_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_low_fan_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取低粉爆款榜/Fetch low fan explosion list","description":"# [中文]\n### 用途:\n- 获取低粉爆款榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- date_window: 时间窗口，1 按小时 2 按天\n- tags: 子级垂类标签，空则为全部，多个标签需传入\n    {\"value\": \"{顶级垂类标签id}\", \"children\": [\n        {\"value\": \"{子级垂类标签id}\"},\n        {\"value\": \"{子级垂类标签id}\"}\n    ]}\n### 返回:\n- 低粉爆款榜\n\n# [English]\n### Purpose:\n- Get the low fan explosion list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- tags: Sub-level vertical category tag, empty for all, multiple tags need to be passed in\n    {\"value\": \"{top-level vertical category id}\", \"children\": [\n        {\"value\": \"{sub-level vertical category id}\"},\n        {\"value\": \"{sub-level vertical category id}\"}\n    ]}\n### Return:\n- Low fan explosion list","operationId":"fetch_hot_total_low_fan_list_api_v1_douyin_billboard_fetch_hot_total_low_fan_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_low_fan_list_api_v1_douyin_billboard_fetch_hot_total_low_fan_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_high_play_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取高完播率榜/Fetch high completion rate list","description":"# [中文]\n### 用途:\n- 获取高完播率榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- date_window: 时间窗口，1 按小时 2 按天\n- tags: 子级垂类标签，空则为全部，多个标签需传入\n    {\"value\": \"{顶级垂类标签id}\", \"children\": [\n        {\"value\": \"{子级垂类标签id}\"},\n        {\"value\": \"{子级垂类标签id}\"}\n    ]}\n### 返回:\n- 高完播率榜\n\n# [English]\n### Purpose:\n- Get the high completion rate list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- tags: Sub-level vertical category tag, empty for all, multiple tags need to be passed in\n    {\"value\": \"{top-level vertical category id}\", \"children\": [\n        {\"value\": \"{sub-level vertical category id}\"},\n        {\"value\": \"{sub-level vertical category id}\"}\n    ]}\n### Return:\n- High completion rate list","operationId":"fetch_hot_total_high_play_list_api_v1_douyin_billboard_fetch_hot_total_high_play_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_high_play_list_api_v1_douyin_billboard_fetch_hot_total_high_play_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_high_like_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取高点赞率榜/Fetch high like rate list","description":"# [中文]\n### 用途:\n- 获取高点赞率榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- date_window: 时间窗口，1 按小时 2 按天\n- tags: 子级垂类标签，空则为全部，多个标签需传入\n    {\"value\": \"{顶级垂类标签id}\", \"children\": [\n        {\"value\": \"{子级垂类标签id}\"},\n        {\"value\": \"{子级垂类标签id}\"}\n    ]}\n### 返回:\n- 高点赞率榜\n\n# [English]\n### Purpose:\n- Get the high like rate list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- tags: Sub-level vertical category tag, empty for all, multiple tags need to be passed in\n    {\"value\": \"{top-level vertical category id}\", \"children\": [\n        {\"value\": \"{sub-level vertical category id}\"},\n        {\"value\": \"{sub-level vertical category id}\"}\n    ]}\n### Return:\n- High like rate list","operationId":"fetch_hot_total_high_like_list_api_v1_douyin_billboard_fetch_hot_total_high_like_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_high_like_list_api_v1_douyin_billboard_fetch_hot_total_high_like_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_high_fan_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取高涨粉率榜/Fetch high fan rate list","description":"# [中文]\n### 用途:\n- 获取高涨粉率榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- date_window: 时间窗口，1 按小时 2 按天\n- tags: 子级垂类标签，空则为全部，多个标签需传入\n    {\"value\": \"{顶级垂类标签id}\", \"children\": [\n        {\"value\": \"{子级垂类标签id}\"},\n        {\"value\": \"{子级垂类标签id}\"}\n    ]}\n### 返回:\n- 高涨粉率榜\n\n# [English]\n### Purpose:\n- Get the high fan rate list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- tags: Sub-level vertical category tag, empty for all, multiple tags need to be passed in\n    {\"value\": \"{top-level vertical category id}\", \"children\": [\n        {\"value\": \"{sub-level vertical category id}\"},\n        {\"value\": \"{sub-level vertical category id}\"}\n    ]}\n### Return:\n- High fan rate list","operationId":"fetch_hot_total_high_fan_list_api_v1_douyin_billboard_fetch_hot_total_high_fan_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_high_fan_list_api_v1_douyin_billboard_fetch_hot_total_high_fan_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_topic_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取话题热榜/Fetch topic hot list","description":"# [中文]\n### 用途:\n- 获取话题榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- date_window: 时间窗口，1 按小时 2 按天\n- tags: 子级垂类标签，空则为全部，多个标签需传入\n    {\"value\": \"{顶级垂类标签id}\", \"children\": [\n        {\"value\": \"{子级垂类标签id}\"},\n        {\"value\": \"{子级垂类标签id}\"}\n    ]}\n### 返回:\n- 话题榜\n\n# [English]\n### Purpose:\n- Get the topic list\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- tags: Sub-level vertical category tag, empty for all, multiple tags need to be passed in\n    {\"value\": \"{top-level vertical category id}\", \"children\": [\n        {\"value\": \"{sub-level vertical category id}\"},\n        {\"value\": \"{sub-level vertical category id}\"}\n    ]}\n### Return:\n- Topic list","operationId":"fetch_hot_total_topic_list_api_v1_douyin_billboard_fetch_hot_total_topic_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_topic_list_api_v1_douyin_billboard_fetch_hot_total_topic_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_high_topic_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取热度飙升的话题榜/Fetch topic list with rising popularity","description":"# [中文]\n### 用途:\n- 获取热度飙升的话题榜\n### 参数:\n- page: 页码\n- page_size: 每页数量\n- date_window: 时间窗口，1 按小时 2 按天\n- tags: 子级垂类标签，空则为全部，多个标签需传入\n    {\"value\": \"{顶级垂类标签id}\", \"children\": [\n        {\"value\": \"{子级垂类标签id}\"},\n        {\"value\": \"{子级垂类标签id}\"}\n    ]}\n### 返回:\n- 热度飙升的话题榜\n\n# [English]\n### Purpose:\n- Get the topic list with rising popularity\n### Parameters:\n- page: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- tags: Sub-level vertical category tag, empty for all, multiple tags need to be passed in\n    {\"value\": \"{top-level vertical category id}\", \"children\": [\n        {\"value\": \"{sub-level vertical category id}\"},\n        {\"value\": \"{sub-level vertical category id}\"}\n    ]}\n### Return:\n- Topic list with rising popularity","operationId":"fetch_hot_total_high_topic_list_api_v1_douyin_billboard_fetch_hot_total_high_topic_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_high_topic_list_api_v1_douyin_billboard_fetch_hot_total_high_topic_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_search_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取搜索热榜/Fetch search hot list","description":"# [中文]\n### 用途:\n- 获取搜索榜\n### 参数:\n- page_num: 页码\n- page_size: 每页数量\n- date_window: 时间窗口，1 按小时 2 按天\n- keyword: 搜索关键字\n### 返回:\n- 搜索榜\n\n# [English]\n### Purpose:\n- Get the search list\n### Parameters:\n- page_num: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- keyword: Search keyword\n### Return:\n- Search list","operationId":"fetch_hot_total_search_list_api_v1_douyin_billboard_fetch_hot_total_search_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_search_list_api_v1_douyin_billboard_fetch_hot_total_search_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_high_search_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取热度飙升的搜索榜/Fetch search list with rising popularity","description":"# [中文]\n### 用途:\n- 获取热度飙升的搜索榜\n### 参数:\n- page_num: 页码\n- page_size: 每页数量\n- date_window: 时间窗口，1 按小时 2 按天\n- keyword: 搜索关键字\n### 返回:\n- 热度飙升的搜索榜\n\n# [English]\n### Purpose:\n- Get the search list with rising popularity\n### Parameters:\n- page_num: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- keyword: Search keyword\n### Return:\n- Search list with rising popularity","operationId":"fetch_hot_total_high_search_list_api_v1_douyin_billboard_fetch_hot_total_high_search_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_high_search_list_api_v1_douyin_billboard_fetch_hot_total_high_search_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_hot_word_list":{"post":{"tags":["Douyin-Billboard-API"],"summary":"获取全部热门内容词/Fetch all hot content words","description":"# [中文]\n### 用途:\n- 获取全部内容词\n### 参数:\n- page_num: 页码\n- page_size: 每页数量\n- date_window: 时间窗口，1 按小时 2 按天\n- keyword: 搜索关键字\n### 返回:\n- 全部内容词\n\n# [English]\n### Purpose:\n- Get the list of all content words\n### Parameters:\n- page_num: Page number\n- page_size: Number of items per page\n- date_window: Time window, 1 by hour 2 by day\n- keyword: Search keyword\n### Return:\n- List of all content words","operationId":"fetch_hot_total_hot_word_list_api_v1_douyin_billboard_fetch_hot_total_hot_word_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_fetch_hot_total_hot_word_list_api_v1_douyin_billboard_fetch_hot_total_hot_word_list_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/billboard/fetch_hot_total_hot_word_detail_list":{"get":{"tags":["Douyin-Billboard-API"],"summary":"获取内容词详情/Fetch content word details","description":"# [中文]\n### 用途:\n- 获取内容词详情\n### 参数:\n- keyword: 搜索关键字\n- word_id: 内容词id\n- query_day: 查询日期，格式为YYYYMMDD\n### 返回:\n- 内容词详情\n\n# [English]\n### Purpose:\n- Get the details of content words\n### Parameters:\n- keyword: Search keyword\n- word_id: Content word id\n- query_day: Query date, format is YYYYMMDD\n### Return:\n- Details of content words","operationId":"fetch_hot_total_hot_word_detail_list_api_v1_douyin_billboard_fetch_hot_total_hot_word_detail_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键字","title":"Keyword"},"description":"搜索关键字","example":""},{"name":"word_id","in":"query","required":true,"schema":{"type":"string","description":"内容词id","title":"Word Id"},"description":"内容词id","example":""},{"name":"query_day","in":"query","required":true,"schema":{"type":"integer","description":"查询日期，格式为YYYYMMDD，需为当日","title":"Query Day"},"description":"查询日期，格式为YYYYMMDD，需为当日","example":20250105}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/get_sign_image":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取加密图片解析/Get Sign Image","description":"# [中文]\n### 用途:\n- 解析星图加密图片，获取可访问的图片URL\n- 价格：0.001$ / 次\n### 参数:\n- uri: 图片的uri，通常从其他星图接口返回的数据中获取\n    - 例如：`tos-cn-i-0813c000-ce/oMKzDA3A9QGAuebfsDIAwlDoAfCFEEzSEw8FQZ`\n- durationTS: 有效期时长（秒），默认86400（24小时）\n- format: 图片格式，默认webp，支持：webp、jpg、png等\n### 返回:\n- 解析后的图片数据，包含可访问的图片URL\n\n# [English]\n### Purpose:\n- Parse encrypted XingTu image and get accessible image URL\n- Price: 0.001$ / time\n### Parameters:\n- uri: Image URI, usually obtained from other XingTu API responses\n    - Example: `tos-cn-i-0813c000-ce/oMKzDA3A9QGAuebfsDIAwlDoAfCFEEzSEw8FQZ`\n- durationTS: Duration in seconds, default 86400 (24 hours)\n- format: Image format, default webp, supports: webp, jpg, png, etc.\n### Return:\n- Parsed image data with accessible image URL\n\n# [示例/Example]\nuri = \"tos-cn-i-0813c000-ce/oMKzDA3A9QGAuebfsDIAwlDoAfCFEEzSEw8FQZ\"\ndurationTS = 86400\nformat = \"webp\"","operationId":"get_sign_image_api_v1_douyin_xingtu_get_sign_image_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uri","in":"query","required":true,"schema":{"type":"string","description":"图片的uri/Image URI","title":"Uri"},"description":"图片的uri/Image URI","example":"tos-cn-i-0813c000-ce/oMKzDA3A9QGAuebfsDIAwlDoAfCFEEzSEw8FQZ"},{"name":"durationTS","in":"query","required":false,"schema":{"type":"integer","description":"有效期时长（秒）/Duration in seconds","default":86400,"title":"Durationts"},"description":"有效期时长（秒）/Duration in seconds","example":86400},{"name":"format","in":"query","required":false,"schema":{"type":"string","description":"图片格式/Image format","default":"webp","title":"Format"},"description":"图片格式/Image format","example":"webp"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"根据抖音用户ID获取游客星图kolid/Get XingTu kolid by Douyin User ID","description":"# [中文]\n### 用途:\n- 通过抖音用户ID获取游客星图kolid\n- 价格：0.001$ / 次\n### 参数:\n- uid: 用户ID, 可以从接口以下接口获取：\n    - `/api/v1/douyin/web/fetch_user_profile_by_uid`\n    - `/api/v1/douyin/web/fetch_user_profile_by_short_id`\n    - `/api/v1/douyin/web/handler_user_profile`\n    - `/api/v1/douyin/web/handler_user_profile_v2`\n    - `/api/v1/douyin/web/handler_user_profile_v3`\n    - `/api/v1/douyin/app/v3/handler_user_profile`\n### 返回:\n- 游客星图kolid\n\n# [English]\n### Purpose:\n- Get XingTu kolid by Douyin User ID\n- Price: 0.001$ / time\n### Parameters:\n- uid: User ID, can be obtained from the following interfaces:\n    - `/api/v1/douyin/web/fetch_user_profile_by_uid`\n    - `/api/v1/douyin/web/fetch_user_profile_by_short_id`\n    - `/api/v1/douyin/web/handler_user_profile`\n    - `/api/v1/douyin/web/handler_user_profile_v2`\n    - `/api/v1/douyin/web/handler_user_profile_v3`\n    - `/api/v1/douyin/app/v3/handler_user_profile`\n### Return:\n- XingTu kolid\n\n# [示例/Example]\nuid = \"70452002324\"","operationId":"get_xingtu_kolid_by_uid_api_v1_douyin_xingtu_get_xingtu_kolid_by_uid_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"抖音用户ID/Douyin User ID","title":"Uid"},"description":"抖音用户ID/Douyin User ID","example":"70452002324"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"根据抖音sec_user_id获取游客星图kolid/Get XingTu kolid by Douyin sec_user_id","description":"# [中文]\n### 用途:\n- 通过抖音sec_user_id获取游客星图kolid\n- 价格：0.001$ / 次\n### 参数:\n- sec_user_id: sec_user_id, 可以从接口以下接口获取：\n    - `/api/v1/douyin/web/handler_user_profile`\n    - `/api/v1/douyin/web/handler_user_profile_v2`\n    - `/api/v1/douyin/web/handler_user_profile_v3`\n    - `/api/v1/douyin/app/v3/handler_user_profile`\n### 返回:\n- 游客星图kolid\n\n# [English]\n### Purpose:\n- Get XingTu kolid by Douyin sec_user_id\n- Price: 0.001$ / time\n### Parameters:\n- sec_user_id: sec_user_id, can be obtained from the following interfaces:\n    - `/api/v1/douyin/web/handler_user_profile`\n    - `/api/v1/douyin/web/handler_user_profile_v2`\n    - `/api/v1/douyin/web/handler_user_profile_v3`\n    - `/api/v1/douyin/app/v3/handler_user_profile`\n### Return:\n- XingTu kolid\n\n# [示例/Example]\nsec_user_id = \"MS4wLjABAAAAoxwUZouIdKL6sZ8EB96KDjkrhfBMS1KbCgsMJR1kIUs\"","operationId":"get_xingtu_kolid_by_sec_user_id_api_v1_douyin_xingtu_get_xingtu_kolid_by_sec_user_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sec_user_id","in":"query","required":true,"schema":{"type":"string","description":"抖音用户sec_user_id/Douyin User sec_user_id","title":"Sec User Id"},"description":"抖音用户sec_user_id/Douyin User sec_user_id","example":"MS4wLjABAAAAoxwUZouIdKL6sZ8EB96KDjkrhfBMS1KbCgsMJR1kIUs"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"根据抖音号获取游客星图kolid/Get XingTu kolid by Douyin unique_id","description":"# [中文]\n### 用途:\n- 通过抖音号获取游客星图kolid\n- 价格：0.001$ / 次\n### 参数:\n- unique_id: 抖音号, 可以从接口以下接口获取：\n    - `/api/v1/douyin/web/handler_user_profile`\n    - `/api/v1/douyin/web/handler_user_profile_v2`\n    - `/api/v1/douyin/web/handler_user_profile_v3`\n    - `/api/v1/douyin/app/v3/handler_user_profile`\n### 返回:\n- 游客星图kolid\n\n# [English]\n### Purpose:\n- Get XingTu kolid by Douyin unique_id\n- Price: 0.001$ / time\n### Parameters:\n- unique_id: unique_id, can be obtained from the following interfaces:\n    - `/api/v1/douyin/web/handler_user_profile`\n    - `/api/v1/douyin/web/handler_user_profile_v2`\n    - `/api/v1/douyin/web/handler_user_profile_v3`\n    - `/api/v1/douyin/app/v3/handler_user_profile`\n### Return:\n- XingTu kolid\n\n# [示例/Example]\nunique_id = \"m6640150\"","operationId":"get_xingtu_kolid_by_unique_id_api_v1_douyin_xingtu_get_xingtu_kolid_by_unique_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"unique_id","in":"query","required":true,"schema":{"type":"string","description":"抖音号/Douyin User unique_id","title":"Unique Id"},"description":"抖音号/Douyin User unique_id","example":"m6640150"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_base_info_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol基本信息V1/Get kol Base Info V1","description":"# [中文]\n### 用途:\n- 获取kol基本信息V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- platformChannel:\n    - 平台渠道，支持以下参数:\n    - _1 :抖音短视频(Video)\n    - _10 :抖音直播(Live)\n### 返回:\n- kol基本信息\n\n# [English]\n### Purpose:\n- Get kol Base Info V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- platformChannel:\n    - Platform channel, supports the following parameters:\n    - _1 :Douyin Video\n    - _10 :Douyin Live\n### Return:\n- kol Base Info\n\n# [示例/Example]\nkolId = \"7048929565493690398\"\nplatformChannel = \"_1\"","operationId":"kol_base_info_v1_api_v1_douyin_xingtu_kol_base_info_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"},{"name":"platformChannel","in":"query","required":true,"schema":{"type":"string","description":"平台渠道/Platform Channel","title":"Platformchannel"},"description":"平台渠道/Platform Channel","example":"_1"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_audience_portrait_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol观众画像V1/Get kol Audience Portrait V1","description":"# [中文]\n### 用途:\n- 获取kol观众画像V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### 返回:\n- kol观众画像\n\n# [English]\n### Purpose:\n- Get kol Audience Portrait V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### Return:\n- kol Audience Portrait\n\n# [示例/Example]\nkolId = \"7048929565493690398\"","operationId":"kol_audience_portrait_v1_api_v1_douyin_xingtu_kol_audience_portrait_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_fans_portrait_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol粉丝画像V1/Get kol Fans Portrait V1","description":"# [中文]\n### 用途:\n- 获取kol粉丝画像V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- fansType: 粉丝类型，支持以下参数:\n    - _1: 粉丝画像 (Fans Portrait) - 默认值\n    - _2: 粉丝团画像 (Fans Group Portrait)\n    - _5: 铁粉画像 (Iron Fans Portrait)\n### 返回:\n- kol粉丝画像\n\n# [English]\n### Purpose:\n- Get kol Fans Portrait V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- fansType: Fans Type, supports the following parameters:\n    - _1: Fans Portrait - Default\n    - _2: Fans Group Portrait\n    - _5: Iron Fans Portrait\n### Return:\n- kol Fans Portrait\n\n# [示例/Example]\nkolId = \"7048929565493690398\"\nfansType = \"_1\"","operationId":"kol_fans_portrait_v1_api_v1_douyin_xingtu_kol_fans_portrait_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"},{"name":"fansType","in":"query","required":false,"schema":{"type":"string","description":"粉丝类型/Fans Type","default":"_1","title":"Fanstype"},"description":"粉丝类型/Fans Type","example":"_1"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_service_price_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol服务报价V1/Get kol Service Price V1","description":"# [中文]\n### 用途:\n- 获取kol服务报价V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- platformChannel:\n    - 平台渠道，支持以下参数:\n    - _1: 抖音短视频(Video)\n    - _10: 抖音直播(Live)\n### 返回:\nkol服务报价\n\n# [English]\n### Purpose:\n- Get kol Service Price V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- platformChannel:\n    - Platform channel, supports the following parameters:\n    - _1: Douyin Video\n    - _10: Douyin Live\n### Return:\n- kol Service Price\n\n# [示例/Example]\nkolId = \"7048929565493690398\"\nplatformChannel = \"_1\"","operationId":"kol_service_price_v1_api_v1_douyin_xingtu_kol_service_price_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"},{"name":"platformChannel","in":"query","required":true,"schema":{"type":"string","description":"平台渠道/Platform Channel","title":"Platformchannel"},"description":"平台渠道/Platform Channel","example":"_1"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_data_overview_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol数据概览V1/Get kol Data Overview V1","description":"# [中文]\n### 用途:\n- 获取kol数据概览V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- _type: 类型, 支持以下参数:\n    - _1 :个人视频(personal video)\n    - _2 :星图视频(xingtu video)\n- _range: 范围, 支持以下参数:\n    - _2 :近30天(last 30 days)\n    - _3 :近90天(last 90 days)\n- flowType: 流量类型, 支持以下参数:\n    - 1 : 默认(default)\n- onlyAssign (可选): 是否指派，具体参数如下:\n    - 不传递 : 使用API默认行为\n    - false : 全部数据\n    - true : 仅指派数据\n### 返回:\n- kol数据概览\n\n# [English]\n### Purpose:\n- Get kol Data Overview V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- _type: Type, supports the following parameters:\n    - _1 :Personal Video\n    - _2 :Xingtu Video\n- _range: Range, supports the following parameters:\n    - _2 :Last 30 days\n    - _3 :Last 90 days\n- flowType: Flow Type, supports the following parameters:\n    - 1 : Default\n- onlyAssign (optional): Whether assigned, the specific parameters are as follows:\n    - Not provided : Use API default behavior\n    - false : All data\n    - true : Only assigned data\n### Return:\n- kol Data Overview\n\n# [示例/Example]\nkolId = \"7048929565493690398\"\n_type = \"_1\"\n_range = \"_2\"\nflowType = 1\nonlyAssign = None  # or True/False if needed","operationId":"kol_data_overview_v1_api_v1_douyin_xingtu_kol_data_overview_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"},{"name":"_type","in":"query","required":true,"schema":{"type":"string","description":"类型/Type","title":" Type"},"description":"类型/Type","example":"_1"},{"name":"_range","in":"query","required":true,"schema":{"type":"string","description":"范围/Range","title":" Range"},"description":"范围/Range","example":"_2"},{"name":"flowType","in":"query","required":true,"schema":{"type":"integer","description":"流量类型/Flow Type","title":"Flowtype"},"description":"流量类型/Flow Type","example":1},{"name":"onlyAssign","in":"query","required":false,"schema":{"type":"boolean","description":"是否指派/Whether assigned (optional)","title":"Onlyassign"},"description":"是否指派/Whether assigned (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/search_kol_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"关键词搜索kol V1/Search Kol V1","description":"# [中文]\n### 用途:\n- 关键词搜索kol V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- keyword: 关键词\n- platformSource:\n    - 平台来源，支持以下参数:\n    - _1 :抖音(douyin)\n    - _2 :头条(toutiao)\n    - _3 :西瓜(xigua)\n- page: 页码，从1开始\n### 返回:\n- kol列表\n\n# [English]\n### Purpose:\n- Search Kol V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- keyword: Keyword\n- platformSource:\n    - Platform source, supports the following parameters:\n    - _1 :Douyin\n    - _2 :Toutiao\n    - _3 :Xigua\n- page: Page number, starting from 1\n### Return:\n- Kol List\n\n# [示例/Example]\nkeyword = \"人工智能\"\nplatformSource = \"_1\"\npage = 1","operationId":"search_kol_v1_api_v1_douyin_xingtu_search_kol_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"抖音"},{"name":"platformSource","in":"query","required":true,"schema":{"type":"string","description":"平台来源/Platform Source","title":"Platformsource"},"description":"平台来源/Platform Source","example":"_1"},{"name":"page","in":"query","required":true,"schema":{"type":"integer","description":"页码/Page","title":"Page"},"description":"页码/Page","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/search_kol_v2":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"高级搜索kol V2/Search Kol Advanced V2","description":"# [中文]\n### 用途:\n- 高级搜索kol V2，支持粉丝范围和内容标签筛选\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- keyword: 关键词\n- followerRange (可选): 粉丝范围，格式：最小值-最大值\n    - 例如：10-100 表示粉丝范围在 10万-100万 之间\n    - 不传递此参数则不限制粉丝范围\n- contentTag (可选): 内容标签，支持以下格式:\n    - tag-{id}: 一级标签，例如 tag-1 (美妆)\n    - tag_level_two-{id}: 二级标签，例如 tag_level_two-7 (穿搭)\n    - 标签列表参考文档中的 contentTag 映射表\n    - 不传递此参数则不限制内容标签\n### 返回:\n- kol列表（支持高级筛选）\n\n# [English]\n### Purpose:\n- Advanced Search Kol V2, supports follower range and content tag filtering\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- keyword: Keyword\n- followerRange (optional): Follower range, format: min-max\n    - Example: 10-100 indicates follower range between 100,000 and 1,000,000\n    - Do not pass this parameter to not limit the follower range\n- contentTag (optional): Content tag, supports the following formats:\n    - tag-{id}: First-level tag, e.g., tag-1 (Beauty)\n    - tag_level_two-{id}: Second-level tag, e.g., tag_level_two-7 (Outfit)\n    - Refer to the contentTag mapping table in the documentation\n    - Do not pass this parameter to not limit content tags\n### Return:\n- Kol List (with advanced filtering)\n\n# [示例/Example]\nkeyword = \"美妆\"\nfollowerRange = \"10-100\"  # 10万-100万粉丝\ncontentTag = \"tag-1\"  # 美妆一级标签\ncontentTag = \"tag_level_two-2\"  # 美妆教程二级标签\n\n# [内容标签映射表/Content Tag Mapping]\n\n## 一级标签 (First-level tags) - 格式: tag-{id}\n\n| 参数 | 分类 | 参数 | 分类 | 参数 | 分类 |\n|------|------|------|------|------|------|\n| tag-1 | 美妆 | tag-6 | 时尚 | tag-11 | 萌宠 |\n| tag-15 | 测评 | tag-23 | 游戏 | tag-25 | 二次元 |\n| tag-27 | 旅行 | tag-31 | 汽车 | tag-36 | 生活 |\n| tag-41 | 音乐 | tag-46 | 舞蹈* | tag-48 | 美食 |\n| tag-55 | 母婴亲子 | tag-60 | 运动健身 | tag-64 | 科技数码 |\n| tag-68 | 教育培训 | tag-72 | 颜值达人 | tag-79 | 才艺技能 |\n| tag-85 | 影视娱乐 | tag-87 | 艺术文化 | tag-91 | 财经投资 |\n| tag-95 | 三农* | tag-97 | 剧情搞笑 | tag-100 | 情感* |\n| tag-102 | 园艺* | tag-130 | 随拍* | tag-139 | 房产 |\n| tag-1001 | 生活家居 | tag-1002 | 媒体号* | | |\n\n*注: 标记*的分类无二级标签\n\n## 二级标签 (Second-level tags) - 格式: tag_level_two-{id}\n\n### 美妆 (tag-1)\n- tag_level_two-2: 美妆教程\n- tag_level_two-3: 妆容展示\n- tag_level_two-4: 护肤保养\n- tag_level_two-5: 美妆测评种草\n\n### 时尚 (tag-6)\n- tag_level_two-7: 穿搭\n- tag_level_two-8: 街拍\n- tag_level_two-10: 造型\n- tag_level_two-135: 时尚媒体\n\n### 萌宠 (tag-11)\n- tag_level_two-12: 日常宠物\n- tag_level_two-13: 特别宠物\n- tag_level_two-14: 宠物周边\n\n### 测评 (tag-15)\n- tag_level_two-16: 美妆测评\n- tag_level_two-17: 3C数码测评\n- tag_level_two-18: 汽车测评\n- tag_level_two-19: 美食产品测评\n- tag_level_two-20: 母婴产品测评\n- tag_level_two-21: 综合测评\n- tag_level_two-132: 酒店测评\n\n### 游戏 (tag-23)\n- tag_level_two-121: 游戏剧情\n- tag_level_two-122: 游戏解说\n- tag_level_two-123: 游戏资讯\n- tag_level_two-124: 游戏其他\n- tag_level_two-440: 游戏录屏\n- tag_level_two-441: 游戏集锦\n\n### 二次元 (tag-25)\n- tag_level_two-125: 二次元真人\n- tag_level_two-126: 动画漫画\n- tag_level_two-127: 配音声优\n- tag_level_two-128: 宅物手办\n\n### 旅行 (tag-27)\n- tag_level_two-28: 旅行记录\n- tag_level_two-29: 旅行攻略\n- tag_level_two-30: 旅行推荐\n- tag_level_two-442: 户外生活\n\n### 汽车 (tag-31)\n- tag_level_two-32: 汽车测评\n- tag_level_two-33: 汽车知识\n- tag_level_two-34: 汽车周边\n\n### 生活 (tag-36)\n- tag_level_two-37: 生活记录\n- tag_level_two-39: 生活小窍门\n- tag_level_two-40: 好物推荐\n- tag_level_two-118: 健康养生\n- tag_level_two-422: 婚恋\n\n### 音乐 (tag-41)\n- tag_level_two-42: 歌曲演唱\n- tag_level_two-43: 乐器演奏\n- tag_level_two-44: 音乐教学\n- tag_level_two-45: 音乐其他\n- tag_level_two-136: 音乐剪辑\n\n### 美食 (tag-48)\n- tag_level_two-49: 美食教程\n- tag_level_two-50: 美食探店\n- tag_level_two-52: 美食产品测评\n- tag_level_two-53: 乡村野食\n- tag_level_two-54: 美食其他\n- tag_level_two-423: 酒类\n\n### 母婴亲子 (tag-55)\n- tag_level_two-56: 育儿科普\n- tag_level_two-57: 萌娃日常\n- tag_level_two-58: 亲子互动\n- tag_level_two-59: 测评种草\n\n### 运动健身 (tag-60)\n- tag_level_two-61: 健身\n- tag_level_two-63: 极限运动\n- tag_level_two-424: 体育资讯\n- tag_level_two-443: 冰雪\n- tag_level_two-444: 垂钓\n- tag_level_two-445: 格斗\n- tag_level_two-446: 球类项目\n- tag_level_two-447: 综合体育\n\n### 科技数码 (tag-64)\n- tag_level_two-65: 3C数码\n- tag_level_two-66: 家居电器\n- tag_level_two-133: 科技\n\n### 教育培训 (tag-68)\n- tag_level_two-69: 考学培训\n- tag_level_two-70: 语言教学\n- tag_level_two-71: 个人管理\n- tag_level_two-425: 职业教育\n\n### 颜值达人 (tag-72)\n- tag_level_two-73: 美女\n- tag_level_two-74: 帅哥\n\n### 才艺技能 (tag-79)\n- tag_level_two-80: 创意才能\n- tag_level_two-81: 手工\n- tag_level_two-82: 摄影\n- tag_level_two-83: 绘画\n- tag_level_two-84: 其他才艺\n\n### 影视娱乐 (tag-85)\n- tag_level_two-413: 影视解说\n- tag_level_two-414: 影视混剪\n- tag_level_two-415: 明星资讯\n- tag_level_two-416: 综艺解说\n- tag_level_two-417: 综艺混剪\n\n### 艺术文化 (tag-87)\n- tag_level_two-88: 传统文化\n- tag_level_two-89: 人文科普\n- tag_level_two-90: 自然科学\n\n### 财经投资 (tag-91)\n- tag_level_two-92: 传统金融\n- tag_level_two-93: 互联网金融\n- tag_level_two-94: 财经知识\n\n### 剧情搞笑 (tag-97)\n- tag_level_two-98: 剧情\n- tag_level_two-99: 搞笑\n\n### 生活家居 (tag-1001)\n- tag_level_two-100101: 硬装\n- tag_level_two-100102: 软装\n- tag_level_two-100103: 生活技巧\n- tag_level_two-100104: 家居氛围\n\n### 房产 (tag-139)\n- tag_level_two-140: 其他房产\n- tag_level_two-437: 房产知识\n- tag_level_two-439: 房产及投资\n- tag_level_two-448: 楼盘评测\n- tag_level_two-449: 楼市资讯\n- tag_level_two-450: 租房","operationId":"search_kol_v2_api_v1_douyin_xingtu_search_kol_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"美妆"},{"name":"followerRange","in":"query","required":false,"schema":{"type":"string","description":"粉丝范围(可选)/Follower Range (optional), 例如 10-100 表示10万-100万粉丝","title":"Followerrange"},"description":"粉丝范围(可选)/Follower Range (optional), 例如 10-100 表示10万-100万粉丝","example":"10-100"},{"name":"contentTag","in":"query","required":false,"schema":{"type":"string","description":"内容标签(可选)/Content Tag (optional), 例如 tag-1 或 tag_level_two-7","title":"Contenttag"},"description":"内容标签(可选)/Content Tag (optional), 例如 tag-1 或 tag_level_two-7","example":"tag-1"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_conversion_ability_analysis_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol转化能力分析V1/Get kol Conversion Ability Analysis V1","description":"# [中文]\n### 用途:\n- 获取kol转化能力分析V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- _range: 时间范围, 支持以下参数:\n    - _1 :近7天(last 7 days)\n    - _2 :30天(last 30 days)\n    - _3 :90天(last 90 days)\n### 返回:\n- kol转化能力分析\n\n# [English]\n### Purpose:\n- Get kol Conversion Ability Analysis V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- _range: Time range, supports the following parameters:\n    - _1 :Last 7 days\n    - _2 :Last 30 days\n    - _3 :Last 90 days\n### Return:\n- kol Conversion Ability Analysis\n\n# [示例/Example]\nkolId = \"7048929565493690398\"\n_range = \"_1\"","operationId":"kol_conversion_ability_analysis_v1_api_v1_douyin_xingtu_kol_conversion_ability_analysis_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"},{"name":"_range","in":"query","required":true,"schema":{"type":"string","description":"时间范围/Time Range","title":" Range"},"description":"时间范围/Time Range","example":"_1"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_video_performance_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol视频表现V1/Get kol Video Performance V1","description":"# [中文]\n### 用途:\n- 获取kol视频表现V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- onlyAssign: 是否只显示分配作品，具体参数如下:\n    - false : 显示全部，包括个人作品和分配作品，默认值。\n    - true : 只显示来自星图的分配作品。\n### 返回:\n- kol视频表现\n\n# [English]\n### Purpose:\n- Get kol Video Performance V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- onlyAssign: Whether to display only assigned works, the specific parameters are as follows:\n    - false : Show all, including personal works and assigned works, default value.\n    - true : Only display assigned works from XingTu.\n### Return:\n- kol Video Performance\n\n# [示例/Example]\nkolId = \"7048929565493690398\"\nonlyAssign = False","operationId":"kol_video_performance_v1_api_v1_douyin_xingtu_kol_video_performance_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"},{"name":"onlyAssign","in":"query","required":true,"schema":{"type":"boolean","description":"是否只显示分配作品/Whether to display only assigned works","title":"Onlyassign"},"description":"是否只显示分配作品/Whether to display only assigned works","example":false}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_xingtu_index_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol星图指数V1/Get kol Xingtu Index V1","description":"# [中文]\n### 用途:\n- 获取kol星图指数V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### 返回:\n- kol星图指数\n\n# [English]\n### Purpose:\n- Get kol Xingtu Index V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### Return:\n- kol Xingtu Index\n\n# [示例/Example]\nkolId = \"7048929565493690398\"","operationId":"kol_xingtu_index_v1_api_v1_douyin_xingtu_kol_xingtu_index_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_convert_video_display_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol转化视频展示V1/Get kol Convert Video Display V1","description":"# [中文]\n### 用途:\n- 获取kol转化视频展示V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- detailType: 详情类型, 支持以下参数:\n    - _1 :相关视频数据(Video Data)\n    - _2 :相关商品数据(Product Data)\n### 返回:\n- kol转化视频展示\n\n# [English]\n### Purpose:\n- Get kol Convert Video Display V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- detailType: Detail type, supports the following parameters:\n    - _1 :Video Data\n    - _2 :Product Data\n- page: Page number, starting from 1\n### Return:\n- kol Convert Video Display\n\n# [示例/Example]\nkolId = \"7048929565493690398\"\ndetailType = \"_1\"\npage = 1","operationId":"kol_convert_video_display_v1_api_v1_douyin_xingtu_kol_convert_video_display_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"},{"name":"detailType","in":"query","required":true,"schema":{"type":"string","description":"详情类型/Detail Type","title":"Detailtype"},"description":"详情类型/Detail Type","example":"_1"},{"name":"page","in":"query","required":true,"schema":{"type":"integer","description":"页码/Page","title":"Page"},"description":"页码/Page","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_link_struct_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol连接用户V1/Get kol Link Struct V1","description":"# [中文]\n### 用途:\n- 获取kol连接用户V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### 返回:\n- kol连接用户\n\n# [English]\n### Purpose:\n- Get kol Link Struct V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### Return:\n- kol Link Struct\n\n# [示例/Example]\nkolId = \"7048929565493690398\"","operationId":"kol_link_struct_v1_api_v1_douyin_xingtu_kol_link_struct_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_touch_distribution_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol连接用户来源V1/Get kol Touch Distribution V1","description":"# [中文]\n### 用途:\n- 获取kol连接用户来源V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### 返回:\n- kol连接用户来源\n\n# [English]\n### Purpose:\n- Get kol Touch Distribution V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### Return:\n- kol Touch Distribution\n\n# [示例/Example]\nkolId = \"7048929565493690398\"","operationId":"kol_touch_distribution_v1_api_v1_douyin_xingtu_kol_touch_distribution_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_cp_info_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol性价比能力分析V1/Get kol Cp Info V1","description":"# [中文]\n### 用途:\n- 获取kol性价比能力分析V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### 返回:\n- kol性价比能力分析\n\n# [English]\n### Purpose:\n- Get kol Cp Info V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### Return:\n- kol Cp Info\n\n# [示例/Example]\nkolId = \"7048929565493690398\"","operationId":"kol_cp_info_v1_api_v1_douyin_xingtu_kol_cp_info_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_rec_videos_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol内容表现V1/Get kol Rec Videos V1","description":"# [中文]\n### 用途:\n- 获取kol内容表现V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### 返回:\n- kol内容表现\n\n# [English]\n### Purpose:\n- Get kol Rec Videos V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### Return:\n- kol Rec Videos\n\n# [示例/Example]\nkolId = \"7048929565493690398\"","operationId":"kol_rec_videos_v1_api_v1_douyin_xingtu_kol_rec_videos_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/kol_daily_fans_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol粉丝趋势V1/Get kol Daily Fans V1","description":"# [中文]\n### 用途:\n- 获取kol粉丝趋势V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- startDate: 开始日期，格式为：yyyy-MM-dd\n- endDate: 结束日期，格式为：yyyy-MM-dd\n### 返回:\n- kol粉丝趋势\n\n# [English]\n### Purpose:\n- Get kol Daily Fans V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n- startDate: Start date, format: yyyy-MM-dd\n- endDate: End date, format: yyyy-MM-dd\n### Return:\n- kol Daily Fans\n\n# [示例/Example]\nkolId = \"7048929565493690398\"\nstartDate = \"2024-12-01\"\nendDate = \"2025-01-01\"","operationId":"kol_daily_fans_v1_api_v1_douyin_xingtu_kol_daily_fans_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"},{"name":"startDate","in":"query","required":true,"schema":{"type":"string","description":"开始日期/Start Date","title":"Startdate"},"description":"开始日期/Start Date","example":"2024-12-01"},{"name":"endDate","in":"query","required":true,"schema":{"type":"string","description":"结束日期/End Date","title":"Enddate"},"description":"结束日期/End Date","example":"2025-01-01"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/author_hot_comment_tokens_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol热词分析评论V1/Get Author Hot Comment Tokens V1","description":"# [中文]\n### 用途:\n- 获取kol热词分析评论V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### 返回:\n- kol热词分析评论\n\n# [English]\n### Purpose:\n- Get Author Hot Comment Tokens V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### Return:\n- Author Hot Comment Tokens\n\n# [示例/Example]\nkolId = \"7048929565493690398\"","operationId":"author_hot_comment_tokens_v1_api_v1_douyin_xingtu_author_hot_comment_tokens_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu/author_content_hot_comment_keywords_v1":{"get":{"tags":["Douyin-Xingtu-API"],"summary":"获取kol热词分析内容V1/Get Author Content Hot Comment Keywords V1","description":"# [中文]\n### 用途:\n- 获取kol热词分析内容V1\n- 该接口数据使用企业账号进行请求，收费较贵。\n- 价格：0.02$ / 次\n### 参数:\n- kolId: 用户的kolId, 可以从接口以下接口获取：\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### 返回:\n- kol热词分析内容\n\n# [English]\n### Purpose:\n- Get Author Content Hot Comment Keywords V1\n- The interface data is requested using an enterprise account, which is more expensive.\n- Price: 0.02$ / time\n### Parameters:\n- kolId: User kolId, can be obtained from the following interfaces:\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_uid`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_sec_user_id`\n    - `/api/v1/douyin/xingtu/get_xingtu_kolid_by_unique_id`\n### Return:\n- Author Content Hot Comment Keywords\n\n# [示例/Example]\nkolId = \"7048929565493690398\"","operationId":"author_content_hot_comment_keywords_v1_api_v1_douyin_xingtu_author_content_hot_comment_keywords_v1_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"kolId","in":"query","required":true,"schema":{"type":"string","description":"用户的kolId/User kolId","title":"Kolid"},"description":"用户的kolId/User kolId","example":"7048929565493690398"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_ranking_list_catalog":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取星图热榜分类/Get Ranking List Catalog","description":"# [中文]\n### 用途:\n- 获取星图热榜分类列表，返回qualifier_id等分类信息\n- 价格：0.001$ / 次\n### 参数:\n- codes: 分类代码，默认为空字符串\n- biz_scene: 业务场景\n    - `douyin_flow_split_video_author_ranks`: 短视频达人热榜\n    - `douyin_flow_split_live_author_ranks`: 直播达人热榜\n### 返回:\n- 热榜分类数据\n\n# [English]\n### Purpose:\n- Get XingTu hot ranking list catalog, returns qualifier_id and other category information\n- Price: 0.001$ / time\n### Parameters:\n- codes: Classification codes, default is empty string\n- biz_scene: Business scene\n    - `douyin_flow_split_video_author_ranks`: Video creator ranking\n    - `douyin_flow_split_live_author_ranks`: Live streamer ranking\n### Return:\n- Hot ranking catalog data\n\n# [示例/Example]\ncodes = \"\"\nbiz_scene = \"douyin_flow_split_video_author_ranks\"","operationId":"get_ranking_list_catalog_api_v1_douyin_xingtu_v2_get_ranking_list_catalog_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"codes","in":"query","required":false,"schema":{"type":"string","description":"分类代码，默认为空字符串/Classification codes, default is empty string","default":"","title":"Codes"},"description":"分类代码，默认为空字符串/Classification codes, default is empty string","example":""},{"name":"biz_scene","in":"query","required":false,"schema":{"type":"string","description":"业务场景/Business scene","default":"douyin_flow_split_video_author_ranks","title":"Biz Scene"},"description":"业务场景/Business scene","example":"douyin_flow_split_video_author_ranks"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_ranking_list_data":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取星图达人商业榜数据/Get Ranking List Data","description":"# [中文]\n### 用途:\n- 获取星图达人商业榜数据\n- qualifier可以从`get_ranking_list_catalog`接口获取\n- 价格：0.001$ / 次\n### 参数:\n- code: 榜单类型代码\n    - 短视频-达人商业榜: 1=品牌优选榜, 2=A3种草榜, 3=看后搜榜, 4=带货榜, 5=投流榜, 6=高潜榜\n    - 短视频-达人内容榜: 17=涨粉黑马榜, 18=头部必选榜\n    - 直播达人榜-主播类型: 23=游戏主播, 30=其他主播, 37=带货主播 (version=base)\n    - 直播达人榜-榜单类型: 23=游戏行业品牌优选榜, 24=非游戏行业品牌优选榜, 25=组件点击榜, 26=下载转化榜, 27=线索收集榜, 28=投流榜, 29=高潜榜\n- qualifier: 榜单分类ID，从`get_ranking_list_catalog`获取\n- version: 版本，`flow_split`=短视频榜单默认，`base`=直播榜单常用\n- period: 统计周期，7=周榜，30=月榜\n- date: 统计日期，格式YYYYMMDD\n- limit: 返回数量，默认100\n### 返回:\n- 达人商业榜数据\n\n# [English]\n### Purpose:\n- Get XingTu creator business ranking list data\n- qualifier can be obtained from `get_ranking_list_catalog` API\n- Price: 0.001$ / time\n### Parameters:\n- code: Ranking type code\n    - Video business ranking: 1=Brand Premium, 2=A3 Seeding, 3=Search After Watch, 4=E-commerce, 5=Ad Flow, 6=High Potential\n    - Video content ranking: 17=Follower Growth Dark Horse, 18=Top Must-Pick\n    - Live streamer type: 23=Game Streamer, 30=Other Streamer, 37=E-commerce Streamer (version=base)\n    - Live ranking type: 23=Game Brand Premium, 24=Non-game Brand Premium, 25=Component Click, 26=Download Conversion, 27=Lead Collection, 28=Ad Flow, 29=High Potential\n- qualifier: Category qualifier_id from `get_ranking_list_catalog`\n- version: `flow_split`=default for video rankings, `base`=commonly used for live rankings\n- period: 7=weekly, 30=monthly\n- date: Date, format YYYYMMDD\n- limit: Result limit, default 100\n### Return:\n- Creator business ranking data\n\n# [示例/Example]\ncode = 1\nqualifier = \"1901\"\nversion = \"flow_split\"\nperiod = 30\ndate = \"20260131\"\nlimit = 100","operationId":"get_ranking_list_data_api_v1_douyin_xingtu_v2_get_ranking_list_data_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"query","required":false,"schema":{"type":"integer","description":"榜单类型代码/Ranking type code","default":1,"title":"Code"},"description":"榜单类型代码/Ranking type code","example":1},{"name":"qualifier","in":"query","required":false,"schema":{"type":"string","description":"榜单分类ID，从get_ranking_list_catalog获取/Category qualifier_id","default":"1901","title":"Qualifier"},"description":"榜单分类ID，从get_ranking_list_catalog获取/Category qualifier_id","example":"1901"},{"name":"version","in":"query","required":false,"schema":{"type":"string","description":"版本/Version","default":"flow_split","title":"Version"},"description":"版本/Version","example":"flow_split"},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"统计周期，7=周榜，30=月榜/Period, 7=weekly, 30=monthly","default":30,"title":"Period"},"description":"统计周期，7=周榜，30=月榜/Period, 7=weekly, 30=monthly","example":30},{"name":"date","in":"query","required":false,"schema":{"type":"string","description":"统计日期，格式YYYYMMDD/Date, format YYYYMMDD","default":"20260131","title":"Date"},"description":"统计日期，格式YYYYMMDD/Date, format YYYYMMDD","example":"20260131"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"返回数量/Result limit","default":100,"title":"Limit"},"description":"返回数量/Result limit","example":100}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_playlet_actor_rank_catalog":{"post":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取短剧演员热榜分类/Get Playlet Actor Rank Catalog","description":"# [中文]\n### 用途:\n- 获取短剧演员热榜分类列表\n- 价格：0.001$ / 次\n### 返回:\n- 短剧演员热榜分类数据\n\n# [English]\n### Purpose:\n- Get XingTu playlet actor ranking catalog\n- Price: 0.001$ / time\n### Return:\n- Playlet actor ranking catalog data","operationId":"get_playlet_actor_rank_catalog_api_v1_douyin_xingtu_v2_get_playlet_actor_rank_catalog_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/xingtu_v2/get_playlet_actor_rank_list":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取短剧演员热榜/Get Playlet Actor Rank List","description":"# [中文]\n### 用途:\n- 获取短剧演员热榜数据\n- 价格：0.001$ / 次\n### 参数:\n- category: 分类，默认`playlet_actor_list`\n- name: 榜单名称，`playlet_actor_composite_list`=综合榜\n- qualifier: 达人类型，空字符串=不限\n- period: 统计周期，7=周榜，30=月榜\n- date: 统计日期，格式YYYYMMDD\n- limit: 返回数量，默认100\n### 返回:\n- 短剧演员热榜数据\n\n# [English]\n### Purpose:\n- Get XingTu playlet actor ranking list data\n- Price: 0.001$ / time\n### Parameters:\n- category: Category, default `playlet_actor_list`\n- name: Ranking name, `playlet_actor_composite_list`=composite list\n- qualifier: Actor type, empty=all\n- period: 7=weekly, 30=monthly\n- date: Date, format YYYYMMDD\n- limit: Result limit, default 100\n### Return:\n- Playlet actor ranking data\n\n# [示例/Example]\ncategory = \"playlet_actor_list\"\nname = \"playlet_actor_composite_list\"\nperiod = 30\ndate = \"20251130\"\nlimit = 100","operationId":"get_playlet_actor_rank_list_api_v1_douyin_xingtu_v2_get_playlet_actor_rank_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category","in":"query","required":false,"schema":{"type":"string","description":"分类/Category","default":"playlet_actor_list","title":"Category"},"description":"分类/Category","example":"playlet_actor_list"},{"name":"name","in":"query","required":false,"schema":{"type":"string","description":"榜单名称/Ranking name","default":"playlet_actor_composite_list","title":"Name"},"description":"榜单名称/Ranking name","example":"playlet_actor_composite_list"},{"name":"qualifier","in":"query","required":false,"schema":{"type":"string","description":"达人类型，空字符串=不限/Actor type, empty=all","default":"","title":"Qualifier"},"description":"达人类型，空字符串=不限/Actor type, empty=all","example":""},{"name":"period","in":"query","required":false,"schema":{"type":"integer","description":"统计周期，7=周榜，30=月榜/Period, 7=weekly, 30=monthly","default":30,"title":"Period"},"description":"统计周期，7=周榜，30=月榜/Period, 7=weekly, 30=monthly","example":30},{"name":"date","in":"query","required":false,"schema":{"type":"string","description":"统计日期，格式YYYYMMDD/Date, format YYYYMMDD","default":"20251130","title":"Date"},"description":"统计日期，格式YYYYMMDD/Date, format YYYYMMDD","example":"20251130"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"返回数量/Result limit","default":100,"title":"Limit"},"description":"返回数量/Result limit","example":100}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_author_market_fields":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取达人广场筛选字段/Get Author Market Fields","description":"# [中文]\n### 用途:\n- 获取达人广场所有筛选字段选项\n- 价格：0.001$ / 次\n### 参数:\n- market_scene: 市场场景，1=默认场景\n### 返回:\n- 达人广场筛选字段数据\n\n# [English]\n### Purpose:\n- Get all filter field options for the creator marketplace\n- Price: 0.001$ / time\n### Parameters:\n- market_scene: Market scene, 1=default\n### Return:\n- Creator marketplace filter fields data\n\n# [示例/Example]\nmarket_scene = 1","operationId":"get_author_market_fields_api_v1_douyin_xingtu_v2_get_author_market_fields_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"market_scene","in":"query","required":false,"schema":{"type":"integer","description":"市场场景，1=默认场景/Market scene, 1=default","default":1,"title":"Market Scene"},"description":"市场场景，1=默认场景/Market scene, 1=default","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_author_base_info":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取创作者基本信息/Get Author Base Info","description":"# [中文]\n### 用途:\n- 获取创作者基本信息\n- 价格：0.001$ / 次\n### 参数:\n- o_author_id: 创作者ID\n- platform_source: 平台来源，默认1\n- platform_channel: 平台渠道，默认1\n- recommend: 是否返回推荐信息，默认True\n- need_sec_uid: 是否返回sec_uid，默认True\n- need_linkage_info: 是否返回联动信息，默认True\n### 返回:\n- 创作者基本信息数据\n\n# [English]\n### Purpose:\n- Get creator/author base information\n- Price: 0.001$ / time\n### Parameters:\n- o_author_id: Creator/author ID\n- platform_source: Platform source, default 1\n- platform_channel: Platform channel, default 1\n- recommend: Whether to return recommendation info, default True\n- need_sec_uid: Whether to return sec_uid, default True\n- need_linkage_info: Whether to return linkage info, default True\n### Return:\n- Creator base info data\n\n# [示例/Example]\no_author_id = \"7589271892177518598\"","operationId":"get_author_base_info_api_v1_douyin_xingtu_v2_get_author_base_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"o_author_id","in":"query","required":true,"schema":{"type":"string","description":"创作者ID/Creator author ID","title":"O Author Id"},"description":"创作者ID/Creator author ID","example":"7589271892177518598"},{"name":"platform_source","in":"query","required":false,"schema":{"type":"integer","description":"平台来源/Platform source","default":1,"title":"Platform Source"},"description":"平台来源/Platform source","example":1},{"name":"platform_channel","in":"query","required":false,"schema":{"type":"integer","description":"平台渠道/Platform channel","default":1,"title":"Platform Channel"},"description":"平台渠道/Platform channel","example":1},{"name":"recommend","in":"query","required":false,"schema":{"type":"boolean","description":"是否返回推荐信息/Whether to return recommendation info","default":true,"title":"Recommend"},"description":"是否返回推荐信息/Whether to return recommendation info","example":true},{"name":"need_sec_uid","in":"query","required":false,"schema":{"type":"boolean","description":"是否返回sec_uid/Whether to return sec_uid","default":true,"title":"Need Sec Uid"},"description":"是否返回sec_uid/Whether to return sec_uid","example":true},{"name":"need_linkage_info","in":"query","required":false,"schema":{"type":"boolean","description":"是否返回联动信息/Whether to return linkage info","default":true,"title":"Need Linkage Info"},"description":"是否返回联动信息/Whether to return linkage info","example":true}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_author_business_card_info":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取创作者商业卡片信息/Get Author Business Card Info","description":"# [中文]\n### 用途:\n- 获取创作者商业卡片信息\n- 价格：0.001$ / 次\n### 参数:\n- o_author_id: 创作者ID\n### 返回:\n- 创作者商业卡片信息数据\n\n# [English]\n### Purpose:\n- Get creator/author business card information\n- Price: 0.001$ / time\n### Parameters:\n- o_author_id: Creator/author ID\n### Return:\n- Creator business card info data\n\n# [示例/Example]\no_author_id = \"7589271892177518598\"","operationId":"get_author_business_card_info_api_v1_douyin_xingtu_v2_get_author_business_card_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"o_author_id","in":"query","required":true,"schema":{"type":"string","description":"创作者ID/Creator author ID","title":"O Author Id"},"description":"创作者ID/Creator author ID","example":"7589271892177518598"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_author_local_info":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取创作者位置信息/Get Author Local Info","description":"# [中文]\n### 用途:\n- 获取创作者位置信息\n- 价格：0.001$ / 次\n### 参数:\n- o_author_id: 创作者ID\n- platform_source: 平台来源，默认1\n- platform_channel: 平台渠道，默认1\n- time_range: 时间范围(天)，默认30\n### 返回:\n- 创作者位置信息数据\n\n# [English]\n### Purpose:\n- Get creator/author location information\n- Price: 0.001$ / time\n### Parameters:\n- o_author_id: Creator/author ID\n- platform_source: Platform source, default 1\n- platform_channel: Platform channel, default 1\n- time_range: Time range in days, default 30\n### Return:\n- Creator location info data\n\n# [示例/Example]\no_author_id = \"7146074596666507300\"","operationId":"get_author_local_info_api_v1_douyin_xingtu_v2_get_author_local_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"o_author_id","in":"query","required":true,"schema":{"type":"string","description":"创作者ID/Creator author ID","title":"O Author Id"},"description":"创作者ID/Creator author ID","example":"7146074596666507300"},{"name":"platform_source","in":"query","required":false,"schema":{"type":"integer","description":"平台来源/Platform source","default":1,"title":"Platform Source"},"description":"平台来源/Platform source","example":1},{"name":"platform_channel","in":"query","required":false,"schema":{"type":"integer","description":"平台渠道/Platform channel","default":1,"title":"Platform Channel"},"description":"平台渠道/Platform channel","example":1},{"name":"time_range","in":"query","required":false,"schema":{"type":"integer","description":"时间范围(天)/Time range in days","default":30,"title":"Time Range"},"description":"时间范围(天)/Time range in days","example":30}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_author_show_items":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取创作者视频列表/Get Author Show Items","description":"# [中文]\n### 用途:\n- 获取创作者视频列表\n- 价格：0.001$ / 次\n### 参数:\n- o_author_id: 创作者ID\n- platform_source: 平台来源，默认1\n- platform_channel: 平台渠道，默认1\n- limit: 返回数量，默认10\n- only_assign: 仅看指派视频（只针对星图视频生效），默认False\n- flow_type: 流量类型，默认0\n### 返回:\n- 创作者视频列表数据\n\n# [English]\n### Purpose:\n- Get creator/author video list\n- Price: 0.001$ / time\n### Parameters:\n- o_author_id: Creator/author ID\n- platform_source: Platform source, default 1\n- platform_channel: Platform channel, default 1\n- limit: Result limit, default 10\n- only_assign: Only show assigned videos (only for XingTu videos), default False\n- flow_type: Flow type, default 0\n### Return:\n- Creator video list data\n\n# [示例/Example]\no_author_id = \"7589271892177518598\"","operationId":"get_author_show_items_api_v1_douyin_xingtu_v2_get_author_show_items_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"o_author_id","in":"query","required":true,"schema":{"type":"string","description":"创作者ID/Creator author ID","title":"O Author Id"},"description":"创作者ID/Creator author ID","example":"7589271892177518598"},{"name":"platform_source","in":"query","required":false,"schema":{"type":"integer","description":"平台来源/Platform source","default":1,"title":"Platform Source"},"description":"平台来源/Platform source","example":1},{"name":"platform_channel","in":"query","required":false,"schema":{"type":"integer","description":"平台渠道/Platform channel","default":1,"title":"Platform Channel"},"description":"平台渠道/Platform channel","example":1},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"返回数量/Result limit","default":10,"title":"Limit"},"description":"返回数量/Result limit","example":10},{"name":"only_assign","in":"query","required":false,"schema":{"type":"boolean","description":"仅看指派视频/Only show assigned videos","default":false,"title":"Only Assign"},"description":"仅看指派视频/Only show assigned videos","example":false},{"name":"flow_type","in":"query","required":false,"schema":{"type":"integer","description":"流量类型/Flow type","default":0,"title":"Flow Type"},"description":"流量类型/Flow type","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_author_hot_comment_tokens":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取创作者评论热词/Get Author Hot Comment Tokens","description":"# [中文]\n### 用途:\n- 获取创作者评论热词\n- 价格：0.001$ / 次\n### 参数:\n- author_id: 创作者ID\n- num: 返回热词数量，默认10\n- without_emoji: 是否排除emoji，默认True\n### 返回:\n- 创作者评论热词数据\n\n# [English]\n### Purpose:\n- Get creator/author hot comment tokens/keywords\n- Price: 0.001$ / time\n### Parameters:\n- author_id: Creator/author ID\n- num: Number of hot tokens, default 10\n- without_emoji: Whether to exclude emoji, default True\n### Return:\n- Creator hot comment tokens data\n\n# [示例/Example]\nauthor_id = \"7589271892177518598\"","operationId":"get_author_hot_comment_tokens_api_v1_douyin_xingtu_v2_get_author_hot_comment_tokens_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"author_id","in":"query","required":true,"schema":{"type":"string","description":"创作者ID/Creator author ID","title":"Author Id"},"description":"创作者ID/Creator author ID","example":"7589271892177518598"},{"name":"num","in":"query","required":false,"schema":{"type":"integer","description":"返回热词数量/Number of hot tokens","default":10,"title":"Num"},"description":"返回热词数量/Number of hot tokens","example":10},{"name":"without_emoji","in":"query","required":false,"schema":{"type":"boolean","description":"是否排除emoji/Whether to exclude emoji","default":true,"title":"Without Emoji"},"description":"是否排除emoji/Whether to exclude emoji","example":true}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_author_content_hot_keywords":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取创作者内容热词/Get Author Content Hot Keywords","description":"# [中文]\n### 用途:\n- 获取创作者内容热词\n- 价格：0.001$ / 次\n### 参数:\n- author_id: 创作者ID\n- keyword_type: 热词类型，默认0\n### 返回:\n- 创作者内容热词数据\n\n# [English]\n### Purpose:\n- Get creator/author content hot keywords\n- Price: 0.001$ / time\n### Parameters:\n- author_id: Creator/author ID\n- keyword_type: Keyword type, default 0\n### Return:\n- Creator content hot keywords data\n\n# [示例/Example]\nauthor_id = \"7589271892177518598\"","operationId":"get_author_content_hot_keywords_api_v1_douyin_xingtu_v2_get_author_content_hot_keywords_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"author_id","in":"query","required":true,"schema":{"type":"string","description":"创作者ID/Creator author ID","title":"Author Id"},"description":"创作者ID/Creator author ID","example":"7589271892177518598"},{"name":"keyword_type","in":"query","required":false,"schema":{"type":"integer","description":"热词类型/Keyword type","default":0,"title":"Keyword Type"},"description":"热词类型/Keyword type","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_recommend_for_star_authors":{"post":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取相似创作者推荐/Get Recommend Similar Star Authors","description":"# [中文]\n### 用途:\n- 获取相似创作者推荐\n- 价格：0.001$ / 次\n### 参数:\n- author_ids: 创作者ID列表\n- similar_type: 相似类型\n    - `comprehension`: 综合相似\n    - `content`: 内容相似\n    - `audience`: 用户相似\n    - `commercial`: 商业能力相似\n- page: 页码，默认1\n- limit: 每页数量，默认12\n### 返回:\n- 相似创作者推荐数据\n\n# [English]\n### Purpose:\n- Get similar creator recommendation\n- Price: 0.001$ / time\n### Parameters:\n- author_ids: List of creator/author IDs\n- similar_type: Similarity type\n    - `comprehension`: Comprehensive similarity\n    - `content`: Content similarity\n    - `audience`: Audience similarity\n    - `commercial`: Commercial capability similarity\n- page: Page number, default 1\n- limit: Page size, default 12\n### Return:\n- Similar creator recommendation data\n\n# [示例/Example]\nauthor_ids = [\"7589271892177518598\"]\nsimilar_type = \"content\"","operationId":"get_recommend_for_star_authors_api_v1_douyin_xingtu_v2_get_recommend_for_star_authors_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_recommend_for_star_authors_api_v1_douyin_xingtu_v2_get_recommend_for_star_authors_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/xingtu_v2/get_excellent_case_category_list":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取优秀行业分类列表/Get Excellent Case Category List","description":"# [中文]\n### 用途:\n- 获取连接用户漏斗中的优秀行业分类列表\n- 价格：0.001$ / 次\n### 参数:\n- platform_source: 平台来源，默认1\n### 返回:\n- 优秀行业分类列表数据\n\n# [English]\n### Purpose:\n- Get the excellent case category list in the user connection funnel\n- Price: 0.001$ / time\n### Parameters:\n- platform_source: Platform source, default 1\n### Return:\n- Excellent case category list data\n\n# [示例/Example]\nplatform_source = 1","operationId":"get_excellent_case_category_list_api_v1_douyin_xingtu_v2_get_excellent_case_category_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"platform_source","in":"query","required":false,"schema":{"type":"integer","description":"平台来源/Platform source","default":1,"title":"Platform Source"},"description":"平台来源/Platform source","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_author_spread_info":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取创作者传播价值/Get Author Spread Info","description":"# [中文]\n### 用途:\n- 获取创作者商业能力的传播价值信息\n- 价格：0.001$ / 次\n### 参数:\n- o_author_id: 创作者ID\n- platform_source: 平台来源，默认1\n- platform_channel: 平台渠道，默认1\n- type: 视频类型，1=个人视频\n- flow_type: 流量类型，默认0\n- only_assign: 仅看指派视频，默认False\n- range: 时间范围，2=近30天，3=近90天\n### 返回:\n- 创作者传播价值数据\n\n# [English]\n### Purpose:\n- Get creator/author spread value information (commercial capability)\n- Price: 0.001$ / time\n### Parameters:\n- o_author_id: Creator/author ID\n- platform_source: Platform source, default 1\n- platform_channel: Platform channel, default 1\n- type: Video type, 1=personal video\n- flow_type: Flow type, default 0\n- only_assign: Only assigned videos, default False\n- range: Time range, 2=last 30 days, 3=last 90 days\n### Return:\n- Creator spread value data\n\n# [示例/Example]\no_author_id = \"7589271892177518598\"\nrange = 2","operationId":"get_author_spread_info_api_v1_douyin_xingtu_v2_get_author_spread_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"o_author_id","in":"query","required":true,"schema":{"type":"string","description":"创作者ID/Creator author ID","title":"O Author Id"},"description":"创作者ID/Creator author ID","example":"7589271892177518598"},{"name":"platform_source","in":"query","required":false,"schema":{"type":"integer","description":"平台来源/Platform source","default":1,"title":"Platform Source"},"description":"平台来源/Platform source","example":1},{"name":"platform_channel","in":"query","required":false,"schema":{"type":"integer","description":"平台渠道/Platform channel","default":1,"title":"Platform Channel"},"description":"平台渠道/Platform channel","example":1},{"name":"type","in":"query","required":false,"schema":{"type":"integer","description":"视频类型，1=个人视频/Video type, 1=personal video","default":1,"title":"Type"},"description":"视频类型，1=个人视频/Video type, 1=personal video","example":1},{"name":"flow_type","in":"query","required":false,"schema":{"type":"integer","description":"流量类型/Flow type","default":0,"title":"Flow Type"},"description":"流量类型/Flow type","example":0},{"name":"only_assign","in":"query","required":false,"schema":{"type":"boolean","description":"仅看指派视频/Only assigned videos","default":false,"title":"Only Assign"},"description":"仅看指派视频/Only assigned videos","example":false},{"name":"range","in":"query","required":false,"schema":{"type":"integer","description":"时间范围，2=近30天，3=近90天/Time range, 2=last 30 days, 3=last 90 days","default":2,"title":"Range"},"description":"时间范围，2=近30天，3=近90天/Time range, 2=last 30 days, 3=last 90 days","example":2}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_user_profile_qrcode":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取用户主页二维码/Get User Profile QRCode","description":"# [中文]\n### 用途:\n- 生成用户主页二维码\n- core_user_id和sec_uid二选一传入即可\n- 价格：0.001$ / 次\n### 参数:\n- core_user_id: 用户核心ID（与sec_uid二选一）\n- sec_uid: 用户sec_uid（与core_user_id二选一）\n### 返回:\n- 用户主页二维码数据\n\n# [English]\n### Purpose:\n- Generate user profile QR code\n- Either core_user_id or sec_uid is required\n- Price: 0.001$ / time\n### Parameters:\n- core_user_id: User core ID (pick one with sec_uid)\n- sec_uid: User sec_uid (pick one with core_user_id)\n### Return:\n- User profile QR code data\n\n# [示例/Example]\ncore_user_id = \"1113181577281568\"","operationId":"get_user_profile_qrcode_api_v1_douyin_xingtu_v2_get_user_profile_qrcode_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"core_user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"用户核心ID(与sec_uid二选一)/User core ID (pick one with sec_uid)","title":"Core User Id"},"description":"用户核心ID(与sec_uid二选一)/User core ID (pick one with sec_uid)","example":"1113181577281568"},{"name":"sec_uid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"用户sec_uid(与core_user_id二选一)/User sec_uid (pick one with core_user_id)","title":"Sec Uid"},"description":"用户sec_uid(与core_user_id二选一)/User sec_uid (pick one with core_user_id)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_content_trend_guide":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取内容趋势指南/Get Content Trend Guide","description":"# [中文]\n### 用途:\n- 获取内容趋势指南数据（CDN静态JSON，无需Cookie）\n- 价格：0.001$ / 次\n### 返回:\n- 内容趋势指南数据\n\n# [English]\n### Purpose:\n- Get content trend guide data (CDN static JSON, no cookie needed)\n- Price: 0.001$ / time\n### Return:\n- Content trend guide data","operationId":"get_content_trend_guide_api_v1_douyin_xingtu_v2_get_content_trend_guide_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/xingtu_v2/get_ip_activity_industry_list":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取星图IP日历行业列表/Get IP Activity Industry List","description":"# [中文]\n### 用途:\n- 获取星图IP日历的行业列表\n- 价格：0.001$ / 次\n### 返回:\n- 行业列表数据\n\n# [English]\n### Purpose:\n- Get the industry list for XingTu IP calendar\n- Price: 0.001$ / time\n### Return:\n- Industry list data","operationId":"get_ip_activity_industry_list_api_v1_douyin_xingtu_v2_get_ip_activity_industry_list_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/xingtu_v2/get_ip_activity_list":{"post":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取星图IP日历活动列表/Get IP Activity List","description":"# [中文]\n### 用途:\n- 获取星图IP日历活动列表\n- 价格：0.001$ / 次\n### 参数:\n- query_start_time: 查询开始时间戳，如`1767196800`\n- query_end_time: 查询结束时间戳，如`1774972799`\n- industry_id_list (可选): 行业ID列表，从`get_ip_activity_industry_list`获取\n    - 例：`[\"1930\"]`=美妆, `[\"1901\"]`=3C及电器, `[\"1903\"]`=食品饮料\n- category_list (可选): IP类型列表\n    - 1=星图大事件, 2=电商节点, 3=情绪节点, 4=创意营销, 5=行业活动\n- status_list (可选): IP状态列表\n    - 40=筹备中, 50=招商中, 30=资源上线, 20=已结束\n### 返回:\n- IP日历活动列表数据\n\n# [English]\n### Purpose:\n- Get XingTu IP calendar activity list\n- Price: 0.001$ / time\n### Parameters:\n- query_start_time: Query start timestamp, e.g. `1767196800`\n- query_end_time: Query end timestamp, e.g. `1774972799`\n- industry_id_list (optional): Industry ID list from `get_ip_activity_industry_list`\n    - Example: `[\"1930\"]`=Beauty, `[\"1901\"]`=3C & Electronics, `[\"1903\"]`=Food & Beverage\n- category_list (optional): IP category list\n    - 1=XingTu Big Event, 2=E-commerce Node, 3=Emotion Node, 4=Creative Marketing, 5=Industry Activity\n- status_list (optional): IP status list\n    - 40=Preparing, 50=Recruiting, 30=Resources Online, 20=Ended\n### Return:\n- IP calendar activity list data\n\n# [示例/Example]\nquery_start_time = \"1767196800\"\nquery_end_time = \"1774972799\"","operationId":"get_ip_activity_list_api_v1_douyin_xingtu_v2_get_ip_activity_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_ip_activity_list_api_v1_douyin_xingtu_v2_get_ip_activity_list_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/douyin/xingtu_v2/get_ip_activity_detail":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取星图IP活动详情/Get IP Activity Detail","description":"# [中文]\n### 用途:\n- 获取星图IP日历活动详情\n- 价格：0.001$ / 次\n### 参数:\n- id: 活动ID，从`get_ip_activity_list`获取\n### 返回:\n- IP活动详情数据\n\n# [English]\n### Purpose:\n- Get XingTu IP calendar activity detail\n- Price: 0.001$ / time\n### Parameters:\n- id: Activity ID, from `get_ip_activity_list`\n### Return:\n- IP activity detail data\n\n# [示例/Example]\nid = 347","operationId":"get_ip_activity_detail_api_v1_douyin_xingtu_v2_get_ip_activity_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"integer","description":"活动ID，从get_ip_activity_list获取/Activity ID from get_ip_activity_list","title":"Id"},"description":"活动ID，从get_ip_activity_list获取/Activity ID from get_ip_activity_list","example":347}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_resource_list":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"获取营销活动案例/Get Resource List","description":"# [中文]\n### 用途:\n- 获取营销活动案例列表\n- 价格：0.001$ / 次\n### 参数:\n- resource_id: 资源ID\n### 返回:\n- 营销活动案例数据\n\n# [English]\n### Purpose:\n- Get marketing activity resource list\n- Price: 0.001$ / time\n### Parameters:\n- resource_id: Resource ID\n### Return:\n- Marketing activity resource data\n\n# [示例/Example]\nresource_id = 1052","operationId":"get_resource_list_api_v1_douyin_xingtu_v2_get_resource_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"resource_id","in":"query","required":true,"schema":{"type":"integer","description":"资源ID/Resource ID","title":"Resource Id"},"description":"资源ID/Resource ID","example":1052}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/douyin/xingtu_v2/get_demander_mcn_list":{"get":{"tags":["Douyin-Xingtu-V2-API"],"summary":"搜索MCN机构列表/Get Demander MCN List","description":"# [中文]\n### 用途:\n- 搜索MCN机构列表\n- 价格：0.001$ / 次\n### 参数:\n- mcn_name: MCN机构名称，支持模糊搜索\n- page: 页码，默认1\n- limit: 每页数量，默认20\n- order_by: 排序方式，`platform_scores`=平台评分\n### 返回:\n- MCN机构列表数据\n\n# [English]\n### Purpose:\n- Search MCN organization list\n- Price: 0.001$ / time\n### Parameters:\n- mcn_name: MCN name, supports fuzzy search\n- page: Page number, default 1\n- limit: Page size, default 20\n- order_by: Sort by, `platform_scores`=platform scores\n### Return:\n- MCN organization list data\n\n# [示例/Example]\nmcn_name = \"\"\npage = 1\nlimit = 20","operationId":"get_demander_mcn_list_api_v1_douyin_xingtu_v2_get_demander_mcn_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"mcn_name","in":"query","required":false,"schema":{"type":"string","description":"MCN机构名称，支持模糊搜索/MCN name, supports fuzzy search","default":"","title":"Mcn Name"},"description":"MCN机构名称，支持模糊搜索/MCN name, supports fuzzy search","example":""},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Page size","default":20,"title":"Limit"},"description":"每页数量/Page size","example":20},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort by","default":"platform_scores","title":"Order By"},"description":"排序方式/Sort by","example":"platform_scores"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xigua/app/v2/fetch_one_video":{"get":{"tags":["Xigua-App-V2-API"],"summary":"获取单个作品数据/Get single video data","description":"# [中文]\n### 用途:\n- 获取单个作品数据（信息较少，不包含标题等信息，但是包含相关视频的信息）\n### 参数:\n- item_id: 作品id\n### 返回:\n- 作品数据，其中包含视频链接的Base64编码播放地址，需要前端解码后使用，或者使用 /fetch_one_video_play_url 获取播放链接。\n\n# [English]\n### Purpose:\n- Get single video data (less information, does not include title and other information, but includes information about related videos)\n### Parameters:\n- item_id: Video id\n### Return:\n- Video data, which contains the Base64 encoded playback address of the video link, which needs to be decoded and used by the front end, or use /fetch_one_video_play_url to get the playback link.\n\n# [示例/Example]\nitem_id: \"7354954305222377999\"","operationId":"fetch_one_video_api_v1_xigua_app_v2_fetch_one_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7354954305222377999"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xigua/app/v2/fetch_one_video_v2":{"get":{"tags":["Xigua-App-V2-API"],"summary":"获取单个作品数据 V2/Get single video data V2","description":"# [中文]\n### 用途:\n- 获取单个作品数据（信息全面，包含标题等信息，但是不包含相关视频推荐信息）\n### 参数:\n- item_id: 作品id\n### 返回:\n- 作品数据，其中包含视频链接的Base64编码播放地址，需要前端解码后使用，或者使用 /fetch_one_video_play_url 获取播放链接。\n\n# [English]\n### Purpose:\n- Get single video data (more comprehensive information, including title and other information, but not including information about related video recommendations)\n### Parameters:\n- item_id: Video id\n### Return:\n- Video data, which contains the Base64 encoded playback address of the video link, which needs to be decoded and used by the front end, or use /fetch_one_video_play_url to get the playback link.\n\n# [示例/Example]\nitem_id: \"7354954305222377999\"","operationId":"fetch_one_video_v2_api_v1_xigua_app_v2_fetch_one_video_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7354954305222377999"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xigua/app/v2/fetch_one_video_play_url":{"get":{"tags":["Xigua-App-V2-API"],"summary":"获取单个作品的播放链接/Get single video play URL","description":"# [中文]\n### 用途:\n- 获取单个作品的播放链接，此接口返回的是已经解码后的播放链接，可以直接使用。\n### 参数:\n- item_id: 作品id\n### 返回:\n- 作品的播放链接的明文链接。\n\n# [English]\n### Purpose:\n- Get single video play URL, the interface returns the decoded play URL, which can be used directly.\n### Parameters:\n- item_id: Video id\n### Return:\n- Play URL of the video, plaintext link.\n\n# [示例/Example]\nitem_id: \"7354954305222377999\"","operationId":"fetch_one_video_play_url_api_v1_xigua_app_v2_fetch_one_video_play_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7354954305222377999"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xigua/app/v2/fetch_video_comment_list":{"get":{"tags":["Xigua-App-V2-API"],"summary":"视频评论列表/Video comment list","description":"# [中文]\n### 用途:\n- 视频评论列表\n### 参数:\n- item_id: 作品id\n- offset: 偏移量，第一次请求传0，后续请求传上一次请求返回的offset\n- count: 数量，默认20，建议保持默认。\n### 返回:\n- 评论列表\n\n# [English]\n### Purpose:\n- Video comment list\n### Parameters:\n- item_id: Video id\n- offset: Offset, pass 0 for the first request, pass the offset returned by the previous request for subsequent requests\n- count: Quantity, default 20, it is recommended to keep the default.\n### Return:\n- Comment list\n\n# [示例/Example]\nitem_id: \"7354954305222377999\"","operationId":"fetch_video_comment_list_api_v1_xigua_app_v2_fetch_video_comment_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Item Id"},"description":"作品id/Video id","example":"7354954305222377999"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Count","default":20,"title":"Count"},"description":"数量/Count"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xigua/app/v2/search_video":{"get":{"tags":["Xigua-App-V2-API"],"summary":"搜索视频/Search video","description":"# [中文]\n### 用途:\n- 搜索视频\n### 参数:\n- keyword: 关键词\n- offset: 偏移量，第一次请求传0，后续请求传上一次请求返回的offset\n- order_type: 排序方式，为空时按照默认排序，以下为可选排序方式。\n    - 最新: publish_time\n    - 最热: play_count\n- min_duration: 最小时长，默认空，单位秒。\n- max_duration: 最大时长，默认空，单位秒。\n### 返回:\n- 视频列表\n\n# [English]\n### Purpose:\n- Search video\n### Parameters:\n- keyword: Keyword\n- offset: Offset, pass 0 for the first request, pass the offset returned by the previous request for subsequent requests\n- order_type: Order type, empty for default sorting, the following are optional sorting methods.\n    - Newest: publish_time\n    - Hottest: play_count\n- min_duration: Minimum duration, default empty, in seconds.\n- max_duration: Maximum duration, default empty, in seconds.\n### Return:\n- Video list\n\n# [示例/Example]\n> 搜索关键字为“抖音”的视频，按照播放量排序，时长1-180秒(1-3分钟)\n> Search for videos with the keyword \"抖音\", sorted by play count, duration 1-180 seconds (1-3 minutes)\nkeyword: \"抖音\"\norder_type: \"play_count\"\nmin_duration: 1\nmax_duration: 180","operationId":"search_video_api_v1_xigua_app_v2_search_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"关键词/Keyword","title":"Keyword"},"description":"关键词/Keyword","example":"抖音"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"order_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Order type","title":"Order Type"},"description":"排序方式/Order type"},{"name":"min_duration","in":"query","required":false,"schema":{"type":"integer","description":"最小时长/Minimum duration","title":"Min Duration"},"description":"最小时长/Minimum duration"},{"name":"max_duration","in":"query","required":false,"schema":{"type":"integer","description":"最大时长/Maximum duration","title":"Max Duration"},"description":"最大时长/Maximum duration"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xigua/app/v2/fetch_user_info":{"get":{"tags":["Xigua-App-V2-API"],"summary":"个人信息/Personal information","description":"# [中文]\n### 用途:\n- 个人信息\n### 参数:\n- user_id: 用户id\n### 返回:\n- 个人信息\n\n# [English]\n### Purpose:\n- Personal information\n### Parameters:\n- user_id: User id\n### Return:\n- Personal information\n\n# [示例/Example]\nuser_id: \"52712347586\"","operationId":"fetch_user_info_api_v1_xigua_app_v2_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"User Id"},"description":"用户id/User id","example":"52712347586"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xigua/app/v2/fetch_user_post_list":{"get":{"tags":["Xigua-App-V2-API"],"summary":"获取个人作品列表/Get user post list","description":"# [中文]\n### 用途:\n- 获取个人作品列表\n### 参数:\n- user_id: 用户id\n- max_behot_time: 最大行为时间，默认空，第一次请求传空，后续请求传上一次请求返回数据中的JSON中的值。\n- max_behot_time的值可以是JSON路径为：$.data.data.[-1].behot_time\n- 也就是data中的最后一个元素的cursor值\n### 返回:\n- 作品列表\n\n# [English]\n### Purpose:\n- Get user post list\n### Parameters:\n- user_id: User id\n- max_behot_time: Maximum behavior time, default empty, pass empty for the first request, pass the max_behot_time returned by the previous request for subsequent requests\n- The value of max_behot_time can be the JSON path: $.data.data.[-1].behot_time\n- That is, the cursor value of the last element in data\n### Return:\n- Post list\n\n# [示例/Example]\nuser_id = \"1922379661976311\"\nmax_behot_time = \"\"","operationId":"fetch_user_post_list_api_v1_xigua_app_v2_fetch_user_post_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"User Id"},"description":"用户id/User id","example":"1922379661976311"},{"name":"max_behot_time","in":"query","required":false,"schema":{"type":"string","description":"最大行为时间/Maximum behavior time","title":"Max Behot Time"},"description":"最大行为时间/Maximum behavior time"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/toutiao/web/get_article_info":{"get":{"tags":["Toutiao-Web-API"],"summary":"获取指定文章的信息/Get information of specified article","description":"# [中文]\n### 用途:\n- 获取指定文章的信息\n### 参数:\n- aweme_id: 作品ID，可以从链接中获取\n    - 例如: https://www.toutiao.com/article/7450114952884503059/\n### 返回:\n- 作品信息\n\n# [English]\n### Purpose:\n- Get information of specified post\n### Parameters:\n- item_id: Post ID, can be obtained from the link\n    - For example: https://www.toutiao.com/article/7450114952884503059/\n### Return:\n- Post information\n\n# [示例/Example]\naweme_id = \"7450114952884503059\"","operationId":"get_article_info_api_v1_toutiao_web_get_article_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品ID/Post ID","title":"Aweme Id"},"description":"作品ID/Post ID","example":"7450114952884503059"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/toutiao/web/get_video_info":{"get":{"tags":["Toutiao-Web-API"],"summary":"获取指定视频的信息/Get information of specified video","description":"# [中文]\n### 用途:\n- 获取指定视频的信息\n### 参数:\n- aweme_id: 作品ID，可以从链接中获取\n    - 例如: https://www.toutiao.com/video/7431543350882206242/\n### 返回:\n- 作品信息\n\n# [English]\n### Purpose:\n- Get information of specified video\n### Parameters:\n- item_id: Post ID, can be obtained from the link\n    - For example: https://www.toutiao.com/video/7431543350882206242/\n### Return:\n- Post information\n\n# [示例/Example]\naweme_id = \"7431543350882206242\"","operationId":"get_video_info_api_v1_toutiao_web_get_video_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aweme_id","in":"query","required":true,"schema":{"type":"string","description":"作品ID/Post ID","title":"Aweme Id"},"description":"作品ID/Post ID","example":"7431543350882206242"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/toutiao/app/get_article_info":{"get":{"tags":["Toutiao-App-API"],"summary":"获取指定文章的信息/Get information of specified article","description":"# [中文]\n### 用途:\n- 获取指定文章的信息\n### 参数:\n- group_id: 作品ID，可以从链接中获取\n    - 例如: https://www.toutiao.com/article/7450114952884503059/\n### 返回:\n- 作品信息\n\n# [English]\n### Purpose:\n- Get information of specified post\n### Parameters:\n- group_id: Post ID, can be obtained from the link\n    - For example: https://www.toutiao.com/article/7450114952884503059/\n### Return:\n- Post information\n\n# [示例/Example]\ngroup_id = \"7450114952884503059\"","operationId":"get_article_info_api_v1_toutiao_app_get_article_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"group_id","in":"query","required":true,"schema":{"type":"string","description":"作品ID/Post ID","title":"Group Id"},"description":"作品ID/Post ID","example":"7450114952884503059"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/toutiao/app/get_video_info":{"get":{"tags":["Toutiao-App-API"],"summary":"获取指定视频的信息/Get information of specified video","description":"# [中文]\n### 用途:\n- 获取指定视频的信息\n### 参数:\n- group_id: 作品ID，可以从链接中获取\n    - 例如: https://www.toutiao.com/video/7431543350882206242/\n### 返回:\n- 作品信息\n\n# [English]\n### Purpose:\n- Get information of specified video\n### Parameters:\n- group_id: Post ID, can be obtained from the link\n    - For example: https://www.toutiao.com/video/7431543350882206242/\n### Return:\n- Post information\n\n# [示例/Example]\ngroup_id = \"7431543350882206242\"","operationId":"get_video_info_api_v1_toutiao_app_get_video_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"group_id","in":"query","required":true,"schema":{"type":"string","description":"作品ID/Post ID","title":"Group Id"},"description":"作品ID/Post ID","example":"7431543350882206242"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/toutiao/app/get_comments":{"get":{"tags":["Toutiao-App-API"],"summary":"获取指定作品的评论/Get comments of specified post","description":"# [中文]\n### 用途:\n- 获取指定作品的评论\n### 参数:\n- group_id: 作品ID，可以从链接中获取\n    - 例如: https://www.toutiao.com/i7453372680222523931/\n- offset: 偏移量，用于分页，默认为0，然后每次加20\n### 返回:\n- 评论列表\n\n# [English]\n### Purpose:\n- Get comments of specified post\n### Parameters:\n- group_id: Post ID, can be obtained from the link\n    - For example: https://www.toutiao.com/i7453372680222523931/\n- offset: Offset, used for pagination, default is 0, then add 20 each time\n### Return:\n- Comment list\n\n# [示例/Example]\ngroup_id = \"7453372680222523931\"\noffset = \"0\"","operationId":"get_comments_api_v1_toutiao_app_get_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"group_id","in":"query","required":true,"schema":{"type":"string","description":"作品ID/Post ID","title":"Group Id"},"description":"作品ID/Post ID","example":"7453372680222523931"},{"name":"offset","in":"query","required":true,"schema":{"type":"string","description":"偏移量/Offset","title":"Offset"},"description":"偏移量/Offset","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/toutiao/app/get_user_info":{"get":{"tags":["Toutiao-App-API"],"summary":"获取指定用户的信息/Get information of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户的信息\n### 参数:\n- user_id: 用户ID，可以从以下接口获取：\n    - `/api/v1/toutiao/app/get_user_id`\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get information of specified user\n### Parameters:\n- user_id: User ID, can be obtained from the following API:\n    - `/api/v1/toutiao/app/get_user_id`\n### Return:\n- User information\n\n# [示例/Example]\nuser_id = \"1352838578180211\"","operationId":"get_user_info_api_v1_toutiao_app_get_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"1352838578180211"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/toutiao/app/get_user_id":{"get":{"tags":["Toutiao-App-API"],"summary":"从头条用户主页获取用户user_id/Get user_id from user profile","description":"# [中文]\n### 用途:\n- 从头条用户主页获取用户user_id\n### 参数:\n- user_profile_url: 用户主页链接\n    - 例如: https://www.toutiao.com/c/user/token/MS4wLjABAAAAwK6echNksY69R8l2vcZudupfhTItbGSGt-8ineO5UaB4L-djqkYDgB6TkAdMvrmW/\n### 返回:\n- 用户ID\n\n# [English]\n### Purpose:\n- Get user_id from user profile\n### Parameters:\n- user_profile_url: User profile URL\n    - For example: https://www.toutiao.com/c/user/token/MS4wLjABAAAAwK6echNksY69R8l2vcZudupfhTItbGSGt-8ineO5UaB4L-djqkYDgB6TkAdMvrmW/\n### Return:\n- User ID\n\n# [示例/Example]\nuser_profile_url = \"https://www.toutiao.com/c/user/token/MS4wLjABAAAAwK6echNksY69R8l2vcZudupfhTItbGSGt-8ineO5UaB4L-djqkYDgB6TkAdMvrmW/\"","operationId":"get_user_id_api_v1_toutiao_app_get_user_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_profile_url","in":"query","required":true,"schema":{"type":"string","description":"用户主页链接/User profile URL","title":"User Profile Url"},"description":"用户主页链接/User profile URL","example":"https://www.toutiao.com/c/user/token/MS4wLjABAAAAwK6echNksY69R8l2vcZudupfhTItbGSGt-8ineO5UaB4L-djqkYDgB6TkAdMvrmW/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_image_note_detail":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取图文笔记详情/Get image note detail","description":"# [中文]\n### 用途:\n- 获取图文笔记的完整详情数据\n### 接口优先级:\n- ⭐ 小红书接口推荐优先级: `App V2（本接口）` > `App` > `Web V2` > `Web`\n### 参数:\n- note_id: 笔记ID，如 \"697c0eee000000000a03c308\"\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n### 返回:\n- 图文笔记详情数据，包含笔记内容、图片列表、作者信息、互动数据等\n\n# [English]\n### Purpose:\n- Get full detail data of an image note\n### API Priority:\n- ⭐ Xiaohongshu API priority: `App V2 (this)` > `App` > `Web V2` > `Web`\n### Parameters:\n- note_id: Note ID, e.g. \"697c0eee000000000a03c308\"\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n### Return:\n- Image note detail data, including note content, image list, author info, interaction data, etc.\n\n# [示例/Example]\nnote_id=\"697c0eee000000000a03c308\"","operationId":"get_image_note_detail_api_v1_xiaohongshu_app_v2_get_image_note_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"697c0eee000000000a03c308"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"http://xhslink.com/o/8GqargIxrko"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_video_note_detail":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取视频笔记详情/Get video note detail","description":"# [中文]\n### 用途:\n- 获取视频笔记的完整详情数据\n### 参数:\n- note_id: 笔记ID，如 \"697c0eee000000000a03c308\"\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n### 返回:\n- 视频笔记详情数据，包含视频播放地址、封面图、作者信息、互动数据等\n\n# [English]\n### Purpose:\n- Get full detail data of a video note\n### Parameters:\n- note_id: Note ID, e.g. \"697c0eee000000000a03c308\"\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n### Return:\n- Video note detail data, including video play URL, cover image, author info, interaction data, etc.\n\n# [示例/Example]\nnote_id=\"697c0eee000000000a03c308\"","operationId":"get_video_note_detail_api_v1_xiaohongshu_app_v2_get_video_note_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"697c0eee000000000a03c308"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"http://xhslink.com/o/8GqargIxrko"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_mixed_note_detail":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取首页推荐流笔记详情/Get mixed note detail from feed","description":"# [中文]\n### 用途:\n- 从首页推荐流中获取指定笔记的详情\n- 返回的数据结构与图文/视频接口不同，包含推荐流上下文信息\n### 参数:\n- note_id: 笔记ID（可选），如 \"697c0eee000000000a03c308\"，为空则返回首页推荐流数据\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n### 返回:\n- 推荐流笔记详情数据，包含推荐流上下文信息\n\n# [English]\n### Purpose:\n- Get note detail from homepage feed\n- The returned data structure differs from image/video endpoints, including feed context info\n### Parameters:\n- note_id: Note ID (optional), e.g. \"697c0eee000000000a03c308\", returns homepage feed data if empty\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n### Return:\n- Feed note detail data, including feed context info\n\n# [示例/Example]\nnote_id=\"697c0eee000000000a03c308\"","operationId":"get_mixed_note_detail_api_v1_xiaohongshu_app_v2_get_mixed_note_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"697c0eee000000000a03c308"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"http://xhslink.com/o/8GqargIxrko"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_note_comments":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取笔记评论列表/Get note comments","description":"# [中文]\n### 用途:\n- 获取指定笔记的评论列表，支持分页和多种排序方式\n### 参数:\n- note_id: 笔记ID，如 \"697c0eee000000000a03c308\"\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n- cursor: 分页游标，首次请求留空，翻页时传入上一次响应中返回的 cursor 值\n- index: 评论索引，首次请求传 0，翻页时传入上一次响应中返回的 index 值\n- pageArea: 折叠状态，默认 \"UNFOLDED\"（展开），翻页时传入上一次响应中返回的 pageArea 值\n- sort_strategy: 排序策略\n    - \"latest_v2\": 按时间倒序（最新，默认使用）\n    - \"like_count\": 按点赞数排序（最热）\n    - \"default\": 默认排序（不推荐，翻页时会丢失评论或重复抓取评论）\n### 返回:\n- 评论数据对象，包含评论列表、分页游标等\n### 翻页说明:\n- 首次请求：cursor留空，index传0\n- 翻页请求：传入上一次响应中返回的 cursor 和 index 和 pageArea 值\n\n# [English]\n### Purpose:\n- Get comment list for a specified note, supports pagination and multiple sort strategies\n### Parameters:\n- note_id: Note ID, e.g. \"697c0eee000000000a03c308\"\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n- cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response for next page\n- index: Comment index, pass 0 for first request, pass index value from previous response for next page\n- pageArea: Fold status, default \"UNFOLDED\" (unfolded), pass pageArea value from previous response for next page\n- sort_strategy: Sort strategy\n    - \"latest_v2\": Sort by time desc (latest, recommended default)\n    - \"like_count\": Sort by like_count\n    - \"default\": Sort by default (not recommended, may cause missing or duplicate comments when paginating)\n### Return:\n- Comments data object, including comment list, pagination cursor, etc.\n### Pagination Guide:\n- First request: leave cursor empty, pass index as 0\n- Next page: pass cursor and index and pageArea values from previous response\n\n# [示例/Example]\nnote_id=\"697c0eee000000000a03c308\"\nsort_strategy=\"latest_v2\"","operationId":"get_note_comments_api_v1_xiaohongshu_app_v2_get_note_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"697c0eee000000000a03c308"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"http://xhslink.com/o/8GqargIxrko"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","default":"","title":"Cursor"},"description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","example":""},{"name":"index","in":"query","required":false,"schema":{"type":"integer","description":"评论索引，首次请求传0/Comment index, pass 0 for first request","default":0,"title":"Index"},"description":"评论索引，首次请求传0/Comment index, pass 0 for first request","example":0},{"name":"pageArea","in":"query","required":false,"schema":{"type":"string","description":"折叠状态: UNFOLDED(默认-展开), FOLDED(折叠)","default":"UNFOLDED","title":"Pagearea"},"description":"折叠状态: UNFOLDED(默认-展开), FOLDED(折叠)","example":"UNFOLDED"},{"name":"sort_strategy","in":"query","required":false,"schema":{"type":"string","description":"排序策略/Sort strategy: default, latest_v2, like_count","default":"latest_v2","title":"Sort Strategy"},"description":"排序策略/Sort strategy: default, latest_v2, like_count","example":"latest_v2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_note_sub_comments":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取笔记二级评论列表/Get note sub comments","description":"# [中文]\n### 用途:\n- 获取指定笔记某条评论下的子评论（回复）列表，使用游标分页\n### 参数:\n- note_id: 笔记ID，如 \"699916e6000000001d0253da\"\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n- comment_id: 父评论ID（必需），如 \"699fb9930000000008030db6\"\n- cursor: 分页游标，首次请求留空，翻页时从上一次响应的 `$.data.data.cursor` 中提取 `cursor` 字段的值\n- index: 分页索引，首次请求传 1，翻页时从上一次响应的 `$.data.data.cursor` 中提取 `index` 字段的值\n### 返回:\n- 子评论数据对象，包含子评论列表、分页游标等\n### 翻页说明:\n- 响应中的 `$.data.data.cursor` 是一个 JSON 对象，示例: `{\"cursor\":\"69a0c134000000000c00910d\",\"index\":3}`\n- 首次请求：cursor留空，index传1\n- 翻页请求：从 `$.data.data.cursor` 中提取 `cursor` 和 `index` 分别传入对应参数\n\n# [English]\n### Purpose:\n- Get sub-comment (reply) list under a specific comment of a note, using cursor pagination\n### Parameters:\n- note_id: Note ID, e.g. \"699916e6000000001d0253da\"\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n- comment_id: Parent comment ID (required), e.g. \"699fb9930000000008030db6\"\n- cursor: Pagination cursor, leave empty for first request, extract `cursor` value from `$.data.cursor` of previous response for next page\n- index: Pagination index, pass 1 for first request, extract `index` value from `$.data.cursor` of previous response for next page\n### Return:\n- Sub-comments data object, including sub-comment list, pagination cursor, etc.\n### Pagination Guide:\n- The `$.data.data.cursor` in response is a JSON object, e.g. `{\"cursor\":\"69a0c134000000000c00910d\",\"index\":3}`\n- First request: leave cursor empty, pass index as 1\n- Next page: extract `cursor` and `index` from `$.data.data.cursor` and pass them as corresponding parameters\n\n# [示例/Example]\nnote_id=\"699916e6000000001d0253da\"\ncomment_id=\"699fb9930000000008030db6\"","operationId":"get_note_sub_comments_api_v1_xiaohongshu_app_v2_get_note_sub_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"699916e6000000001d0253da"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"http://xhslink.com/o/8GqargIxrko"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"父评论ID/Parent comment ID","title":"Comment Id"},"description":"父评论ID/Parent comment ID","example":"699fb9930000000008030db6"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次留空，翻页时从$.data.data.cursor中提取cursor值/Pagination cursor, leave empty for first request, extract cursor from $.data.cursor for next page","default":"","title":"Cursor"},"description":"分页游标，首次留空，翻页时从$.data.data.cursor中提取cursor值/Pagination cursor, leave empty for first request, extract cursor from $.data.cursor for next page","example":""},{"name":"index","in":"query","required":false,"schema":{"type":"integer","description":"分页索引，首次传1，翻页时从$.data.data.cursor中提取index值/Pagination index, pass 1 for first request, extract index from $.data.cursor for next page","default":1,"title":"Index"},"description":"分页索引，首次传1，翻页时从$.data.data.cursor中提取index值/Pagination index, pass 1 for first request, extract index from $.data.cursor for next page","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_user_info":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取用户信息/Get user info","description":"# [中文]\n### 用途:\n- 获取指定用户的详细信息\n### 参数:\n- user_id: 用户ID，如 \"61b46d790000000010008153\"\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`user_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`user_id`为准。\n### 返回:\n- 用户详细信息，包含昵称、头像、简介、粉丝数、关注数、笔记数等\n\n# [English]\n### Purpose:\n- Get detailed info of a specified user\n### Parameters:\n- user_id: User ID, e.g. \"61b46d790000000010008153\"\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail.\n### Return:\n- User detailed info, including nickname, avatar, bio, follower count, following count, note count, etc.\n\n# [示例/Example]\nuser_id=\"61b46d790000000010008153\"","operationId":"get_user_info_api_v1_xiaohongshu_app_v2_get_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","default":"","title":"User Id"},"description":"用户ID/User ID","example":"61b46d790000000010008153"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"https://xhslink.com/m/3ZSCJZAMz0a"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_user_posted_notes":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取用户笔记列表/Get user posted notes","description":"# [中文]\n### 用途:\n- 获取指定用户已发布的笔记列表，使用游标分页\n### 参数:\n- user_id: 用户ID，如 \"61b46d790000000010008153\"\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`user_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`user_id`为准。\n- cursor: 分页游标，首次请求留空，翻页时传入上一次响应中返回的 cursor 值\n    - 通常cursor取值方式为notes列表的最后一条笔记的 note_id\n    - JSON路径示例: `$.data.data.notes[-1].cursor`\n### 返回:\n- 用户笔记列表数据，包含笔记基本信息和分页信息\n### 翻页说明:\n- 首次请求：cursor留空\n- 翻页请求：传入上一次响应中返回的 cursor 值\n\n# [English]\n### Purpose:\n- Get list of notes posted by a specified user, using cursor pagination\n### Parameters:\n- user_id: User ID, e.g. \"61b46d790000000010008153\"\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail.\n- cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response for next page\n    - The cursor is usually the note_id of the last note in the notes list\n    - JSON path example: `$.data.data.notes[-1].cursor`\n### Return:\n- User posted notes list data, including basic note info and pagination info\n### Pagination Guide:\n- First request: leave cursor empty\n- Next page: pass cursor value from previous response\n\n# [示例/Example]\nuser_id=\"61b46d790000000010008153\"","operationId":"get_user_posted_notes_api_v1_xiaohongshu_app_v2_get_user_posted_notes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","default":"","title":"User Id"},"description":"用户ID/User ID","example":"61b46d790000000010008153"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"http://xhslink.com/o/8GqargIxrko"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","default":"","title":"Cursor"},"description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_user_faved_notes":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取用户收藏笔记列表/Get user faved notes","description":"# [中文]\n### 用途:\n- 获取指定用户公开收藏的笔记列表，使用游标分页\n### 参数:\n- user_id: 用户ID，如 \"5a8cf39111be10466d285d6b\"\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`user_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`user_id`为准。\n- cursor: 分页游标，首次请求留空，翻页时传入上一页列表中最后一条笔记的 note_id\n### 返回:\n- 用户收藏笔记列表数据，包含笔记基本信息和分页信息\n### 翻页说明:\n- 首次请求：cursor留空\n- 翻页请求：传入上一页列表中最后一条笔记的 note_id\n\n# [English]\n### Purpose:\n- Get list of notes faved by a specified user, using cursor pagination\n### Parameters:\n- user_id: User ID, e.g. \"5a8cf39111be10466d285d6b\"\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail.\n- cursor: Pagination cursor, leave empty for first request, pass last note_id from previous page for next page\n### Return:\n- User faved notes list data, including basic note info and pagination info\n### Pagination Guide:\n- First request: leave cursor empty\n- Next page: pass last note_id from previous page\n\n# [示例/Example]\nuser_id=\"5a8cf39111be10466d285d6b\"","operationId":"get_user_faved_notes_api_v1_xiaohongshu_app_v2_get_user_faved_notes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","default":"","title":"User Id"},"description":"用户ID/User ID","example":"5a8cf39111be10466d285d6b"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"https://xhslink.com/a/EZ4M9TwMA6c3"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求留空，翻页时传入上一页最后一条笔记的note_id/Pagination cursor, leave empty for first request, pass last note_id from previous page for next page","default":"","title":"Cursor"},"description":"分页游标，首次请求留空，翻页时传入上一页最后一条笔记的note_id/Pagination cursor, leave empty for first request, pass last note_id from previous page for next page","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/search_notes":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"搜索笔记/Search notes","description":"# [中文]\n### 用途:\n- 根据关键词搜索小红书笔记，支持多种排序方式、笔记类型筛选和发布时间筛选\n### 参数:\n- keyword: 搜索关键词（必需），如 \"美食推荐\"\n- page: 页码，从 1 开始\n- sort_type: 排序方式\n    - \"general\": 综合排序（默认）\n    - \"time_descending\": 按时间倒序（最新）\n    - \"popularity_descending\": 按点赞数排序（最多点赞）\n    - \"comment_descending\": 按评论数排序（最多评论）\n    - \"collect_descending\": 按收藏数排序（最多收藏）\n    - \"english_preferred\": 英文优先\n- note_type: 笔记类型筛选\n    - \"不限\": 所有类型（默认）\n    - \"视频笔记\": 仅视频\n    - \"普通笔记\": 仅图文\n    - \"直播笔记\": 仅直播\n- time_filter: 发布时间筛选\n    - \"不限\": 所有时间（默认）\n    - \"一天内\": 24小时内\n    - \"一周内\": 7天内\n    - \"半年内\": 6个月内\n- search_id: 搜索ID，翻页时传入首次搜索返回的值\n- search_session_id: 搜索会话ID，翻页时传入首次搜索返回的值\n- source: 来源，默认 \"explore_feed\"\n- ai_mode: AI模式，0=关闭, 1=开启\n### 返回:\n- 搜索结果数据，包含笔记列表和分页信息\n### 翻页说明:\n- 首次请求：只传keyword和page\n- 翻页请求：传入首次搜索返回的 search_id 和 search_session_id\n\n# [English]\n### Purpose:\n- Search Xiaohongshu notes by keyword, supports multiple sort types, note type filters, and time filters\n### Parameters:\n- keyword: Search keyword (required), e.g. \"美食推荐\"\n- page: Page number, start from 1\n- sort_type: Sort type\n    - \"general\": General sort (default)\n    - \"time_descending\": Sort by time descending (latest)\n    - \"popularity_descending\": Sort by like count (most liked)\n    - \"comment_descending\": Sort by comment count (most commented)\n    - \"collect_descending\": Sort by collect count (most collected)\n    - \"english_preferred\": English preferred\n- note_type: Note type filter\n    - \"不限\": All types (default)\n    - \"视频笔记\": Video notes only\n    - \"普通笔记\": Image notes only\n    - \"直播笔记\": Live notes only\n- time_filter: Time filter\n    - \"不限\": All time (default)\n    - \"一天内\": Within 24 hours\n    - \"一周内\": Within 7 days\n    - \"半年内\": Within 6 months\n- search_id: Search ID, pass value from first search response for pagination\n- search_session_id: Search session ID, pass value from first search response for pagination\n- source: Source, default \"explore_feed\"\n- ai_mode: AI mode, 0=off, 1=on\n### Return:\n- Search result data, including note list and pagination info\n### Pagination Guide:\n- First request: only pass keyword and page\n- Next page: pass search_id and search_session_id from first search response\n\n# [示例/Example]\nkeyword=\"美食推荐\"\npage=1\nsort_type=\"general\"","operationId":"search_notes_api_v1_xiaohongshu_app_v2_search_notes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"美食推荐"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码，从1开始/Page number, start from 1","default":1,"title":"Page"},"description":"页码，从1开始/Page number, start from 1","example":1},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort type","default":"general","title":"Sort Type"},"description":"排序方式/Sort type","example":"general"},{"name":"note_type","in":"query","required":false,"schema":{"type":"string","description":"笔记类型/Note type: 不限, 视频笔记, 普通笔记, 直播笔记","default":"不限","title":"Note Type"},"description":"笔记类型/Note type: 不限, 视频笔记, 普通笔记, 直播笔记","example":"不限"},{"name":"time_filter","in":"query","required":false,"schema":{"type":"string","description":"发布时间筛选/Time filter: 不限, 一天内, 一周内, 半年内","default":"不限","title":"Time Filter"},"description":"发布时间筛选/Time filter: 不限, 一天内, 一周内, 半年内","example":"不限"},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","default":"","title":"Search Id"},"description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","example":""},{"name":"search_session_id","in":"query","required":false,"schema":{"type":"string","description":"搜索会话ID，翻页时传入首次搜索返回的值/Search session ID for pagination","default":"","title":"Search Session Id"},"description":"搜索会话ID，翻页时传入首次搜索返回的值/Search session ID for pagination","example":""},{"name":"source","in":"query","required":false,"schema":{"type":"string","description":"来源/Source","default":"explore_feed","title":"Source"},"description":"来源/Source","example":"explore_feed"},{"name":"ai_mode","in":"query","required":false,"schema":{"type":"integer","description":"AI模式：0=关闭, 1=开启/AI mode: 0=off, 1=on","default":0,"title":"Ai Mode"},"description":"AI模式：0=关闭, 1=开启/AI mode: 0=off, 1=on","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/search_users":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"搜索用户/Search users","description":"# [中文]\n### 用途:\n- 根据关键词搜索小红书用户，每页返回 20 条结果，支持分页\n### 参数:\n- keyword: 搜索关键词（必需），如 \"美食博主\"\n- page: 页码，从 1 开始\n- search_id: 搜索ID，翻页时传入首次搜索返回的值\n- source: 来源，默认 \"explore_feed\"\n### 返回:\n- 搜索结果数据，包含用户列表和分页信息\n### 翻页说明:\n- 首次请求：只传keyword和page\n- 翻页请求：传入首次搜索返回的 search_id\n\n# [English]\n### Purpose:\n- Search Xiaohongshu users by keyword, returns 20 results per page, supports pagination\n### Parameters:\n- keyword: Search keyword (required), e.g. \"美食博主\"\n- page: Page number, start from 1\n- search_id: Search ID, pass value from first search response for pagination\n- source: Source, default \"explore_feed\"\n### Return:\n- Search result data, including user list and pagination info\n### Pagination Guide:\n- First request: only pass keyword and page\n- Next page: pass search_id from first search response\n\n# [示例/Example]\nkeyword=\"美食博主\"\npage=1","operationId":"search_users_api_v1_xiaohongshu_app_v2_search_users_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"美食博主"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码，从1开始/Page number, start from 1","default":1,"title":"Page"},"description":"页码，从1开始/Page number, start from 1","example":1},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","default":"","title":"Search Id"},"description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","example":""},{"name":"source","in":"query","required":false,"schema":{"type":"string","description":"来源/Source","default":"explore_feed","title":"Source"},"description":"来源/Source","example":"explore_feed"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/search_images":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"搜索图片/Search images","description":"# [中文]\n### 用途:\n- 根据关键词搜索小红书图片，每页返回 20 条结果，支持分页\n### 参数:\n- keyword: 搜索关键词（必需），如 \"壁纸\"\n- page: 页码，从 1 开始\n- search_id: 搜索ID，翻页时传入首次搜索返回的值\n- search_session_id: 搜索会话ID，翻页时传入首次搜索返回的值\n- word_request_id: 词请求ID，翻页时传入首次搜索返回的值\n- source: 来源，默认 \"explore_feed\"\n### 返回:\n- 搜索结果数据，包含图片列表和分页信息\n### 翻页说明:\n- 首次请求：只传keyword和page\n- 翻页请求：传入首次搜索返回的 search_id、search_session_id 和 word_request_id\n\n# [English]\n### Purpose:\n- Search Xiaohongshu images by keyword, returns 20 results per page, supports pagination\n### Parameters:\n- keyword: Search keyword (required), e.g. \"壁纸\"\n- page: Page number, start from 1\n- search_id: Search ID, pass value from first search response for pagination\n- search_session_id: Search session ID, pass value from first search response for pagination\n- word_request_id: Word request ID, pass value from first search response for pagination\n- source: Source, default \"explore_feed\"\n### Return:\n- Search result data, including image list and pagination info\n### Pagination Guide:\n- First request: only pass keyword and page\n- Next page: pass search_id, search_session_id, and word_request_id from first search response\n\n# [示例/Example]\nkeyword=\"壁纸\"\npage=1","operationId":"search_images_api_v1_xiaohongshu_app_v2_search_images_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"壁纸"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码，从1开始/Page number, start from 1","default":1,"title":"Page"},"description":"页码，从1开始/Page number, start from 1","example":1},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","default":"","title":"Search Id"},"description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","example":""},{"name":"search_session_id","in":"query","required":false,"schema":{"type":"string","description":"搜索会话ID，翻页时传入首次搜索返回的值/Search session ID for pagination","default":"","title":"Search Session Id"},"description":"搜索会话ID，翻页时传入首次搜索返回的值/Search session ID for pagination","example":""},{"name":"word_request_id","in":"query","required":false,"schema":{"type":"string","description":"词请求ID，翻页时传入首次搜索返回的值/Word request ID for pagination","default":"","title":"Word Request Id"},"description":"词请求ID，翻页时传入首次搜索返回的值/Word request ID for pagination","example":""},{"name":"source","in":"query","required":false,"schema":{"type":"string","description":"来源/Source","default":"explore_feed","title":"Source"},"description":"来源/Source","example":"explore_feed"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/search_products":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"搜索商品/Search products","description":"# [中文]\n### 用途:\n- 根据关键词搜索小红书商品，每页返回 20 条结果，支持分页\n### 参数:\n- keyword: 搜索关键词（必需），如 \"手机壳\"\n- page: 页码，从 1 开始\n- search_id: 搜索ID，翻页时传入首次搜索返回的值\n- source: 来源，默认 \"explore_feed\"\n### 返回:\n- 搜索结果数据，包含商品列表和分页信息\n### 翻页说明:\n- 首次请求：只传keyword和page\n- 翻页请求：传入首次搜索返回的 search_id\n\n# [English]\n### Purpose:\n- Search Xiaohongshu products by keyword, returns 20 results per page, supports pagination\n### Parameters:\n- keyword: Search keyword (required), e.g. \"手机壳\"\n- page: Page number, start from 1\n- search_id: Search ID, pass value from first search response for pagination\n- source: Source, default \"explore_feed\"\n### Return:\n- Search result data, including product list and pagination info\n### Pagination Guide:\n- First request: only pass keyword and page\n- Next page: pass search_id from first search response\n\n# [示例/Example]\nkeyword=\"手机壳\"\npage=1","operationId":"search_products_api_v1_xiaohongshu_app_v2_search_products_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"手机壳"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码，从1开始/Page number, start from 1","default":1,"title":"Page"},"description":"页码，从1开始/Page number, start from 1","example":1},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","default":"","title":"Search Id"},"description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","example":""},{"name":"source","in":"query","required":false,"schema":{"type":"string","description":"来源/Source","default":"explore_feed","title":"Source"},"description":"来源/Source","example":"explore_feed"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/search_groups":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"搜索群聊/Search groups","description":"# [中文]\n### 用途:\n- 根据关键词搜索小红书群聊列表，支持分页\n### 参数:\n- keyword: 搜索关键词（必需），如 \"上海\"\n- page_no: 页码，从 0 开始\n- search_id: 搜索ID，翻页时传入首次搜索返回的值\n- source: 来源，默认 \"unifiedSearchGroup\"\n- is_recommend: 是否推荐，0=否, 1=是\n### 返回:\n- 搜索结果数据，包含群聊列表和分页信息\n### 翻页说明:\n- 首次请求：search_id 留空（自动生成），page_no 传 0\n- 翻页请求：传入首次搜索返回的 search_id，page_no 递增\n\n# [English]\n### Purpose:\n- Search Xiaohongshu groups by keyword, supports pagination\n### Parameters:\n- keyword: Search keyword (required), e.g. \"上海\"\n- page_no: Page number, start from 0\n- search_id: Search ID, pass value from first search response for pagination\n- source: Source, default \"unifiedSearchGroup\"\n- is_recommend: Is recommend, 0=no, 1=yes\n### Return:\n- Search result data, including group list and pagination info\n### Pagination Guide:\n- First request: leave search_id empty (auto-generated), page_no pass 0\n- Next page: pass search_id from first search response, increment page_no\n\n# [示例/Example]\nkeyword=\"上海\"\npage_no=0","operationId":"search_groups_api_v1_xiaohongshu_app_v2_search_groups_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"上海"},{"name":"page_no","in":"query","required":false,"schema":{"type":"integer","description":"页码，从0开始/Page number, start from 0","default":0,"title":"Page No"},"description":"页码，从0开始/Page number, start from 0","example":0},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","default":"","title":"Search Id"},"description":"搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination","example":""},{"name":"source","in":"query","required":false,"schema":{"type":"string","description":"来源/Source","default":"unifiedSearchGroup","title":"Source"},"description":"来源/Source","example":"unifiedSearchGroup"},{"name":"is_recommend","in":"query","required":false,"schema":{"type":"integer","description":"是否推荐：0=否, 1=是/Is recommend: 0=no, 1=yes","default":0,"title":"Is Recommend"},"description":"是否推荐：0=否, 1=是/Is recommend: 0=no, 1=yes","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_product_detail":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取商品详情/Get product detail","description":"# [中文]\n### 用途:\n- 通过 SKU ID 获取商品的详细信息，包括价格、规格、库存、商品描述等\n### 参数:\n- sku_id: 商品 SKU ID（必需），如 \"669ddd44e05f3700011067ed\"\n- source: 来源，默认 \"mall_search\"\n- pre_page: 前置页面，默认 \"mall_search\"\n### 返回:\n- 商品详情数据，包含价格、规格、库存、商品描述等\n\n# [English]\n### Purpose:\n- Get product detail by SKU ID, including price, specifications, stock, description, etc.\n### Parameters:\n- sku_id: Product SKU ID (required), e.g. \"669ddd44e05f3700011067ed\"\n- source: Source, default \"mall_search\"\n- pre_page: Previous page, default \"mall_search\"\n### Return:\n- Product detail data, including price, specifications, stock, description, etc.\n\n# [示例/Example]\nsku_id=\"669ddd44e05f3700011067ed\"","operationId":"get_product_detail_api_v1_xiaohongshu_app_v2_get_product_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sku_id","in":"query","required":true,"schema":{"type":"string","description":"商品SKU ID/Product SKU ID","title":"Sku Id"},"description":"商品SKU ID/Product SKU ID","example":"669ddd44e05f3700011067ed"},{"name":"source","in":"query","required":false,"schema":{"type":"string","description":"来源/Source","default":"mall_search","title":"Source"},"description":"来源/Source","example":"mall_search"},{"name":"pre_page","in":"query","required":false,"schema":{"type":"string","description":"前置页面/Previous page","default":"mall_search","title":"Pre Page"},"description":"前置页面/Previous page","example":"mall_search"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_product_review_overview":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取商品评论总览/Get product review overview","description":"# [中文]\n### 用途:\n- 获取商品的评论统计信息，包括评分分布、好评率、评论标签等\n### 参数:\n- sku_id: 商品 SKU ID（必需），如 \"669ddd44e05f3700011067ed\"\n- tab: 标签类型，默认 2\n### 返回:\n- 商品评论总览数据，包含评分分布、好评率、评论标签等\n\n# [English]\n### Purpose:\n- Get product review statistics, including rating distribution, positive rate, review tags, etc.\n### Parameters:\n- sku_id: Product SKU ID (required), e.g. \"669ddd44e05f3700011067ed\"\n- tab: Tab type, default 2\n### Return:\n- Product review overview data, including rating distribution, positive rate, review tags, etc.\n\n# [示例/Example]\nsku_id=\"669ddd44e05f3700011067ed\"","operationId":"get_product_review_overview_api_v1_xiaohongshu_app_v2_get_product_review_overview_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sku_id","in":"query","required":true,"schema":{"type":"string","description":"商品SKU ID/Product SKU ID","title":"Sku Id"},"description":"商品SKU ID/Product SKU ID","example":"669ddd44e05f3700011067ed"},{"name":"tab","in":"query","required":false,"schema":{"type":"integer","description":"标签类型/Tab type","default":2,"title":"Tab"},"description":"标签类型/Tab type","example":2}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_product_reviews":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取商品评论列表/Get product reviews","description":"# [中文]\n### 用途:\n- 获取商品的用户评论列表，支持分页、排序和筛选有图评论\n### 参数:\n- sku_id: 商品 SKU ID（必需），如 \"669ddd44e05f3700011067ed\"\n- page: 页码，从 0 开始\n- sort_strategy_type: 排序策略\n    - 0: 综合排序（默认）\n    - 1: 最新排序\n- share_pics_only: 仅看有图评论，0=否, 1=是\n- from_page: 来源页面，默认 \"score_page\"\n### 返回:\n- 商品评论列表数据\n### 翻页说明:\n- page 从 0 开始递增\n\n# [English]\n### Purpose:\n- Get product user reviews list, supports pagination, sorting, and filtering reviews with images\n### Parameters:\n- sku_id: Product SKU ID (required), e.g. \"669ddd44e05f3700011067ed\"\n- page: Page number, start from 0\n- sort_strategy_type: Sort strategy\n    - 0: General sort (default)\n    - 1: Latest sort\n- share_pics_only: Show reviews with images only, 0=no, 1=yes\n- from_page: From page, default \"score_page\"\n### Return:\n- Product reviews list data\n### Pagination Guide:\n- page starts from 0 and increments\n\n# [示例/Example]\nsku_id=\"669ddd44e05f3700011067ed\"\npage=0","operationId":"get_product_reviews_api_v1_xiaohongshu_app_v2_get_product_reviews_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sku_id","in":"query","required":true,"schema":{"type":"string","description":"商品SKU ID/Product SKU ID","title":"Sku Id"},"description":"商品SKU ID/Product SKU ID","example":"669ddd44e05f3700011067ed"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码，从0开始/Page number, start from 0","default":0,"title":"Page"},"description":"页码，从0开始/Page number, start from 0","example":0},{"name":"sort_strategy_type","in":"query","required":false,"schema":{"type":"integer","description":"排序策略：0=综合排序, 1=最新排序/Sort strategy: 0=general, 1=latest","default":0,"title":"Sort Strategy Type"},"description":"排序策略：0=综合排序, 1=最新排序/Sort strategy: 0=general, 1=latest","example":0},{"name":"share_pics_only","in":"query","required":false,"schema":{"type":"integer","description":"仅看有图评论：0=否, 1=是/Show reviews with images only: 0=no, 1=yes","default":0,"title":"Share Pics Only"},"description":"仅看有图评论：0=否, 1=是/Show reviews with images only: 0=no, 1=yes","example":0},{"name":"from_page","in":"query","required":false,"schema":{"type":"string","description":"来源页面/From page","default":"score_page","title":"From Page"},"description":"来源页面/From page","example":"score_page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_product_recommendations":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取商品推荐列表/Get product recommendations","description":"# [中文]\n### 用途:\n- 根据商品 SKU ID 获取相关推荐商品列表，使用游标分页\n### 参数:\n- sku_id: 商品 SKU ID（必需），如 \"669ddd44e05f3700011067ed\"\n- cursor_score: 分页游标，首次请求留空，翻页时传入上一次响应中返回的 cursor_score 值\n- region: 地区，默认 \"US\"\n### 返回:\n- 推荐商品列表数据\n### 翻页说明:\n- 首次请求：cursor_score 留空\n- 翻页请求：传入上一次响应中返回的 cursor_score 值\n\n# [English]\n### Purpose:\n- Get recommended products list by SKU ID, using cursor pagination\n### Parameters:\n- sku_id: Product SKU ID (required), e.g. \"669ddd44e05f3700011067ed\"\n- cursor_score: Pagination cursor, leave empty for first request, pass cursor_score value from previous response for next page\n- region: Region, default \"US\"\n### Return:\n- Recommended products list data\n### Pagination Guide:\n- First request: leave cursor_score empty\n- Next page: pass cursor_score value from previous response\n\n# [示例/Example]\nsku_id=\"669ddd44e05f3700011067ed\"","operationId":"get_product_recommendations_api_v1_xiaohongshu_app_v2_get_product_recommendations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sku_id","in":"query","required":true,"schema":{"type":"string","description":"商品SKU ID/Product SKU ID","title":"Sku Id"},"description":"商品SKU ID/Product SKU ID","example":"669ddd44e05f3700011067ed"},{"name":"cursor_score","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","default":"","title":"Cursor Score"},"description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","example":""},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区/Region","default":"US","title":"Region"},"description":"地区/Region","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_topic_info":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取话题详情/Get topic info","description":"# [中文]\n### 用途:\n- 获取指定话题的详细信息，包括话题名称、浏览量、讨论数、分享信息等\n### 参数:\n- page_id: 话题页面ID（必需），如 \"5c1cc866febed9000184b7c1\"\n- source: 来源，默认 \"normal\"\n- note_id: 来源笔记ID，从笔记跳转到话题时传入（可选）\n### 返回:\n- 话题详情数据，包含 page_info（名称/浏览量/讨论数）、tabs、share_info 等\n\n# [English]\n### Purpose:\n- Get topic detail info, including topic name, view count, discussion count, share info, etc.\n### Parameters:\n- page_id: Topic page ID (required), e.g. \"5c1cc866febed9000184b7c1\"\n- source: Source, default \"normal\"\n- note_id: Source note ID, pass when jumping from note to topic (optional)\n### Return:\n- Topic detail data, including page_info (name/view count/discussion count), tabs, share_info, etc.\n\n# [示例/Example]\npage_id=\"5c1cc866febed9000184b7c1\"","operationId":"get_topic_info_api_v1_xiaohongshu_app_v2_get_topic_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page_id","in":"query","required":true,"schema":{"type":"string","description":"话题页面ID/Topic page ID","title":"Page Id"},"description":"话题页面ID/Topic page ID","example":"5c1cc866febed9000184b7c1"},{"name":"source","in":"query","required":false,"schema":{"type":"string","description":"来源/Source","default":"normal","title":"Source"},"description":"来源/Source","example":"normal"},{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"来源笔记ID，从笔记跳转到话题时传入/Source note ID, pass when jumping from note to topic","default":"","title":"Note Id"},"description":"来源笔记ID，从笔记跳转到话题时传入/Source note ID, pass when jumping from note to topic","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_topic_feed":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取话题笔记列表/Get topic feed","description":"# [中文]\n### 用途:\n- 获取指定话题下的笔记列表，支持按最热或最新排序，使用游标分页\n### 参数:\n- page_id: 话题页面ID（必需），如 \"5c1cc866febed9000184b7c1\"\n- sort: 排序方式\n    - \"trend\": 最热（默认）\n    - \"time\": 最新\n- cursor_score: 分页游标分数，翻页时传入上一页最后一个 item 的 cursor_score\n- last_note_id: 上一页最后一条笔记ID，翻页时传入\n- last_note_ct: 上一页最后一条笔记创建时间，翻页时传入\n- session_id: 会话ID，翻页时保持一致\n- first_load_time: 首次加载时间戳，翻页时保持一致\n- source: 来源，默认 \"normal\"\n### 返回:\n- 话题笔记列表数据\n### 翻页说明:\n- 首次请求：只传 page_id 和 sort，其余留空\n- 翻页请求：取上一次响应最后一个 item 的字段:\n    - cursor_score ← items[-1].cursor_score\n    - last_note_id ← items[-1].id\n    - last_note_ct ← items[-1].create_time\n- 建议同时回传 session_id 和 first_load_time 保持会话一致\n\n# [English]\n### Purpose:\n- Get notes list under a specified topic, supports sorting by trending or latest, using cursor pagination\n### Parameters:\n- page_id: Topic page ID (required), e.g. \"5c1cc866febed9000184b7c1\"\n- sort: Sort type\n    - \"trend\": Trending (default)\n    - \"time\": Latest\n- cursor_score: Pagination cursor score, pass last item's cursor_score from previous response\n- last_note_id: Last note ID from previous page\n- last_note_ct: Last note create time from previous page\n- session_id: Session ID, keep consistent for pagination\n- first_load_time: First load timestamp, keep consistent for pagination\n- source: Source, default \"normal\"\n### Return:\n- Topic notes list data\n### Pagination Guide:\n- First request: only pass page_id and sort, leave others empty\n- Next page: pass fields from last item of previous response:\n    - cursor_score ← items[-1].cursor_score\n    - last_note_id ← items[-1].id\n    - last_note_ct ← items[-1].create_time\n- Recommended to also pass session_id and first_load_time for session consistency\n\n# [示例/Example]\npage_id=\"5c1cc866febed9000184b7c1\"\nsort=\"trend\"","operationId":"get_topic_feed_api_v1_xiaohongshu_app_v2_get_topic_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page_id","in":"query","required":true,"schema":{"type":"string","description":"话题页面ID/Topic page ID","title":"Page Id"},"description":"话题页面ID/Topic page ID","example":"5c1cc866febed9000184b7c1"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort: trend(最热), time(最新)","default":"trend","title":"Sort"},"description":"排序方式/Sort: trend(最热), time(最新)","example":"trend"},{"name":"cursor_score","in":"query","required":false,"schema":{"type":"string","description":"分页游标分数，翻页时传入/Pagination cursor score for next page","default":"","title":"Cursor Score"},"description":"分页游标分数，翻页时传入/Pagination cursor score for next page","example":""},{"name":"last_note_id","in":"query","required":false,"schema":{"type":"string","description":"上一页最后一条笔记ID，翻页时传入/Last note ID from previous page","default":"","title":"Last Note Id"},"description":"上一页最后一条笔记ID，翻页时传入/Last note ID from previous page","example":""},{"name":"last_note_ct","in":"query","required":false,"schema":{"type":"string","description":"上一页最后一条笔记创建时间，翻页时传入/Last note create time from previous page","default":"","title":"Last Note Ct"},"description":"上一页最后一条笔记创建时间，翻页时传入/Last note create time from previous page","example":""},{"name":"session_id","in":"query","required":false,"schema":{"type":"string","description":"会话ID，翻页时保持一致/Session ID, keep consistent for pagination","default":"","title":"Session Id"},"description":"会话ID，翻页时保持一致/Session ID, keep consistent for pagination","example":""},{"name":"first_load_time","in":"query","required":false,"schema":{"type":"string","description":"首次加载时间戳，翻页时保持一致/First load timestamp, keep consistent for pagination","default":"","title":"First Load Time"},"description":"首次加载时间戳，翻页时保持一致/First load timestamp, keep consistent for pagination","example":""},{"name":"source","in":"query","required":false,"schema":{"type":"string","description":"来源/Source","default":"normal","title":"Source"},"description":"来源/Source","example":"normal"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_creator_inspiration_feed":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取创作者推荐灵感列表/Get creator inspiration feed","description":"# [中文]\n### 用途:\n- 获取创作者中心的推荐创作灵感流，使用游标分页\n### 参数:\n- cursor: 分页游标，首次请求留空，翻页时传入上一次响应中返回的 cursor 值（如 \"r_1\", \"r_2\"...）\n- tab: 标签类型，默认 0\n- source: 来源，默认 \"creator_center\"\n### 返回:\n- 推荐灵感列表数据\n### 翻页说明:\n- 首次请求：cursor 留空\n- 翻页请求：传入上一次响应中返回的 cursor 值\n\n# [English]\n### Purpose:\n- Get creator center recommended inspiration feed, using cursor pagination\n### Parameters:\n- cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response (e.g. \"r_1\", \"r_2\"...)\n- tab: Tab type, default 0\n- source: Source, default \"creator_center\"\n### Return:\n- Recommended inspiration feed data\n### Pagination Guide:\n- First request: leave cursor empty\n- Next page: pass cursor value from previous response\n\n# [示例/Example]\ncursor=\"\"","operationId":"get_creator_inspiration_feed_api_v1_xiaohongshu_app_v2_get_creator_inspiration_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","default":"","title":"Cursor"},"description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","example":""},{"name":"tab","in":"query","required":false,"schema":{"type":"integer","description":"标签类型/Tab type","default":0,"title":"Tab"},"description":"标签类型/Tab type","example":0},{"name":"source","in":"query","required":false,"schema":{"type":"string","description":"来源/Source","default":"creator_center","title":"Source"},"description":"来源/Source","example":"creator_center"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app_v2/get_creator_hot_inspiration_feed":{"get":{"tags":["Xiaohongshu-App-V2-API"],"summary":"获取创作者热点灵感列表/Get creator hot inspiration feed","description":"# [中文]\n### 用途:\n- 获取创作者中心的热点创作灵感流，使用游标分页\n### 参数:\n- cursor: 分页游标，首次请求留空，翻页时传入上一次响应中返回的 cursor 值（如 \"1\", \"2\"...）\n### 返回:\n- 热点灵感列表数据\n### 翻页说明:\n- 首次请求：cursor 留空\n- 翻页请求：传入上一次响应中返回的 cursor 值\n\n# [English]\n### Purpose:\n- Get creator center hot inspiration feed, using cursor pagination\n### Parameters:\n- cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response (e.g. \"1\", \"2\"...)\n### Return:\n- Hot inspiration feed data\n### Pagination Guide:\n- First request: leave cursor empty\n- Next page: pass cursor value from previous response\n\n# [示例/Example]\ncursor=\"\"","operationId":"get_creator_hot_inspiration_feed_api_v1_xiaohongshu_app_v2_get_creator_hot_inspiration_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","default":"","title":"Cursor"},"description":"分页游标，首次请求留空/Pagination cursor, leave empty for first request","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/get_note_info":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"获取笔记信息 V1/Get note info V1","description":"# [中文]\n### 用途:\n- 获取笔记信息 V1\n### 接口优先级:\n- 小红书接口推荐优先级: `App V2` > `App（本接口）` > `Web V2` > `Web`\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n### 返回:\n- 笔记详情数据，包含以下主要字段：\n    - note_id: 笔记ID\n    - title: 笔记标题\n    - desc: 笔记内容描述\n    - type: 笔记类型（normal=图文笔记，video=视频笔记）\n    - user: 作者信息对象\n        - user_id: 用户ID\n        - nickname: 用户昵称\n        - avatar: 用户头像URL\n    - image_list: 图片列表（图文笔记）\n    - video_info: 视频信息（视频笔记）\n    - interact_info: 互动数据\n        - liked_count: 点赞数\n        - collected_count: 收藏数\n        - comment_count: 评论数\n        - share_count: 分享数\n    - tag_list: 话题标签列表\n    - time: 发布时间戳\n    - ip_location: IP属地\n\n# [English]\n### Purpose:\n- Get note info V1\n### API Priority:\n- Xiaohongshu API priority: `App V2` > `App (this)` > `Web V2` > `Web`\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n### Return:\n- Note detail data with main fields:\n    - note_id: Note ID\n    - title: Note title\n    - desc: Note content description\n    - type: Note type (normal=image note, video=video note)\n    - user: Author info object\n        - user_id: User ID\n        - nickname: User nickname\n        - avatar: User avatar URL\n    - image_list: Image list (for image notes)\n    - video_info: Video info (for video notes)\n    - interact_info: Interaction data\n        - liked_count: Like count\n        - collected_count: Collect count\n        - comment_count: Comment count\n        - share_count: Share count\n    - tag_list: Topic tag list\n    - time: Publish timestamp\n    - ip_location: IP location\n\n# [示例/Example]\nnote_id=\"665f95200000000006005624\"","operationId":"get_note_info_v1_api_v1_xiaohongshu_app_get_note_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"665f95200000000006005624"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"https://xhslink.com/a/EZ4M9TwMA6c3"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/get_note_info_v2":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"获取笔记信息 V2 (蒲公英商家后台)/Get note info V2 (Pugongying Business Backend)","description":"# [中文]\n### 用途:\n- 获取笔记信息 V2\n- 除赞、评、藏数据之外此接口能获取到笔记的曝光量（impNum）、阅读量（readNum）、关注量（followCnt）。\n- 但是不是每一篇都有，如果是没有被小红书后台收录的笔记，赞评藏数据返回为0，但是笔记内容是完整的。\n- 通过作者userId，可以去作品列表接口拿到赞、评、藏数据\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n### 返回:\n- 笔记详情数据，包含以下主要字段：\n    - note_id: 笔记ID\n    - title: 笔记标题\n    - desc: 笔记内容描述\n    - type: 笔记类型（normal=图文笔记，video=视频笔记）\n    - user: 作者信息对象\n        - user_id: 用户ID\n        - nickname: 用户昵称\n        - avatar: 用户头像URL\n    - image_list: 图片列表（图文笔记）\n    - video_info: 视频信息（视频笔记）\n    - interact_info: 互动数据\n        - liked_count: 点赞数\n        - collected_count: 收藏数\n        - comment_count: 评论数\n        - share_count: 分享数\n    - tag_list: 话题标签列表\n    - time: 发布时间戳\n    - ip_location: IP属地\n\n# [English]\n### Purpose:\n- Get note info V2\n- This interface can get note exposure (impNum), read count (readNum), and follow count (followCnt) in addition to like, comment, and collect data.\n- However, not every note has this data. If the note is not indexed by Xiaohongshu backend, like, comment, and collect data will return 0, but the note content is complete.\n- You can get like, comment, and collect data from the note list interface using the author's userId.\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n### Return:\n- Note detail data with main fields:\n    - note_id: Note ID\n    - title: Note title\n    - desc: Note content description\n    - type: Note type (normal=image note, video=video note)\n    - user: Author info object\n        - user_id: User ID\n        - nickname: User nickname\n        - avatar: User avatar URL\n    - image_list: Image list (for image notes)\n    - video_info: Video info (for video notes)\n    - interact_info: Interaction data\n        - liked_count: Like count\n        - collected_count: Collect count\n        - comment_count: Comment count\n        - share_count: Share count\n    - tag_list: Topic tag list\n    - time: Publish timestamp\n    - ip_location: IP location\n\n# [示例/Example]\nnote_id=\"665f95200000000006005624\"","operationId":"get_note_info_v2_api_v1_xiaohongshu_app_get_note_info_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"665f95200000000006005624"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"https://xhslink.com/a/EZ4M9TwMA6c3"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/get_note_comments":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"获取笔记评论/Get note comments","description":"# [中文]\n### 用途:\n- 获取笔记的评论列表\n### 参数:\n- note_id: 笔记ID（必需）\n- start: 翻页游标，从上一次请求的响应中获取，支持两种格式：\n    1. 简单格式: \"682b0133000000001c03618d\"\n    2. JSON格式: {\"cursor\":\"682b0133000000001c03618d\",\"index\":2,\"pageArea\":\"ALL\"}\n- sort_strategy: 排序策略\n    - 1: 默认排序（默认值）\n    - 2: 按最新评论排序\n### 返回:\n- 评论数据对象，包含：\n    - comments: 评论列表数组，每个评论包含：\n        - id: 评论ID\n        - content: 评论内容\n        - create_time: 创建时间戳\n        - user_info: 评论者信息\n            - user_id: 用户ID\n            - nickname: 昵称\n            - image: 头像URL\n        - interact_info: 互动数据\n            - liked_count: 点赞数\n        - sub_comment_count: 子评论数量\n        - sub_comment_cursor: 子评论翻页游标（如有子评论）\n    - cursor: 翻页游标，用于获取下一页\n    - has_more: 是否有更多数据（布尔值）\n    - total: 总评论数\n\n### 翻页说明:\n- 首次请求不传start参数\n- 获取下一页时，将上一次返回的cursor作为start参数传入\n- 当has_more为false时，表示没有更多数据\n\n# [English]\n### Purpose:\n- Get note comments list\n### Parameters:\n- note_id: Note ID (required)\n- start: Pagination cursor from previous response, supports two formats:\n    1. Simple format: \"682b0133000000001c03618d\"\n    2. JSON format: {\"cursor\":\"682b0133000000001c03618d\",\"index\":2,\"pageArea\":\"ALL\"}\n- sort_strategy: Sort strategy\n    - 1: Default sort (default)\n    - 2: Sort by latest comments\n### Return:\n- Comments data object containing:\n    - comments: Comment list array, each comment includes:\n        - id: Comment ID\n        - content: Comment content\n        - create_time: Creation timestamp\n        - user_info: Commenter info\n            - user_id: User ID\n            - nickname: Nickname\n            - image: Avatar URL\n        - interact_info: Interaction data\n            - liked_count: Like count\n        - sub_comment_count: Sub-comment count\n        - sub_comment_cursor: Sub-comment pagination cursor (if has sub-comments)\n    - cursor: Pagination cursor for next page\n    - has_more: Whether has more data (boolean)\n    - total: Total comment count\n\n### Pagination Guide:\n- Don't pass start parameter for first request\n- For next page, pass cursor from previous response as start parameter\n- When has_more is false, no more data available\n\n# [示例/Example]\nnote_id=\"677d1909000000002002a892\"\nsort_strategy=1","operationId":"get_note_comments_api_v1_xiaohongshu_app_get_note_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"677d1909000000002002a892"},{"name":"start","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Pagination cursor","title":"Start"},"description":"翻页游标/Pagination cursor","example":"682b0133000000001c03618d"},{"name":"sort_strategy","in":"query","required":false,"schema":{"type":"integer","description":"排序策略：1-默认排序，2-最新评论/Sort strategy: 1-default, 2-latest","default":1,"title":"Sort Strategy"},"description":"排序策略：1-默认排序，2-最新评论/Sort strategy: 1-default, 2-latest","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/get_sub_comments":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"获取子评论/Get sub comments","description":"# [中文]\n### 用途:\n- 获取评论的子评论（回复）列表\n### 参数:\n- note_id: 笔记ID（必需）\n- comment_id: 一级评论ID，要查看哪条评论的子评论（必需）\n- start: 翻页游标，从上一次请求的响应中获取，从评论列表的最后一条子评论ID获取：\n    格式如下: \"6806642d000000001f01991b\"\n### 返回:\n- 子评论列表数组，每个子评论包含：\n    - id: 子评论ID\n    - content: 评论内容\n    - create_time: 创建时间戳\n    - user_info: 评论者信息\n        - user_id: 用户ID\n        - nickname: 昵称\n        - image: 头像URL\n    - target_comment: 被回复的评论信息（如果是回复其他子评论）\n        - id: 被回复评论ID\n        - user_info: 被回复者信息\n            - nickname: 被回复者昵称\n\n### 翻页说明:\n- 首次请求不传start参数\n- 获取更多时，将上一次请求返回的最后一条子评论ID作为start参数\n\n# [English]\n### Purpose:\n- Get sub comments (replies) list\n### Parameters:\n- note_id: Note ID (required)\n- comment_id: Parent comment ID to get sub comments (required)\n- start: Pagination cursor from previous response, obtained from the last sub-comment ID in the comment list:\n    Format: \"6806642d000000001f01991b\"\n### Return:\n- Sub comments array list, each sub-comment includes:\n    - id: Sub-comment ID\n    - content: Comment content\n    - create_time: Creation timestamp\n    - user_info: Commenter info\n        - user_id: User ID\n        - nickname: Nickname\n        - image: Avatar URL\n    - target_comment: Replied comment info (if replying to other sub-comment)\n        - id: Replied comment ID\n        - user_info: Replied user info\n            - nickname: Replied user nickname\n\n### Pagination Guide:\n- Don't pass start parameter for first request\n- For more data, pass last sub-comment ID from previous response as start parameter\n\n# [示例/Example]\nnote_id=\"677d1909000000002002a892\"\ncomment_id=\"677f67e400000000220013f3\"","operationId":"get_sub_comments_api_v1_xiaohongshu_app_get_sub_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"677d1909000000002002a892"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"一级评论ID/Parent comment ID","title":"Comment Id"},"description":"一级评论ID/Parent comment ID","example":"677f67e400000000220013f3"},{"name":"start","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Pagination cursor","title":"Start"},"description":"翻页游标/Pagination cursor","example":"6806642d000000001f01991b"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/get_notes_by_topic":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"[已弃用/Deprecated] 根据话题标签获取作品/Get notes by topic","description":"# [中文]\n## ⚠️ 此接口已弃用，不再维护，可能无法正常使用。\n### 用途:\n- 根据话题标签获取相关笔记\n### 参数:\n- page_id: 话题标签ID（必需）\n- first_load_time: 首次请求的时间戳，毫秒级时间戳（必需）\n    - 例子: 1698647850000\n    - Python获取当前时间戳: `int(time.time() * 1000)`\n- sort: 排序方式\n    - \"hot\": 综合排序（默认）\n    - \"time\": 最新发布\n    - \"trend\": 最热门\n- session_id: 会话ID，首次不传，由服务端生成，翻页时传入\n- last_note_ct: 最后一条笔记的create_time字段，首次不传，翻页时传入\n- last_note_id: 最后一条笔记的ID，首次不传，翻页时传入\n- cursor_score: 最后一条笔记的cursor_score字段，首次不传，翻页时传入\n### 返回:\n- 话题笔记数据，包含：\n    - notes: 笔记列表数组，每个元素包含：\n        - id: 元素ID\n        - model_type: 模型类型（通常为\"note\"）\n        - note: 笔记详情对象\n            - note_id: 笔记ID\n            - title: 标题\n            - desc: 描述\n            - type: 类型（normal/video）\n            - user: 作者信息\n            - interact_info: 互动数据\n            - cover: 封面图\n            - create_time: 创建时间戳\n            - cursor_score: 游标分数（用于翻页）\n    - session_id: 会话ID（翻页必需）\n    - has_more: 是否有更多数据\n\n### 翻页说明:\n- 首次请求：只传page_id和first_load_time\n- 翻页请求：需要传入\n    1. 上一次返回的session_id\n    2. 最后一条笔记的last_note_ct（create_time）\n    3. 最后一条笔记的last_note_id（id）\n    4. 最后一条笔记的cursor_score\n\n# [English]\n## ⚠️ This endpoint is deprecated, no longer maintained, and may not work properly.\n### Purpose:\n- Get notes by topic tag\n### Parameters:\n- page_id: Topic tag ID (required)\n- first_load_time: First load timestamp in milliseconds (required)\n    - Example: 1698647850000\n    - Get current timestamp in Python: `int(time.time() * 1000)`\n- sort: Sort method\n    - \"hot\": Comprehensive (default)\n    - \"time\": Latest published\n    - \"trend\": Trending\n- session_id: Session ID, not required for first request, use returned value for pagination\n- last_note_ct: Last note create_time field for pagination\n- last_note_id: Last note ID for pagination\n- cursor_score: Last note cursor_score field for pagination\n### Return:\n- Topic notes data containing:\n    - notes: Notes list array, each element includes:\n        - id: Element ID\n        - model_type: Model type (usually \"note\")\n        - note: Note detail object\n            - note_id: Note ID\n            - title: Title\n            - desc: Description\n            - type: Type (normal/video)\n            - user: Author info\n            - interact_info: Interaction data\n            - cover: Cover image\n            - create_time: Creation timestamp\n            - cursor_score: Cursor score (for pagination)\n    - session_id: Session ID (required for pagination)\n    - has_more: Whether has more data\n\n### Pagination Guide:\n- First request: Only pass page_id and first_load_time\n- Next requests: Need to pass\n    1. session_id from previous response\n    2. last_note_ct (create_time of last note)\n    3. last_note_id (id of last note)\n    4. cursor_score of last note\n\n# [示例/Example]\npage_id=\"5c014b045b29cb0001ead530\"\nfirst_load_time=\"1698647850000\"\nsort=\"hot\"","operationId":"get_notes_by_topic_api_v1_xiaohongshu_app_get_notes_by_topic_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"page_id","in":"query","required":true,"schema":{"type":"string","description":"话题标签ID/Topic tag ID","title":"Page Id"},"description":"话题标签ID/Topic tag ID","example":"5c014b045b29cb0001ead530"},{"name":"first_load_time","in":"query","required":true,"schema":{"type":"string","description":"首次请求时间戳（毫秒）/First load timestamp (ms)","title":"First Load Time"},"description":"首次请求时间戳（毫秒）/First load timestamp (ms)","example":"1698647850000"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式：hot-综合，time-最新，trend-最热/Sort: hot-comprehensive, time-latest, trend-trending","default":"hot","title":"Sort"},"description":"排序方式：hot-综合，time-最新，trend-最热/Sort: hot-comprehensive, time-latest, trend-trending","example":"hot"},{"name":"session_id","in":"query","required":false,"schema":{"type":"string","description":"会话ID/Session ID","title":"Session Id"},"description":"会话ID/Session ID","example":"989615e2-ce54-414a-9c7a-6c1e5e79c5f7"},{"name":"last_note_ct","in":"query","required":false,"schema":{"type":"string","description":"最后一条笔记创建时间/Last note create time","title":"Last Note Ct"},"description":"最后一条笔记创建时间/Last note create time","example":"1698647850000"},{"name":"last_note_id","in":"query","required":false,"schema":{"type":"string","description":"最后一条笔记ID/Last note ID","title":"Last Note Id"},"description":"最后一条笔记ID/Last note ID","example":"653f4f2a0000000025017109"},{"name":"cursor_score","in":"query","required":false,"schema":{"type":"string","description":"游标分数/Cursor score","title":"Cursor Score"},"description":"游标分数/Cursor score","example":"rNqgDUXZhHqdL4z4kKah5Lw6P_OSU9_fgubmTsiop_s"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/search_notes":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"搜索笔记/Search notes","description":"# [中文]\n### 用途:\n- 搜索小红书笔记\n### 参数:\n- keyword: 要搜索的关键词（必需）\n- page: 第几页，从1开始（必需）\n- search_id: 搜索ID，第一次请求可不传，服务端会生成searchId，翻页时需要携带服务端返回的searchId\n- session_id: 会话ID，第一次请求可不传，服务端会生成sessionId，翻页时携带服务端返回的sessionId\n- sort_type: 排序规则\n    - \"general\": 综合排序（默认）\n    - \"time_descending\": 最新发布\n    - \"popularity_descending\": 最多点赞\n    - \"comment_descending\": 最多评论\n    - \"collect_descending\": 最多收藏\n- filter_note_type: 筛选笔记类型\n    - \"不限\": 所有类型（默认）\n    - \"视频笔记\": 仅视频\n    - \"普通笔记\": 仅图文\n- filter_note_time: 筛选笔记发布时间\n    - \"不限\": 所有时间（默认）\n    - \"一天内\": 24小时内\n    - \"一周内\": 7天内\n    - \"半年内\": 6个月内\n### 返回:\n- 搜索结果数据，包含：\n    - items: 搜索结果列表，每个元素包含：\n        - id: 元素ID\n        - model_type: 模型类型（通常为\"note\"）\n        - note: 笔记详情\n            - note_id: 笔记ID\n            - type: 类型（normal=图文，video=视频）\n            - display_title: 标题（关键词会高亮）\n            - desc: 内容描述（搜索接口无法返回完整的 desc，仅部分内容，请使用笔记详情接口获取完整内容）\n            - user: 作者信息\n            - interact_info: 互动数据\n                - liked_count: 点赞数\n            - cover: 封面图信息\n    - searchId: 搜索ID（翻页必需，不同关键词不要复用）\n    - sessionId: 会话ID（翻页必需）\n    - has_more: 是否有更多数据\n    - total_count: 搜索结果总数\n\n### 翻页说明:\n- 首次搜索：只传keyword和page=1\n- 翻页搜索：传入相同keyword，递增page，并携带首次返回的searchId和sessionId\n- 注意：更换关键词时不要复用之前的searchId\n\n# [English]\n### Purpose:\n- Search Xiaohongshu notes\n### Parameters:\n- keyword: Search keyword (required)\n- page: Page number, start from 1 (required)\n- search_id: Search ID, optional for first request, required for pagination\n- session_id: Session ID, optional for first request, required for pagination\n- sort_type: Sort method\n    - \"general\": Comprehensive (default)\n    - \"time_descending\": Latest published\n    - \"popularity_descending\": Most liked\n    - \"comment_descending\": Most commented\n    - \"collect_descending\": Most collected\n- filter_note_type: Note type filter\n    - \"不限\": All types (default)\n    - \"视频笔记\": Video only\n    - \"普通笔记\": Image & text only\n- filter_note_time: Time filter\n    - \"不限\": All time (default)\n    - \"一天内\": Within 24 hours\n    - \"一周内\": Within 7 days\n    - \"半年内\": Within 6 months\n### Return:\n- Search results data containing:\n    - items: Search results list, each element includes:\n        - id: Element ID\n        - model_type: Model type (usually \"note\")\n        - note: Note details\n            - note_id: Note ID\n            - type: Type (normal=image, video=video)\n            - display_title: Title (keywords highlighted)\n            - desc: Content description (incomplete in search results, use note detail API for full content)\n            - user: Author info\n            - interact_info: Interaction data\n                - liked_count: Like count\n            - cover: Cover image info\n    - searchId: Search ID (required for pagination, don't reuse for different keywords)\n    - sessionId: Session ID (required for pagination)\n    - has_more: Whether has more data\n    - total_count: Total search results count\n\n### Pagination Guide:\n- First search: Only pass keyword and page=1\n- Next pages: Pass same keyword, increment page, include searchId and sessionId from first response\n- Note: Don't reuse searchId when changing keywords\n\n# [示例/Example]\nkeyword=\"猫粮\"\npage=1\nsort_type=\"general\"","operationId":"search_notes_api_v1_xiaohongshu_app_search_notes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"猫粮"},{"name":"page","in":"query","required":true,"schema":{"type":"integer","description":"页码（从1开始）/Page number (start from 1)","title":"Page"},"description":"页码（从1开始）/Page number (start from 1)","example":1},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索ID，翻页时使用/Search ID for pagination","title":"Search Id"},"description":"搜索ID，翻页时使用/Search ID for pagination","example":"2egvdsiowvfm9thbt260w"},{"name":"session_id","in":"query","required":false,"schema":{"type":"string","description":"会话ID，翻页时使用/Session ID for pagination","title":"Session Id"},"description":"会话ID，翻页时使用/Session ID for pagination","example":"2egvdt4sl2b7rnfg8zk00"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort type","default":"general","title":"Sort Type"},"description":"排序方式/Sort type","example":"general"},{"name":"filter_note_type","in":"query","required":false,"schema":{"type":"string","description":"笔记类型筛选：不限、视频笔记、普通笔记/Note type filter","default":"不限","title":"Filter Note Type"},"description":"笔记类型筛选：不限、视频笔记、普通笔记/Note type filter","example":"不限"},{"name":"filter_note_time","in":"query","required":false,"schema":{"type":"string","description":"发布时间筛选：不限、一天内、一周内、半年内/Time filter","default":"不限","title":"Filter Note Time"},"description":"发布时间筛选：不限、一天内、一周内、半年内/Time filter","example":"不限"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/get_user_info":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"获取用户信息/Get user info","description":"# [中文]\n### 用途:\n- 获取用户详情信息\n### 参数:\n- user_id: 用户ID（必需）\n### 返回:\n- 用户详情数据，包含：\n    - user_id: 用户ID\n    - nickname: 昵称\n    - desc: 个人简介\n    - gender: 性别（0=女，1=男，2=未知）\n    - images: 头像URL\n    - imageb: 背景图URL\n    - red_official_verify_type: 官方认证类型（0=无，1=个人，2=机构）\n    - red_official_verify_show: 是否显示认证标识\n    - level: 等级信息\n        - image: 等级图标URL\n        - name: 等级名称\n    - follows: 关注数\n    - fans: 粉丝数\n    - interaction: 获赞与收藏总数\n    - notes: 笔记数\n    - boards: 专辑数\n    - location: 所在地\n    - collected: 收藏数\n    - liked: 点赞数\n\n# [English]\n### Purpose:\n- Get user detail info\n### Parameters:\n- user_id: User ID (required)\n### Return:\n- User detail data including:\n    - user_id: User ID\n    - nickname: Nickname\n    - desc: Personal bio\n    - gender: Gender (0=female, 1=male, 2=unknown)\n    - images: Avatar URL\n    - imageb: Background image URL\n    - red_official_verify_type: Official verify type (0=none, 1=personal, 2=organization)\n    - red_official_verify_show: Whether show verify badge\n    - level: Level info\n        - image: Level icon URL\n        - name: Level name\n    - follows: Following count\n    - fans: Fans count\n    - interaction: Total likes & collects\n    - notes: Notes count\n    - boards: Album count\n    - location: Location\n    - collected: Collect count\n    - liked: Like count\n\n# [示例/Example]\nuser_id=\"5c2f338a000000000701e1c6\"","operationId":"get_user_info_api_v1_xiaohongshu_app_get_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"5c2f338a000000000701e1c6"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/get_user_notes":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"获取用户作品列表/Get user notes","description":"# [中文]\n### 用途:\n- 获取用户发布的笔记列表\n### 参数:\n- user_id: 用户ID（必需）\n- cursor: 翻页索引，上一次请求返回的cursor字段，不传默认请求第一页\n- cursor取值方式为notes列表的最后一条笔记的note_id\n### 返回:\n- 用户笔记列表数据，包含：\n    - notes: 笔记数组，每个笔记包含：\n        - note_id: 笔记ID\n        - type: 类型（normal=图文，video=视频）\n        - display_title: 标题\n        - desc: 描述\n        - liked_count: 点赞数\n        - cover: 封面图信息\n            - url: 图片URL\n            - width: 宽度\n            - height: 高度\n        - user: 作者信息（通常与查询用户相同）\n    - cursor: 翻页游标\n    - has_more: 是否有更多数据\n\n### 翻页说明:\n- 首次请求：只传user_id\n- 翻页请求：传入上一次返回的cursor\n- 当has_more为false时，表示没有更多笔记\n\n# [English]\n### Purpose:\n- Get user's published notes list\n### Parameters:\n- user_id: User ID (required)\n- cursor: Pagination cursor from previous response, omit for first page\n- Cursor value is the note_id of the last note in the notes list\n### Return:\n- User notes data including:\n    - notes: Notes array, each note contains:\n        - note_id: Note ID\n        - type: Type (normal=image, video=video)\n        - display_title: Title\n        - desc: Description\n        - liked_count: Like count\n        - cover: Cover image info\n            - url: Image URL\n            - width: Width\n            - height: Height\n        - user: Author info (usually same as queried user)\n    - cursor: Pagination cursor\n    - has_more: Whether has more data\n\n### Pagination Guide:\n- First request: Only pass user_id\n- Next pages: Pass cursor from previous response\n- When has_more is false, no more notes available\n\n# [示例/Example]\nuser_id=\"5c57e6a4000000001802a013\"\ncursor=\"67ee399f000000001c02f36f\"","operationId":"get_user_notes_api_v1_xiaohongshu_app_get_user_notes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"5c57e6a4000000001802a013"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Pagination cursor","title":"Cursor"},"description":"翻页游标/Pagination cursor","example":"67ee399f000000001c02f36f"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/extract_share_info":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"提取分享链接信息/Extract share link info","description":"# [中文]\n### 用途:\n- 从分享链接中提取笔记ID和xsec_token\n### 参数:\n- share_link: 小红书分享链接，支持短链接和长链接\n### 返回:\n- 提取的信息对象，包含：\n    - note_id: 笔记ID\n    - xsec_token: 安全令牌（如果URL中包含）\n\n### 使用说明:\n- 支持短链接格式：https://xhslink.com/a/xxxxx\n- 支持长链接格式：\n    - https://www.xiaohongshu.com/discovery/item/xxxxx\n    - https://www.xiaohongshu.com/explore/xxxxx\n- 短链接会自动重定向获取真实链接\n- 提取的note_id可用于get_note_info接口\n\n# [English]\n### Purpose:\n- Extract note ID and xsec_token from share link\n### Parameters:\n- share_link: Xiaohongshu share link, support short and long links\n### Return:\n- Extracted info object containing:\n    - note_id: Note ID\n    - xsec_token: Security token (if exists in URL)\n\n### Usage Guide:\n- Supports short link format: https://xhslink.com/a/xxxxx\n- Supports long link formats:\n    - https://www.xiaohongshu.com/discovery/item/xxxxx\n    - https://www.xiaohongshu.com/explore/xxxxx\n- Short links will be auto-redirected to get real link\n- Extracted note_id can be used in get_note_info endpoint\n\n# [示例/Example]\nshare_link=\"https://xhslink.com/a/EZ4M9TwMA6c3\"","operationId":"extract_share_info_api_v1_xiaohongshu_app_extract_share_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_link","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Link"},"description":"分享链接/Share link","example":"https://xhslink.com/a/EZ4M9TwMA6c3"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/get_user_id_and_xsec_token":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"从分享链接中提取用户ID和xsec_token/Extract user ID and xsec_token from share link","description":"# [中文]\n### 用途:\n- 从用户分享链接中提取用户ID和xsec_token\n### 参数:\n- share_link: 小红书用户分享链接，支持短链接和长链接\n### 返回:\n- 提取的信息对象，包含：\n    - user_id: 用户ID\n    - xsec_token: 安全令牌（如果URL中包含）\n\n### 使用说明:\n- 支持短链接格式：https://xhslink.com/m/xxxxx\n- 支持长链接格式：https://www.xiaohongshu.com/user/profile/xxxxx\n- 提取的user_id可用于get_user_info接口\n\n# [English]\n### Purpose:\n- Extract user ID and xsec_token from user share link\n### Parameters:\n- share_link: Xiaohongshu user share link, support short and long links\n### Return:\n- Extracted info object containing:\n    - user_id: User ID\n    - xsec_token: Security token (if exists in URL)\n\n### Usage Guide:\n- Supports short link format: https://xhslink.com/m/xxxxx\n- Supports long link format: https://www.xiaohongshu.com/user/profile/xxxxx\n- Extracted user_id can be used in get_user_info endpoint\n# [示例/Example]\nshare_link=\"https://xhslink.com/m/Ap1vXtgAixh\"","operationId":"get_user_id_and_xsec_token_api_v1_xiaohongshu_app_get_user_id_and_xsec_token_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_link","in":"query","required":true,"schema":{"type":"string","description":"用户分享链接/User share link","title":"Share Link"},"description":"用户分享链接/User share link","example":"https://xhslink.com/m/Ap1vXtgAixh"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/get_product_detail":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"获取商品详情/Get product detail","description":"# [中文]\n### 用途:\n- 获取小红书商品详情信息\n### 参数:\n- sku_id: 商品skuId（必需）\n### 返回:\n- 商品详情数据\n\n# [English]\n### Purpose:\n- Get Xiaohongshu product detail info\n### Parameters:\n- sku_id: Product SKU ID (required)\n### Return:\n- Product detail data\n\n# [示例/Example]\nsku_id=\"68be7cbc8c331700011f89d1\"","operationId":"get_product_detail_api_v1_xiaohongshu_app_get_product_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sku_id","in":"query","required":true,"schema":{"type":"string","description":"商品skuId/Product SKU ID","title":"Sku Id"},"description":"商品skuId/Product SKU ID","example":"68be7cbc8c331700011f89d1"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/app/search_products":{"get":{"tags":["Xiaohongshu-App-API"],"summary":"搜索商品/Search products","description":"# [中文]\n### 用途:\n- 搜索小红书商品\n### 参数:\n- keyword: 搜索关键词（必需）\n- page: 页码，从1开始（必需）\n- search_id: 搜索ID，第一次请求可不传，翻页时需要携带服务端返回的searchId\n- session_id: 会话ID，第一次请求可不传，翻页时携带服务端返回的sessionId\n- sort: 排序规则，默认综合\n    - \"sales_qty\": 销量\n    - \"price_asc\": 价格升序\n    - \"price_desc\": 价格降序\n- scope: 搜索范围，默认不限\n    - \"purchased\": 买过的店\n    - \"following\": 关注的店\n- service_guarantee: 物流权益，多选用英文逗号分割\n    - 可选值: \"24小时发货\", \"七天无理由\", \"现货\", \"退货包运费\"\n- min_price: 最低价\n- max_price: 最高价\n- super_promotion: 标签ID\n### 返回:\n- 搜索结果数据，包含：\n    - items: 商品列表\n    - searchId: 搜索ID（翻页必需）\n    - sessionId: 会话ID（翻页必需）\n    - has_more: 是否有更多数据\n\n### 翻页说明:\n- 首次搜索：只传keyword和page=1\n- 翻页搜索：传入相同keyword，递增page，并携带首次返回的searchId和sessionId\n- 注意：更换关键词时不要复用之前的searchId\n\n# [English]\n### Purpose:\n- Search Xiaohongshu products\n### Parameters:\n- keyword: Search keyword (required)\n- page: Page number, start from 1 (required)\n- search_id: Search ID, optional for first request, required for pagination\n- session_id: Session ID, optional for first request, required for pagination\n- sort: Sort method\n    - \"sales_qty\": By sales\n    - \"price_asc\": Price ascending\n    - \"price_desc\": Price descending\n- scope: Search scope\n    - \"purchased\": Shops you've bought from\n    - \"following\": Shops you follow\n- service_guarantee: Service guarantees, comma separated\n    - Options: \"24小时发货\", \"七天无理由\", \"现货\", \"退货包运费\"\n- min_price: Minimum price\n- max_price: Maximum price\n- super_promotion: Promotion tag ID\n### 返回:\n- Search results containing:\n    - items: Product list\n    - searchId: Search ID (required for pagination)\n    - sessionId: Session ID (required for pagination)\n    - has_more: Whether has more data\n\n### Pagination Guide:\n- First search: Only pass keyword and page=1\n- Next pages: Pass same keyword, increment page, include searchId and sessionId\n- Note: Don't reuse searchId when changing keywords\n\n# [示例/Example]\nkeyword=\"充电宝\"\npage=1\nsort=\"sales_qty\"","operationId":"search_products_api_v1_xiaohongshu_app_search_products_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"充电宝"},{"name":"page","in":"query","required":true,"schema":{"type":"integer","description":"页码（从1开始）/Page number (start from 1)","title":"Page"},"description":"页码（从1开始）/Page number (start from 1)","example":1},{"name":"search_id","in":"query","required":false,"schema":{"type":"string","description":"搜索ID，翻页时使用/Search ID for pagination","title":"Search Id"},"description":"搜索ID，翻页时使用/Search ID for pagination","example":""},{"name":"session_id","in":"query","required":false,"schema":{"type":"string","description":"会话ID，翻页时使用/Session ID for pagination","title":"Session Id"},"description":"会话ID，翻页时使用/Session ID for pagination","example":""},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序规则：sales_qty-销量、price_asc-价格升序、price_desc-价格降序/Sort: sales_qty, price_asc, price_desc","title":"Sort"},"description":"排序规则：sales_qty-销量、price_asc-价格升序、price_desc-价格降序/Sort: sales_qty, price_asc, price_desc","example":"sales_qty"},{"name":"scope","in":"query","required":false,"schema":{"type":"string","description":"搜索范围：purchased-买过的店、following-关注的店/Scope: purchased, following","title":"Scope"},"description":"搜索范围：purchased-买过的店、following-关注的店/Scope: purchased, following","example":"purchased"},{"name":"service_guarantee","in":"query","required":false,"schema":{"type":"string","description":"物流权益，多选用英文逗号分割/Service guarantee, comma separated","title":"Service Guarantee"},"description":"物流权益，多选用英文逗号分割/Service guarantee, comma separated","example":"24小时发货,七天无理由"},{"name":"min_price","in":"query","required":false,"schema":{"type":"string","description":"最低价/Min price","title":"Min Price"},"description":"最低价/Min price","example":"1"},{"name":"max_price","in":"query","required":false,"schema":{"type":"string","description":"最高价/Max price","title":"Max Price"},"description":"最高价/Max price","example":"100"},{"name":"super_promotion","in":"query","required":false,"schema":{"type":"string","description":"标签ID/Promotion tag ID","title":"Super Promotion"},"description":"标签ID/Promotion tag ID","example":"695fb0a330425100017ff555"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_feed_notes":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取单一笔记和推荐笔记 V1 (已弃用)/Fetch one note and feed notes V1 (deprecated)","description":"# [中文]\n### 用途:\n- 获取单一笔记和推荐笔记\n### 接口优先级:\n- 小红书接口推荐优先级: `App V2` > `App` > `Web V2（本接口）` > `Web`\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n### 返回:\n- 单一笔记和推荐笔记\n\n# [English]\n### Purpose:\n- Get one note and feed notes\n### API Priority:\n- Xiaohongshu API priority: `App V2` > `App` > `Web V2 (this)` > `Web`\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n### Return:\n- One note and feed notes\n\n# [示例/Example]\nnote_id = \"66c9cc31000000001f03a4bc\"","operationId":"fetch_feed_notes_api_v1_xiaohongshu_web_v2_fetch_feed_notes_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"66c9cc31000000001f03a4bc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_feed_notes_v2":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取单一笔记和推荐笔记 V2/Fetch one note and feed notes V2(v2稳定, 推荐使用此接口)","description":"# [中文]\n### 用途:\n- 获取单一笔记和推荐笔记\n### 接口优先级:\n- 小红书接口推荐优先级: `App V2` > `App` > `Web V2（本接口）` > `Web`\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n### 返回:\n- 单一笔记和推荐笔记\n\n# [English]\n### Purpose:\n- Get one note and feed notes\n### API Priority:\n- Xiaohongshu API priority: `App V2` > `App` > `Web V2 (this)` > `Web`\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n### Return:\n- One note and feed notes\n\n# [示例/Example]\nnote_id = \"66c9cc31000000001f03a4bc\"","operationId":"fetch_feed_notes_v2_api_v1_xiaohongshu_web_v2_fetch_feed_notes_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"66c9cc31000000001f03a4bc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_feed_notes_v3":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取单一笔记和推荐笔记 V3/Fetch one note and feed notes V3(通过短链获取笔记详情)","description":"# [中文]\n### 用途:\n- 获取单一笔记和推荐笔记\n### 参数:\n- short_url: 短链，可以从小红书的分享链接中获取\n### 返回:\n- 单一笔记和推荐笔记\n\n# [English]\n### Purpose:\n- Get one note and feed notes\n### Parameters:\n- short_url: Short URL, can be obtained from the sharing link of Xiaohongshu website.\n### Return:\n- One note and feed notes\n\n# [示例/Example]\nshort_url = \"http://xhslink.com/a/tyoREa3ciaAeb\"","operationId":"fetch_feed_notes_v3_api_v1_xiaohongshu_web_v2_fetch_feed_notes_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"short_url","in":"query","required":true,"schema":{"type":"string","description":"短链/Short URL","title":"Short Url"},"description":"短链/Short URL","example":"http://xhslink.com/a/tyoREa3ciaAeb"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_feed_notes_v4":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取单一笔记和推荐笔记 V4 (互动量有延迟)/Fetch one note and feed notes V4 (interaction volume has a delay)","description":"# [中文]\n### 用途:\n- 获取单一笔记和推荐笔记，结构不同互动量有延时\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n### 返回:\n- 单一笔记和推荐笔记\n\n# [English]\n### Purpose:\n- Get one note and feed notes, the structure is different and the interaction volume has a delay\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n### Return:\n- One note and feed notes\n\n# [示例/Example]\nnote_id = \"66c9cc31000000001f03a4bc\"","operationId":"fetch_feed_notes_v4_api_v1_xiaohongshu_web_v2_fetch_feed_notes_v4_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"66c9cc31000000001f03a4bc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_feed_notes_v5":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取单一笔记和推荐笔记 V5 (互动量有缺失)/Fetch one note and feed notes V5 (interaction volume has a missing)","description":"# [中文]\n### 用途:\n- 获取单一笔记和推荐笔记，结构不同互动量有缺失\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n### 返回:\n- 单一笔记和推荐笔记\n### 备注:\n- 互动数据仅有点赞数，没有评论数与收藏数\n\n# [English]\n### Purpose:\n- Get one note and feed notes, the structure is different and the interaction volume has a missing\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n### Return:\n- One note and feed notes\n### Notes:\n- Interaction data only includes likes, without comments and favorites.\n\n# [示例/Example]\nnote_id = \"66c9cc31000000001f03a4bc\"","operationId":"fetch_feed_notes_v5_api_v1_xiaohongshu_web_v2_fetch_feed_notes_v5_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"66c9cc31000000001f03a4bc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_note_image":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取小红书笔记图片/Fetch Xiaohongshu note image","description":"# [中文]\n### 用途:\n- 获取小红书笔记图片\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n### 返回:\n- 小红书笔记图片\n\n# [English]\n### Purpose:\n- Get Xiaohongshu note image\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n### Return:\n- Xiaohongshu note image\n\n# [示例/Example]\nnote_id = \"66c9cc31000000001f03a4bc\"","operationId":"fetch_note_image_api_v1_xiaohongshu_web_v2_fetch_note_image_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"66c9cc31000000001f03a4bc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_search_notes":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取搜索笔记/Fetch search notes","description":"# [中文]\n### 用途:\n- 获取搜索笔记\n### 参数:\n- keywords：搜索关键词\n- sort_type：排序方式\n    - general：综合\n    - time_descending：最新\n    - popularity_descending：最热\n- note_type: 笔记类型\n    - 0：全部\n    - 1：视频\n    - 2：图文\n### 返回:\n- 搜索笔记\n\n# [English]\n### Purpose:\n- Get search notes\n### Parameters:\n- keywords: Search keywords\n- sort_type: Sort type\n    - general: General\n    - time_descending: Latest\n    - popularity_descending: Popular\n- note_type: Note type\n    - 0: All\n    - 1: Video\n    - 2: Note\n### Return:\n- Search notes\n\n# [示例/Example]\nkeywords = \"口红\"\npage = 1\nsort_type = \"general\"\nnote_type = \"1\"","operationId":"fetch_search_notes_api_v1_xiaohongshu_web_v2_fetch_search_notes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keywords","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keywords","title":"Keywords"},"description":"搜索关键词/Search keywords","example":"口红"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort type","default":"general","title":"Sort Type"},"description":"排序方式/Sort type"},{"name":"note_type","in":"query","required":false,"schema":{"type":"string","description":"笔记类型/Note type","default":"0","title":"Note Type"},"description":"笔记类型/Note type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_search_users":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取搜索用户/Fetch search users","description":"# [中文]\n### 用途:\n- 获取搜索用户\n### 参数:\n- keywords：搜索关键词\n- page：页码\n### 返回:\n- 搜索用户\n\n# [English]\n### Purpose:\n- Get search users\n### Parameters:\n- keywords: Search keywords\n- page: Page number\n### Return:\n- Search users\n\n# [示例/Example]\nkeywords = \"口红\"\npage = 1","operationId":"fetch_search_notes_api_v1_xiaohongshu_web_v2_fetch_search_users_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keywords","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keywords","title":"Keywords"},"description":"搜索关键词/Search keywords","example":"口红"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_home_notes":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取Web用户主页笔记/Fetch web user profile notes","description":"# [中文]\n### 用途:\n- 获取主页笔记\n### 参数:\n- user_id: 用户ID\n- cursor: 游标\n### 返回:\n- 主页笔记\n\n# [English]\n### Purpose:\n- Get home notes\n### Parameters:\n- user_id: User ID\n- cursor: Cursor\n### Return:\n- Home notes\n\n# [示例/Example]\nuser_id = \"5f3e0d00000000001f03a4bc\"\ncursor = \"\"","operationId":"fetch_home_notes_api_v1_xiaohongshu_web_v2_fetch_home_notes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"5e3a8ee700000000010070c6"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","default":"","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_home_notes_app":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取App用户主页笔记/Fetch App user home notes","description":"# [中文]\n### 用途:\n- 获取App主页笔记\n### 参数:\n- user_id: 用户ID\n- cursor: 游标\n### 返回:\n- 主页笔记\n\n# [English]\n### Purpose:\n- Get home notes\n### Parameters:\n- user_id: User ID\n- cursor: Cursor\n### Return:\n- Home notes\n\n# [示例/Example]\nuser_id = \"5f3e0d00000000001f03a4bc\"","operationId":"fetch_home_notes_app_api_v1_xiaohongshu_web_v2_fetch_home_notes_app_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"5e3a8ee700000000010070c6"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","default":"","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_note_comments":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取笔记评论/Fetch note comments","description":"# [中文]\n### 用途:\n- 获取笔记评论\n### 参数:\n- note_id: 笔记ID\n- cursor: 游标\n### 返回:\n- 笔记评论\n\n# [English]\n### Purpose:\n- Get note comments\n### Parameters:\n- note_id: Note ID\n- cursor: Cursor\n### Return:\n- Note comments\n\n# [示例/Example]\nnote_id = \"651ccaa9000000001f03d7f7\"\ncursor = \"\"","operationId":"fetch_note_comments_api_v1_xiaohongshu_web_v2_fetch_note_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"651ccaa9000000001f03d7f7"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","default":"","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_sub_comments":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取子评论/Fetch sub comments","description":"# [中文]\n### 用途:\n- 获取子评论\n### 参数:\n- note_id: 笔记ID\n- comment_id: 评论ID\n- cursor: 游标\n### 返回:\n- 子评论\n\n# [English]\n### Purpose:\n- Get sub comments\n### Parameters:\n- note_id: Note ID\n- comment_id: Comment ID\n- cursor: Cursor\n### Return:\n- Sub comments\n\n# [示例/Example]\nnote_id = \"673c894c0000000007033f92\"\ncomment_id = \"673ecdfc000000001503bf8b\"\ncursor = \"\"","operationId":"fetch_sub_comments_api_v1_xiaohongshu_web_v2_fetch_sub_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"673c894c0000000007033f92"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论ID/Comment ID","title":"Comment Id"},"description":"评论ID/Comment ID","example":"673ecdfc000000001503bf8b"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","default":"","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_user_info":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取用户信息/Fetch user info","description":"# [中文]\n### 用途:\n- 获取用户信息\n### 参数:\n- user_id: 用户ID\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get user info\n### Parameters:\n- user_id: User ID\n### Return:\n- User info\n\n# [示例/Example]\nuser_id = \"5e3a8ee700000000010070c6\"","operationId":"fetch_user_info_api_v1_xiaohongshu_web_v2_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"5e3a8ee700000000010070c6"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_user_info_app":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取App用户信息/Fetch App user info","description":"# [中文]\n### 用途:\n- 获取用户信息\n### 参数:\n- user_id: 用户ID\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get user info\n### Parameters:\n- user_id: User ID\n### Return:\n- User info\n\n# [示例/Example]\nuser_id = \"5e3a8ee700000000010070c6\"","operationId":"fetch_user_info_api_v1_xiaohongshu_web_v2_fetch_user_info_app_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"5e3a8ee700000000010070c6"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_follower_list":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取用户粉丝列表/Fetch follower list","description":"# [中文]\n### 用途:\n- 获取用户粉丝列表\n### 参数:\n- user_id: 用户ID\n- cursor: 游标\n### 返回:\n- 用户粉丝列表\n\n# [English]\n### Purpose:\n- Get follower list\n### Parameters:\n- user_id: User ID\n- cursor: Cursor\n### Return:\n- Follower list\n\n# [示例/Example]\nuser_id = \"604a28420000000001005211\"\ncursor = \"\"","operationId":"fetch_follower_list_api_v1_xiaohongshu_web_v2_fetch_follower_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"604a28420000000001005211"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","default":"","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_following_list":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取用户关注列表/Fetch following list","description":"# [中文]\n### 用途:\n- 获取用户关注列表\n### 参数:\n- user_id: 用户ID\n- cursor: 游标\n### 返回:\n- 用户关注列表\n\n# [English]\n### Purpose:\n- Get following list\n### Parameters:\n- user_id: User ID\n- cursor: Cursor\n### Return:\n- Following list\n\n# [示例/Example]\nuser_id = \"604a28420000000001005211\"\ncursor = \"\"","operationId":"fetch_following_list_api_v1_xiaohongshu_web_v2_fetch_following_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"604a28420000000001005211"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","default":"","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_product_list":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取小红书商品列表/Fetch Xiaohongshu product list","description":"# [中文]\n### 用途:\n- 获取小红书商品列表\n### 参数:\n- user_id: 用户ID\n- page: 页码\n### 返回:\n- 小红书商品列表\n\n# [English]\n### Purpose:\n- Get Xiaohongshu product list\n### Parameters:\n- user_id: User ID\n- page: Page number\n### Return:\n- Xiaohongshu product list\n\n# [示例/Example]\nuser_id = \"627e35aa00000000210275ae\"\npage = \"1\"","operationId":"fetch_product_list_api_v1_xiaohongshu_web_v2_fetch_product_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"627e35aa00000000210275ae"},{"name":"page","in":"query","required":false,"schema":{"type":"string","description":"页码/Page number","default":"1","title":"Page"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web_v2/fetch_hot_list":{"get":{"tags":["Xiaohongshu-Web-V2-API"],"summary":"获取小红书热榜/Fetch Xiaohongshu hot list","description":"# [中文]\n### 用途:\n- 获取小红书热榜\n### 返回:\n- 小红书热榜\n\n# [English]\n### Purpose:\n- Get Xiaohongshu hot list\n### Return:\n- Xiaohongshu hot list\n\n# [示例/Example]","operationId":"fetch_hot_list_api_v1_xiaohongshu_web_v2_fetch_hot_list_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/xiaohongshu/web/get_home_recommend":{"post":{"tags":["Xiaohongshu-Web-API"],"summary":"获取首页推荐/Get home recommend","description":"# [中文]\n### 用途:\n- 获取首页推荐\n### 接口优先级:\n- 小红书接口推荐优先级: `App V2` > `App` > `Web V2` > `Web（本接口）`\n### 参数:\n- feed_type: 推荐类型\n    - 全部: 0\n    - 穿搭: 1\n    - 美食: 2\n    - 彩妆: 3\n    - 影视: 4\n    - 职场: 5\n    - 情感: 6\n    - 家居: 7\n    - 游戏: 8\n    - 旅行: 9\n    - 健身: 10\n- need_filter_image: 是否只看图文笔记，默认为 False\n- cookie: 可选参数，用户自行提供的已登录的网页Cookie获取个性化推荐，如果不提供，则使用游客模式\n- proxy: 可选参数，网络代理，可降低封号概率，格式：http://用户名:密码@IP:端口/Proxy, format: http://username:password@IP:port\n### 返回:\n- 推荐列表\n\n# [English]\n### Purpose:\n- Get home recommend\n### API Priority:\n- Xiaohongshu API priority: `App V2` > `App` > `Web V2` > `Web (this)`\n### Parameters:\n- feed_type: Feed type\n    - Dress: 1\n    - Food: 2\n    - Makeup: 3\n    - Film: 4\n    - Workplace: 5\n    - Emotion: 6\n    - Home: 7\n    - Game: 8\n    - Travel: 9\n    - Fitness: 10\n- need_filter_image: Whether to view only image notes, default is False\n- cookie: Optional parameter, user-provided logged-in web Cookie to get personalized recommendations, if not provided, use visitor mode\n- proxy: Optional parameter, network proxy, can reduce the probability of account ban, format: http://username:password@IP:port\n### Return:\n- Recommend list\n\n# [示例/Example]\nfeed_type=\"0\"\nneed_filter_image=False","operationId":"get_home_recommend_api_v1_xiaohongshu_web_get_home_recommend_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHomeFeedRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/xiaohongshu/web/get_note_info_v2":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取笔记信息 V2/Get note info V2","description":"# [中文]\n### 用途:\n- 获取笔记信息 V2\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n### 返回:\n- 笔记信息\n\n# [English]\n### Purpose:\n- Get note info V2\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n### Return:\n- Note info\n\n# [示例/Example]\nnote_id=\"665f95200000000006005624\"","operationId":"get_note_info_v2_api_v1_xiaohongshu_web_get_note_info_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"665f95200000000006005624"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"https://xhslink.com/a/EZ4M9TwMA6c3"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/get_note_info_v4":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取笔记信息 V4/Get note info V4","description":"# [中文]\n### 用途:\n- 获取笔记信息V4\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n### 返回:\n- 笔记信息\n\n# [English]\n### Purpose:\n- Get note info V4\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n### Return:\n- Note info\n\n# [示例/Example]\nnote_id=\"665f95200000000006005624\"","operationId":"get_note_info_v4_api_v1_xiaohongshu_web_get_note_info_v4_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"665f95200000000006005624"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"https://xhslink.com/a/EZ4M9TwMA6c3"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/get_note_info_v5":{"post":{"tags":["Xiaohongshu-Web-API"],"summary":"获取笔记信息 V5 (自带Cookie)/Get note info V5 (Self-provided Cookie)","description":"# [中文]\n### 用途:\n- 获取笔记信息V5，用户自行提供Cookie来获取笔记信息\n- 此接口收费0.001$\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n- xsec_token: X-Sec-Token，可以从搜索接口中获取，分享链接中也有/X-Sec-Token, can be obtained from the search interface, also in the sharing link\n- cookie: 用户自行提供的已登录的网页Cookie\n- proxy: 代理，格式：http://用户名:密码@IP:端口/Proxy, format: http://username:password@IP:port\n- 最好使用代理，避免被封号或其他未知问题。\n\n### 返回:\n- 笔记信息\n\n# [English]\n### Purpose:\n- Get note info V5, user provides Cookie to get note info\n- This interface charges 0.001$\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n- xsec_token: X-Sec-Token, can be obtained from the search interface, also in the sharing link\n- cookie: User provided logged-in web Cookie\n- proxy: Proxy, format: http://username:password@IP:port\n- It is recommended to use a proxy to avoid being banned or other unknown issues.\n### Return:\n- Note info\n\n# [示例/Example]\nnote_id = \"67855d09000000001703d449\"\nxsec_token = \"ABfpRSESmZDRbX-EX7lzEztktMngxPVC9kU-dgQmuQoNo=\"\ncookie = \"Your Cookie\"\nproxy = \"http://username:password@IP:port\"","operationId":"get_note_info_v5_api_v1_xiaohongshu_web_get_note_info_v5_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNoteInfoV5Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/xiaohongshu/web/get_note_info_v7":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取笔记信息 V7/Get note info V7","description":"# [中文]\n### 用途:\n- 获取笔记信息V7\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。\n### 返回:\n- 笔记信息\n\n# [English]\n### Purpose:\n- Get note info V7\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail.\n### Return:\n- Note info\n\n# [示例/Example]\nnote_id=\"665f95200000000006005624\"","operationId":"get_note_info_v7_api_v1_xiaohongshu_web_get_note_info_v7_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":false,"schema":{"type":"string","description":"笔记ID/Note ID","default":"","title":"Note Id"},"description":"笔记ID/Note ID","example":"665f95200000000006005624"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":"https://xhslink.com/a/EZ4M9TwMA6c3"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/get_note_comments":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取笔记评论 V1/Get note comments V1","description":"# [中文]\n### 用途:\n- 获取笔记评论 V1\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n- lastCursor: 第一次请求时为空，之后请求时使用上一次请求响应中返回的游标\n### 返回:\n- 笔记评论列表\n\n# [English]\n### Purpose:\n- Get note comments V1\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n- lastCursor: Last cursor, empty for the first request, use the cursor returned in the last response for subsequent requests\n### Return:\n- Note comments list\n\n# [示例/Example]\nnote_id=\"6683b283000000001f0052bf\"\nlastCursor=None","operationId":"get_note_comments_api_v1_xiaohongshu_web_get_note_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"6683b283000000001f0052bf"},{"name":"lastCursor","in":"query","required":false,"schema":{"type":"string","description":"上一页的游标/Last cursor","title":"Lastcursor"},"description":"上一页的游标/Last cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/get_note_comment_replies":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取笔记评论回复 V1/Get note comment replies V1","description":"# [中文]\n### 用途:\n- 获取笔记评论回复 V1\n### 参数:\n- note_id: 笔记ID，可以从小红书的分享链接中获取\n- comment_id: 评论ID\n- lastCursor: 第一次请求时为空，之后请求时使用上一次请求响应中返回的游标\n### 返回:\n- 笔记评论回复列表\n\n# [English]\n### Purpose:\n- Get note comment replies V1\n### Parameters:\n- note_id: Note ID, can be obtained from the sharing link of Xiaohongshu website.\n- comment_id: Comment ID\n- lastCursor: Last cursor, empty for the first request, use the cursor returned in the last response for subsequent requests\n### Return:\n- Note comment replies list\n\n# [示例/Example]\nnote_id=\"6683b283000000001f0052bf\"\ncomment_id=\"6683ec5b000000000303b91a\"\nlastCursor=None","operationId":"get_note_comment_replies_api_v1_xiaohongshu_web_get_note_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"note_id","in":"query","required":true,"schema":{"type":"string","description":"笔记ID/Note ID","title":"Note Id"},"description":"笔记ID/Note ID","example":"6683b283000000001f0052bf"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论ID/Comment ID","title":"Comment Id"},"description":"评论ID/Comment ID","example":"6683ec5b000000000303b91a"},{"name":"lastCursor","in":"query","required":false,"schema":{"type":"string","description":"上一页的游标/Last cursor","title":"Lastcursor"},"description":"上一页的游标/Last cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/get_user_info":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取用户信息 V1/Get user info V1","description":"# [中文]\n### 用途:\n- 获取用户信息 V1\n### 参数:\n- user_id: 用户ID，可以从小红书的分享链接中获取\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get user info V1\n### Parameters:\n- user_id: User ID, can be obtained from the sharing link of Xiaohongshu website.\n### Return:\n- User info\n\n# [示例/Example]\nuser_id=\"5f4a10070000000001006fc7\"","operationId":"get_user_info_api_v1_xiaohongshu_web_get_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"5f4a10070000000001006fc7"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/get_user_info_v2":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取用户信息 V2/Get user info V2","description":"# [中文]\n### 用途:\n- 获取用户信息 V2\n### 参数:\n- user_id: 用户ID，可以从小红书的分享链接中获取\n- share_text: 小红书分享文本或链接（支持APP和Web端分享链接）\n- 优先使用`user_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`user_id`为准。\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get user info V2\n### Parameters:\n- user_id: User ID, can be obtained from the sharing link of Xiaohongshu website.\n- share_text: Xiaohongshu sharing text or link (support APP and Web sharing link)\n- Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail.\n### Return:\n- User info\n\n# [示例/Example]\nuser_id = \"5f4a10070000000001006fc7\"\nshare_text = \"@Noo 在小红书收获了15.3万次赞与收藏，查看Ta的主页>> https://xhslink.com/m/7XkrlCXbL38\"","operationId":"get_user_info_v2_api_v1_xiaohongshu_web_get_user_info_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","default":"","title":"User Id"},"description":"用户ID/User ID","example":"5f4a10070000000001006fc7"},{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享文本或链接/Share text or link","default":"","title":"Share Text"},"description":"分享文本或链接/Share text or link","example":"示例: @Noo 在小红书收获了15.3万次赞与收藏，查看Ta的主页>> https://xhslink.com/m/7XkrlCXbL38"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/search_notes":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"搜索笔记/Search notes","description":"# [中文]\n### 用途:\n- 搜索笔记\n### 参数:\n- keyword: 搜索关键词\n- page: 页码，默认为1\n- sort: 排序方式\n    - 综合排序（默认参数）: general\n    - 最热排序: popularity_descending\n    - 最新排序: time_descending\n    - 最多评论: comment_descending\n    - 最多收藏: collect_descending\n- noteType: 笔记类型\n    - 综合笔记（默认参数）: _0\n    - 视频笔记: _1\n    - 图文笔记: _2\n    - 直播: _3\n- noteTime: 发布时间\n    - 不限: \"\"\n    - 一天内 :一天内\n    - 一周内 :一周内\n    - 半年内 :半年内\n### 返回:\n- 笔记列表\n\n# [English]\n### Purpose:\n- Search notes\n### Parameters:\n- keyword: Keyword\n- page: Page, default is 1\n- sort: Sort\n    - General sort (default): general\n    - Popularity sort: popularity_descending\n    - Latest sort: time_descending\n    - Most comments: comment_descending\n    - Most favorites: collect_descending\n- noteType: Note type\n    - General note (default): _0\n    - Video note: _1\n    - Image note: _2\n    - Live: _3\n- noteTime: Release time\n    - No limit: \"\"\n    - Within one day: 一天内\n    - Within one week: 一周内\n    - Within half a year: 半年内\n### Return:\n- Note list\n\n# [示例/Example]\nkeyword=\"美食\"\npage=1\nsort=\"general\"\nnoteType=\"_0\"","operationId":"search_notes_api_v1_xiaohongshu_web_search_notes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Keyword","title":"Keyword"},"description":"搜索关键词/Keyword","example":"美食"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page","default":1,"title":"Page"},"description":"页码/Page","example":1},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort","default":"general","title":"Sort"},"description":"排序方式/Sort","example":"general"},{"name":"noteType","in":"query","required":false,"schema":{"type":"string","description":"笔记类型/Note type","default":"_0","title":"Notetype"},"description":"笔记类型/Note type","example":"_0"},{"name":"noteTime","in":"query","required":false,"schema":{"type":"string","description":"发布时间/Release time","default":"","title":"Notetime"},"description":"发布时间/Release time","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/search_notes_v3":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"搜索笔记 V3/Search notes V3","description":"# [中文]\n### 用途:\n- 搜索笔记 V3\n### 参数:\n- keyword: 搜索关键词\n- page: 页码，默认为1\n- sort: 排序方式\n    - 综合排序（默认参数）: general\n    - 最热排序: popularity_descending\n    - 最新排序: time_descending\n    - 最多评论: comment_descending\n    - 最多收藏: collect_descending\n- noteType: 笔记类型\n    - 综合笔记（默认参数）: _0\n    - 视频笔记: _1\n    - 图文笔记: _2\n    - 直播: _3\n- noteTime: 发布时间\n    - 不限: \"\"\n    - 一天内 :一天内\n    - 一周内 :一周内\n    - 半年内 :半年内\n### 返回:\n- 笔记列表\n\n# [English]\n### Purpose:\n- Search notes V3\n### Parameters:\n- keyword: Keyword\n- page: Page, default is 1\n- sort: Sort\n    - General sort (default): general\n    - Popularity sort: popularity_descending\n    - Latest sort: time_descending\n    - Most comments: comment_descending\n    - Most favorites: collect_descending\n- noteType: Note type\n    - General note (default): _0\n    - Video note: _1\n    - Image note: _2\n    - Live: _3\n- noteTime: Release time\n    - No limit: \"\"\n    - Within one day: 一天内\n    - Within one week: 一周内\n    - Within half a year: 半年内\n### Return:\n- Note list\n\n# [示例/Example]\nkeyword=\"美食\"\npage=1\nsort=\"general\"\nnoteType=\"_0\"","operationId":"search_notes_v3_api_v1_xiaohongshu_web_search_notes_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Keyword","title":"Keyword"},"description":"搜索关键词/Keyword","example":"美食"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page","default":1,"title":"Page"},"description":"页码/Page","example":1},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort","default":"general","title":"Sort"},"description":"排序方式/Sort","example":"general"},{"name":"noteType","in":"query","required":false,"schema":{"type":"string","description":"笔记类型/Note type","default":"_0","title":"Notetype"},"description":"笔记类型/Note type","example":"_0"},{"name":"noteTime","in":"query","required":false,"schema":{"type":"string","description":"发布时间/Release time","default":"","title":"Notetime"},"description":"发布时间/Release time","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/search_users":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"搜索用户/Search users","description":"# [中文]\n### 用途:\n- 搜索用户\n### 参数:\n- keyword: 搜索关键词\n- page: 页码，默认为1\n### 返回:\n- 用户列表\n\n# [English]\n### Purpose:\n- Search users\n### Parameters:\n- keyword: Keyword\n- page: Page, default is 1\n### Return:\n- User list\n\n# [示例/Example]\nkeyword=\"美食\"\npage=1","operationId":"search_users_api_v1_xiaohongshu_web_search_users_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Keyword","title":"Keyword"},"description":"搜索关键词/Keyword","example":"美食"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page","default":1,"title":"Page"},"description":"页码/Page","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/get_user_notes_v2":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取用户的笔记 V2/Get user notes V2","description":"# [中文]\n### 用途:\n- 获取用户的笔记\n### 参数:\n- user_id: 用户ID，可以从小红书的分享链接中获取\n- lastCursor: 第一次请求时为空，之后请求时使用上一次请求响应中返回的最后一个NoteID\n    - 例如: \"662908190000000001007366\"\n    - JSON Path: $.data.data.notes.[-1].id\n### 返回:\n- 用户的笔记列表\n\n# [English]\n### Purpose:\n- Get user notes\n### Parameters:\n- user_id: User ID, can be obtained from the sharing link of Xiaohongshu website.\n- lastCursor: Last cursor, empty for the first request, use the last NoteID returned in the last response for subsequent requests\n    - Example: \"662908190000000001007366\"\n    - JSON Path: $.data.data.notes.[-1].id\n### Return:\n- User notes list\n\n# [示例/Example]\nuser_id=\"5f4a10070000000001006fc7\"\nlastCursor=None","operationId":"get_user_notes_api_v1_xiaohongshu_web_get_user_notes_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"5f4a10070000000001006fc7"},{"name":"lastCursor","in":"query","required":false,"schema":{"type":"string","description":"上一页的游标/Last cursor","title":"Lastcursor"},"description":"上一页的游标/Last cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/get_visitor_cookie":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取游客Cookie/Get visitor cookie","description":"# [中文]\n### 用途:\n- 获取小红书网页版的游客Cookie，可以用于爬取小红书的一些数据。\n### 参数:\n- proxy: 代理，例如: http://username:password@host:port\n- 代理格式支持HTTP和SOCKS5，若不需要代理则留空\n### 返回:\n- 游客Cookie\n\n# [English]\n### Purpose:\n- Get Xiaohongshu web visitor cookie, which can be used to crawl some data of Xiaohongshu.\n### Parameters:\n- proxy: Proxy, e.g. http://username:password@host:port\n### Return:\n- Visitor cookie","operationId":"get_visitor_cookie_api_v1_xiaohongshu_web_get_visitor_cookie_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proxy","in":"query","required":false,"schema":{"type":"string","description":"代理/Proxy","default":"","title":"Proxy"},"description":"代理/Proxy","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/sign":{"post":{"tags":["Xiaohongshu-Web-API"],"summary":"小红书Web签名/Xiaohongshu Web sign","description":"# [中文]\n### 用途:\n- 小红书Web签名，用于获取小红书的一些数据。\n- 生成 `X-s`, `X-t`, `X-s-common` 等签名参数。\n- 价格：0.001$/次\n### 参数:\n- sign_request: 签名请求模型\n    - path: 请求接口的路径，例如: `/api/sns/web/v1/homefeed`\n    - data: 请求API的荷载数据\n    - cookie: 请求接口的Cookie\n### 返回:\n- 签名参数(X-s, X-t, X-s-common等)\n\n# [English]\n### Purpose:\n- Xiaohongshu Web sign, used to get some data of Xiaohongshu.\n- Generate `X-s`, `X-t`, `X-s-common` and other signature parameters.\n- Price: 0.001$/time\n### Parameters:\n- sign_request: Sign request model\n    - path: Request API path, e.g. `/api/sns/web/v1/homefeed`\n    - data: Payload data of request API\n    - cookie: Request API cookie\n### Return:\n- Signature parameters(X-s, X-t, X-s-common, etc.)\n\n# [示例/Example]\n{\n    \"path\": \"/api/sns/web/v1/homefeed\",\n    \"data\": {\n        \"cursor_score\": \"\",\n        \"num\": 35,\n        \"refresh_type\": 1,\n        \"note_index\": 35,\n        \"unread_begin_note_id\": \"\",\n        \"unread_end_note_id\": \"\",\n        \"unread_note_count\": 0,\n        \"category\": \"homefeed_recommend\",\n        \"search_key\": \"\",\n        \"need_num\": 10,\n        \"image_formats\": [\n            \"jpg\",\n            \"webp\",\n            \"avif\"\n        ],\n        \"need_filter_image\": False\n    },\n    \"cookie\": \"web_session=030037a04eafd37791e6e4bd05204a8cf2af05;acw_tc=0a00d79f17363096679345838efb77751cc087fb039dd1691dc954824410f6;abRequestId=384480ae-5196-5818-a835-42e6278de9f0;webBuild=4.47.1;xsecappid=xhs-pc-web;a1=194441ef694PayUbdUvgp0dSHfIcACsNsLud0Lgru50000354513;webId=6cf10a564b9b07d129729b65e0d1785a;sec_poison_id=32964532-d414-4beb-914f-98811853b75f\"\n}","operationId":"sign_api_v1_xiaohongshu_web_sign_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XhsWebSignRequestModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/xiaohongshu/web/get_note_id_and_xsec_token":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"通过分享链接获取小红书的Note ID 和 xsec_token/Get Xiaohongshu Note ID and xsec_token by share link","description":"# [中文]\n### 用途:\n- 通过分享链接获取小红书的Note ID 和 xsec_token\n### 参数:\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n### 返回:\n- Note ID 和 xsec_token\n\n# [English]\n### Purpose:\n- Get Xiaohongshu Note ID and xsec_token by share link\n### Parameters:\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n### Return:\n- Note ID and xsec_token\n\n# [示例/Example]\nshare_text=\"https://xhslink.com/a/EZ4M9TwMA6c3\"","operationId":"get_note_id_and_xsec_token_api_v1_xiaohongshu_web_get_note_id_and_xsec_token_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_text","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Text"},"description":"分享链接/Share link","example":"https://xhslink.com/a/EZ4M9TwMA6c3"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/xiaohongshu/web/get_product_info":{"get":{"tags":["Xiaohongshu-Web-API"],"summary":"获取小红书商品信息/Get Xiaohongshu product info","description":"# [中文]\n### 用途:\n- 通过分享链接获取小红书的商品信息\n### 参数:\n- share_text: 小红书分享链接（支持APP和Web端分享链接）\n- item_id: 商品ID\n- xsec_token: X-Sec-Token\n- 如果share_text不为空，则item_id和xsec_token会被忽略\n- 如果share_text为空，则item_id和xsec_token不能为空\n### 返回:\n- 商品信息\n\n# [English]\n### Purpose:\n- Get Xiaohongshu product info by share link\n### Parameters:\n- share_text: Xiaohongshu sharing link (support APP and Web sharing link)\n- item_id: Item ID\n- xsec_token: X-Sec-Token\n- If share_text is not empty, item_id and xsec_token will be ignored\n- If share_text is empty, item_id and xsec_token cannot be empty\n### Return:\n- Product info\n\n# [示例/Example]\nitem_id=\"65fc2e6d6b92310001d24efb\"\nxsec_token=\"XBC6LTqeaEDeJETMoXo436Eg-74GxFemVnNHeONYobv7k=\"","operationId":"get_product_info_api_v1_xiaohongshu_web_get_product_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_text","in":"query","required":false,"schema":{"type":"string","description":"分享链接/Share link","default":"","title":"Share Text"},"description":"分享链接/Share link","example":""},{"name":"item_id","in":"query","required":false,"schema":{"type":"string","description":"商品ID/Item ID","default":"","title":"Item Id"},"description":"商品ID/Item ID","example":"65fc2e6d6b92310001d24efb"},{"name":"xsec_token","in":"query","required":false,"schema":{"type":"string","description":"X-Sec-Token","default":"","title":"Xsec Token"},"description":"X-Sec-Token","example":"XBC6LTqeaEDeJETMoXo436Eg-74GxFemVnNHeONYobv7k="}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/fetch_user_profile":{"get":{"tags":["Lemon8-App-API"],"summary":"获取指定用户的信息/Get information of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户的信息\n### 参数:\n- user_id: 用户ID，可以从接口`/lemon8/app/get_user_id`获取\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get information of specified user\n### Parameters:\n- user_id: User ID, can be obtained from the interface `/lemon8/app/get_user_id`\n### Return:\n- User information\n\n# [示例/Example]\nuser_id = \"7217844966059656197\"","operationId":"handler_user_profile_api_v1_lemon8_app_fetch_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"7217844966059656197"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/fetch_post_detail":{"get":{"tags":["Lemon8-App-API"],"summary":"获取指定作品的信息/Get information of specified post","description":"# [中文]\n### 用途:\n- 获取指定作品的信息\n### 参数:\n- item_id: 作品ID，可以从接口`/lemon8/app/get_item_id`获取\n### 返回:\n- 作品信息\n\n# [English]\n### Purpose:\n- Get information of specified post\n### Parameters:\n- item_id: Post ID, can be obtained from the interface `/lemon8/app/get_item_id`\n### Return:\n- Post information\n\n# [示例/Example]\nitem_id = \"7361926875709129222\"","operationId":"fetch_post_detail_api_v1_lemon8_app_fetch_post_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品ID/Post ID","title":"Item Id"},"description":"作品ID/Post ID","example":"7361926875709129222"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/fetch_user_follower_list":{"get":{"tags":["Lemon8-App-API"],"summary":"获取指定用户的粉丝列表/Get fans list of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户的粉丝列表\n### 参数:\n- user_id: 用户ID，可以从接口`/lemon8/app/get_user_id`获取\n- cursor: 翻页参数，可以从上一次请求的返回结果中获取，第一次请求为空，后续请求使用上一次请求返回的cursor进行翻页。\n### 返回:\n- 粉丝列表\n\n# [English]\n### Purpose:\n- Get fans list of specified user\n### Parameters:\n- user_id: User ID, can be obtained from the interface `/lemon8/app/get_user_id`\n- cursor: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the cursor returned by the last request is used for subsequent requests.\n### Return:\n- Fans list\n\n# [示例/Example]\nuser_id = \"7428056850216862763\"","operationId":"fetch_user_follower_list_api_v1_lemon8_app_fetch_user_follower_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"7428056850216862763"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数/Pagination parameter","default":"","title":"Cursor"},"description":"翻页参数/Pagination parameter","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/fetch_user_following_list":{"get":{"tags":["Lemon8-App-API"],"summary":"获取指定用户的关注列表/Get following list of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户的关注列表\n### 参数:\n- user_id: 用户ID，可以从接口`/lemon8/app/get_user_id`获取\n- cursor: 翻页参数，可以从上一次请求的返回结果中获取，第一次请求为空，后续请求使用上一次请求返回的cursor进行翻页。\n### 返回:\n- 关注列表\n\n# [English]\n### Purpose:\n- Get following list of specified user\n### Parameters:\n- user_id: User ID, can be obtained from the interface `/lemon8/app/get_user_id`\n- cursor: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the cursor returned by the last request is used for subsequent requests.\n### Return:\n- Following list\n\n# [示例/Example]\nuser_id = \"7428056850216862763\"","operationId":"fetch_user_following_list_api_v1_lemon8_app_fetch_user_following_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"7428056850216862763"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数/Pagination parameter","default":"","title":"Cursor"},"description":"翻页参数/Pagination parameter","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/fetch_post_comment_list":{"get":{"tags":["Lemon8-App-API"],"summary":"获取指定作品的评论列表/Get comments list of specified post","description":"# [中文]\n### 用途:\n- 获取指定作品的评论列表\n### 参数:\n- group_id: 作品的group_id，可以从接口`/lemon8/app/fetch_post_detail`获取\n- item_id: 作品的item_id，可以从接口`/lemon8/app/fetch_post_detail` 或 `/lemon8/app/get_item_id`获取\n- media_id: 作品的media_id，可以从接口`/lemon8/app/fetch_post_detail`获取\n- offset: 翻页参数，可以从上一次请求的返回结果中获取，第一次请求为空，后续请求使用上一次请求返回的offset进行翻页。\n### 返回:\n- 评论列表\n\n# [English]\n### Purpose:\n- Get comments list of specified post\n### Parameters:\n- group_id: Post's group_id, can be obtained from the interface `/lemon8/app/fetch_post_detail`\n- item_id: Post's item_id, can be obtained from the interface `/lemon8/app/fetch_post_detail` or `/lemon8/app/get_item_id`\n- media_id: Post's media_id, can be obtained from the interface `/lemon8/app/fetch_post_detail`\n- offset: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the offset returned by the last request is used for subsequent requests.\n### Return:\n- Comments list\n\n# [示例/Example]\ngroup_id = \"7361926875709129222\"\nitem_id = \"7361926875709129222\"\nmedia_id = \"7428056850216862763\"","operationId":"fetch_post_comment_list_api_v1_lemon8_app_fetch_post_comment_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"group_id","in":"query","required":true,"schema":{"type":"string","description":"作品的group_id/Post's group_id","title":"Group Id"},"description":"作品的group_id/Post's group_id","example":"7361926875709129222"},{"name":"item_id","in":"query","required":true,"schema":{"type":"string","description":"作品的item_id/Post's item_id","title":"Item Id"},"description":"作品的item_id/Post's item_id","example":"7361926875709129222"},{"name":"media_id","in":"query","required":true,"schema":{"type":"string","description":"作品的media_id/Post's media_id","title":"Media Id"},"description":"作品的media_id/Post's media_id","example":"7428056850216862763"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"翻页参数/Pagination parameter","default":"0","title":"Offset"},"description":"翻页参数/Pagination parameter","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/fetch_discover_banners":{"get":{"tags":["Lemon8-App-API"],"summary":"获取发现页Banner/Get banners of discover page","description":"# [中文]\n### 用途:\n- 获取发现页Banner（搜索页上方的滚动内容）\n### 返回:\n- Banner列表\n\n# [English]\n### Purpose:\n- Get banners of discover page\n### Return:\n- Banners list\n\n# [示例/Example]","operationId":"fetch_discover_banners_api_v1_lemon8_app_fetch_discover_banners_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/lemon8/app/fetch_discover_tab":{"get":{"tags":["Lemon8-App-API"],"summary":"获取发现页主体内容/Get main content of discover page","description":"# [中文]\n### 用途:\n- 获取发现页（搜索页主体内容）\n### 返回:\n- 主体内容\n\n# [English]\n### Purpose:\n- Get main content of discover page\n### Return:\n- Main content\n\n# [示例/Example]","operationId":"fetch_discover_tab_api_v1_lemon8_app_fetch_discover_tab_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/lemon8/app/fetch_discover_tab_information_tabs":{"get":{"tags":["Lemon8-App-API"],"summary":"获取发现页的 Editor's Picks/Get Editor's Picks of discover page","description":"# [中文]\n### 用途:\n- 获取发现页（搜索页下方的推荐内容 - Editor's Picks）\n### 返回:\n- 推荐内容\n\n# [English]\n### Purpose:\n- Get Editor's Picks of discover page\n### Return:\n- Editor's Picks\n\n# [示例/Example]","operationId":"fetch_discover_tab_information_tabs_api_v1_lemon8_app_fetch_discover_tab_information_tabs_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/lemon8/app/fetch_hot_search_keywords":{"get":{"tags":["Lemon8-App-API"],"summary":"获取热搜关键词/Get hot search keywords","description":"# [中文]\n### 用途:\n- 获取热搜关键词\n### 返回:\n- 热搜关键词列表\n\n# [English]\n### Purpose:\n- Get hot search keywords\n### Return:\n- Hot search keywords list\n\n# [示例/Example]","operationId":"fetch_hot_search_keywords_api_v1_lemon8_app_fetch_hot_search_keywords_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/lemon8/app/fetch_topic_info":{"get":{"tags":["Lemon8-App-API"],"summary":"获取话题信息/Get topic information","description":"# [中文]\n### 用途:\n- 获取话题信息\n### 参数:\n- forum_id: 话题ID，可以从下面的接口获取\n    - 获取指定作品的信息：`/lemon8/app/fetch_post_detail`\n    - 获取发现页的 Editor's Picks：`/lemon8/app/fetch_discover_tab_information_tabs`\n    - 通过接口搜索 Hashtag：`/lemon8/app/fetch_search?search_tab=hashtag&keyword=lemon8`\n### 返回:\n- 话题信息\n\n# [English]\n### Purpose:\n- Get topic information\n### Parameters:\n- forum_id: Topic ID, can be obtained from the following interfaces\n    - Get information of specified post: `/lemon8/app/fetch_post_detail`\n    - Get Editor's Picks of discover page: `/lemon8/app/fetch_discover_tab_information_tabs`\n    - Search Hashtag through interface: `/lemon8/app/fetch_search?search_tab=hashtag&keyword=lemon8`\n### Return:\n- Topic information\n\n# [示例/Example]\nforum_id = \"7174447913778593798\"","operationId":"fetch_topic_info_api_v1_lemon8_app_fetch_topic_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"forum_id","in":"query","required":true,"schema":{"type":"string","description":"话题ID/Topic ID","title":"Forum Id"},"description":"话题ID/Topic ID","example":"7174447913778593798"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/fetch_topic_post_list":{"get":{"tags":["Lemon8-App-API"],"summary":"获取话题作品列表/Get topic post list","description":"# [中文]\n### 用途:\n- 获取话题作品列表\n### 参数:\n- category: 话题分类 ID，可以从接口`/lemon8/app/fetch_topic_info`获取\n- max_behot_time: 翻页参数，可以从上一次请求的返回结果中获取，第一次请求为空，后续请求使用上一次请求返回的max_behot_time进行翻页。\n- category_parameter: 分类参数ID，可以从接口`/lemon8/app/fetch_topic_info`获取\n- hashtag_name: Hashtag名称，可以从接口`/lemon8/app/fetch_topic_info`获取\n- sort_type: 排序方式，0为默认排序，当前只支持使用默认排序，请不要传入其他值。\n### 返回:\n- 作品列表\n\n# [English]\n### Purpose:\n- Get topic post list\n### Parameters:\n- category: Topic category ID, can be obtained from the interface `/lemon8/app/fetch_topic_info`\n- max_behot_time: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the max_behot_time returned by the last request is used for subsequent requests.\n- category_parameter: Category parameter ID, can be obtained from the interface `/lemon8/app/fetch_topic_info`\n- hashtag_name: Hashtag name, can be obtained from the interface `/lemon8/app/fetch_topic_info`\n- sort_type: Sort type, 0 for default sort, currently only support default sort, please do not pass other values.\n### Return:\n- Post list\n\n# [示例/Example]\ncategory = \"590\"\nmax_behot_time = \"\"\ncategory_parameter = \"7174447913778593798\"\nhashtag_name = \"lemon8christmas\"\nsort_type = \"0\"","operationId":"fetch_topic_post_list_api_v1_lemon8_app_fetch_topic_post_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category","in":"query","required":true,"schema":{"type":"string","description":"话题分类 ID/Topic category ID","title":"Category"},"description":"话题分类 ID/Topic category ID","example":"590"},{"name":"max_behot_time","in":"query","required":false,"schema":{"type":"string","description":"翻页参数/Pagination parameter","default":"","title":"Max Behot Time"},"description":"翻页参数/Pagination parameter","example":""},{"name":"category_parameter","in":"query","required":true,"schema":{"type":"string","description":"分类参数/Category parameter","title":"Category Parameter"},"description":"分类参数/Category parameter","example":"7174447913778593798"},{"name":"hashtag_name","in":"query","required":true,"schema":{"type":"string","description":"Hashtag名称/Hashtag name","title":"Hashtag Name"},"description":"Hashtag名称/Hashtag name","example":"lemon8christmas"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort type","default":"0","title":"Sort Type"},"description":"排序方式/Sort type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/fetch_search":{"get":{"tags":["Lemon8-App-API"],"summary":"搜索接口/Search API","description":"# [中文]\n### 用途:\n- 搜索接口\n### 参数:\n- query: 搜索关键词\n- max_cursor: 翻页参数，可以从上一次请求的返回结果中获取，第一次请求为空，后续请求使用上一次请求返回的`max_cursor`进行翻页，可以通过返回结果的`has_more`字段判断是否还有更多数据。\n- filter_type: 搜索过滤类型，默认为空字符串，可选值如下：\n    - 空字符串：All（全部，默认使用此参数搜索）\n    - video：只搜索视频作品\n    - posts：只搜索文章作品\n- order_by: 搜索排序方式，默认为空字符串，可选值如下：\n    - 空字符串：Relevance（相关度，默认使用此参数排序）\n    - popular：流行度排序\n    - recent：从新到旧排序\n- search_tab: 搜索类型，默认为`main`，可选值如下：\n    - main：APP中显示为 `Top`（综合搜索，默认使用此参数搜索）\n    - user：APP中显示为 `Accounts` （搜索用户账号）\n    - hashtag：APP中显示为 `Hashtags`（搜索话题）\n    - article：APP中显示为 `Posts`（搜索文章）\n### 返回:\n- 搜索结果\n\n# [English]\n### Purpose:\n- Search API\n### Parameters:\n- query: Search keyword\n- max_cursor: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the `max_cursor` returned by the last request is used for subsequent requests. You can judge whether there is more data by the `has_more` field in the return result.\n- filter_type: Search filter type, default is an empty string, optional values are as follows:\n    - Empty string: All (default using this parameter to search)\n    - video: Search only video\n    - posts: Search only posts\n- order_by: Search sort type, default is an empty string, optional values are as follows:\n    - Empty string: Relevance (default using this parameter to sort)\n    - popular: Sort by popularity\n    - recent: Sort from new to old\n- search_tab: Search type, default is `main`, optional values are as follows:\n    - main: Display as `Top` in the APP (comprehensive search, default using this parameter to search)\n    - user: Display as `Accounts` in the APP (search user accounts)\n    - hashtag: Display as `Hashtags` in the APP (search hashtags)\n    - article: Display as `Posts` in the APP (search articles)\n### Return:\n- Search results\n\n# [示例/Example]\nquery = \"lemon8\"\nmax_cursor = \"\"\nfilter_type = \"\"\norder_by = \"\"\nsearch_tab = \"main\"","operationId":"fetch_search_api_v1_lemon8_app_fetch_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"lemon8"},{"name":"max_cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数/Pagination parameter","default":"","title":"Max Cursor"},"description":"翻页参数/Pagination parameter","example":""},{"name":"filter_type","in":"query","required":false,"schema":{"type":"string","description":"搜索过滤类型/Search filter type","default":"","title":"Filter Type"},"description":"搜索过滤类型/Search filter type","example":""},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"搜索排序方式/Search sort type","default":"","title":"Order By"},"description":"搜索排序方式/Search sort type","example":""},{"name":"search_tab","in":"query","required":false,"schema":{"type":"string","description":"搜索类型/Search type","default":"main","title":"Search Tab"},"description":"搜索类型/Search type","example":"main"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/get_item_id":{"get":{"tags":["Lemon8-App-API"],"summary":"通过分享链接获取作品ID/Get post ID through sharing link","description":"# [中文]\n### 用途:\n- 通过分享链接获取作品ID\n### 参数:\n- share_text: 分享链接，支持长链接和短链接，可以从网页端以及APP中的分享按钮获取并复制。\n### 返回:\n- 作品ID\n\n# [English]\n### Purpose:\n- Get post ID through sharing link\n### Parameters:\n- share_text: Share link, supports long links and short links, can be obtained and copied from the share button on the web and APP.\n### Return:\n- Post ID\n\n# [示例/Example]\nshare_text = \"https://www.lemon8-app.com/@deathlabs_/7445613324903006766\"\nshare_text = \"https://v.lemon8-app.com/al/OghwFTppx\"","operationId":"get_item_id_api_v1_lemon8_app_get_item_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_text","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Text"},"description":"分享链接/Share link","example":"https://v.lemon8-app.com/al/OghwFTppx"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/get_user_id":{"get":{"tags":["Lemon8-App-API"],"summary":"通过分享链接获取用户ID/Get user ID through sharing link","description":"# [中文]\n### 用途:\n- 通过分享链接获取用户ID\n### 参数:\n- share_text: 分享链接，支持长链接和短链接，可以从网页端以及APP中的分享按钮获取并复制。\n### 返回:\n- 用户ID\n\n# [English]\n### Purpose:\n- Get user ID through sharing link\n### Parameters:\n- share_text: Share link, supports long links and short links, can be obtained and copied from the share button on the web and APP.\n### Return:\n- User ID\n\n# [示例/Example]\nshare_text = \"https://www.lemon8-app.com/lemon8cars?region=us\"\nshare_text = \"https://v.lemon8-app.com/al/OgZrsUppx\"","operationId":"get_user_id_api_v1_lemon8_app_get_user_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_text","in":"query","required":true,"schema":{"type":"string","description":"分享链接/Share link","title":"Share Text"},"description":"分享链接/Share link","example":"https://v.lemon8-app.com/al/OgZrsUppx"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/lemon8/app/get_item_ids":{"post":{"tags":["Lemon8-App-API"],"summary":"通过分享链接批量获取作品ID/Get post IDs in batch through sharing links","description":"# [中文]\n### 用途:\n- 通过分享链接批量获取作品ID，一次最多获取10个\n### 参数:\n- share_texts: 分享链接列表，支持长链接和短链接，可以从网页端以及APP中的分享按钮获取并复制。\n### 返回:\n- 作品ID列表\n\n# [English]\n### Purpose:\n- Get post IDs in batch through sharing links, up to 10 at a time\n### Parameters:\n- share_texts: Share links list, supports long links and short links, can be obtained and copied from the share button on the web and APP.\n### Return:\n- Post IDs list\n\n# [示例/Example]\nshare_texts = [\n    \"https://www.lemon8-app.com/@deathlabs_/7445613324903006766\",\n    \"https://v.lemon8-app.com/al/OghwFTppx\"\n]","operationId":"get_item_ids_api_v1_lemon8_app_get_item_ids_post","requestBody":{"content":{"application/json":{"schema":{"items":{},"type":"array","title":"Share Texts","description":"分享链接列表/Share links list"},"example":["https://www.lemon8-app.com/@deathlabs_/7445613324903006766","https://v.lemon8-app.com/al/OghwFTppx"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/lemon8/app/get_user_ids":{"post":{"tags":["Lemon8-App-API"],"summary":"通过分享链接批量获取用户ID/Get user IDs in batch through sharing links","description":"# [中文]\n### 用途:\n- 通过分享链接批量获取用户ID，一次最多获取10个\n### 参数:\n- share_texts: 分享链接列表，支持长链接和短链接，可以从网页端以及APP中的分享按钮获取并复制。\n### 返回:\n- 用户ID列表\n\n# [English]\n### Purpose:\n- Get user IDs in batch through sharing links, up to 10 at a time\n### Parameters:\n- share_texts: Share links list, supports long links and short links, can be obtained and copied from the share button on the web and APP.\n### Return:\n- User IDs list\n\n# [示例/Example]\nshare_texts = [\n    \"https://www.lemon8-app.com/lemon8cars?region=us\",\n    \"https://v.lemon8-app.com/al/OgZrsUppx\"\n]","operationId":"get_user_ids_api_v1_lemon8_app_get_user_ids_post","requestBody":{"content":{"application/json":{"schema":{"items":{},"type":"array","title":"Share Texts","description":"分享链接列表/Share links list"},"example":["https://www.lemon8-app.com/lemon8cars?region=us","https://v.lemon8-app.com/al/OgZrsUppx"]}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/kuaishou/web/fetch_one_video":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取单个作品数据 V1/Get single video data V1","description":"# [中文]\n### 用途:\n- 获取单个作品数据，此接口不支持图文作品。\n### 参数:\n- share_text: 作品分享链接\n### 返回:\n- 视频数据\n\n# [English]\n### Purpose:\n- Fetch single video data, this interface does not support photo only posts.\n### Parameters:\n- share_text: Photo share link\n### Returns:\n- Video data\n\n# [示例/Example]\nshare_text = \"https://www.kuaishou.com/f/X-f2k5KJpiXN1SY\"","operationId":"fetch_one_video_api_v1_kuaishou_web_fetch_one_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_text","in":"query","required":true,"schema":{"type":"string","title":"作品分享链接/Photo share link"},"example":"https://www.kuaishou.com/f/X-f2k5KJpiXN1SY"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_one_video_v2":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取单个作品数据 V2/Get single video data V2","description":"# [中文]\n### 用途:\n- 快手单一视频查询接口V2\n### 参数:\n- photo_id: 作品ID，作品ID可以从作品链接中提取\n### 返回:\n- 视频数据\n\n# [English]\n### Purpose:\n- Kuaishou single video query API V2\n### Parameters:\n- photo_id: Photo ID, the photo ID can be extracted from the photo link\n### Returns:\n- Video data\n\n# [示例/Example]\nphoto_id = \"3xtdqvdnqd3psuc\"","operationId":"fetch_one_video_v2_api_v1_kuaishou_web_fetch_one_video_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"photo_id","in":"query","required":true,"schema":{"type":"string","title":"作品ID/Photo ID"},"example":"3xtdqvdnqd3psuc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_one_video_by_url":{"get":{"tags":["Kuaishou-Web-API"],"summary":"链接获取作品数据/Fetch single video by URL","description":"# [中文]\n### 用途:\n- 根据链接获取单个作品数据\n### 参数:\n- url: 作品链接\n### 返回:\n- 视频数据\n\n# [English]\n### Purpose:\n- Fetch single video by URL\n### Parameters:\n- url: Photo URL\n### Returns:\n- Video data\n\n# [示例/Example]\nurl = \"https://v.kuaishou.com/GKTpYm\"","operationId":"fetch_one_video_by_url_api_v1_kuaishou_web_fetch_one_video_by_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","title":"作品链接/Photo URL"},"example":"https://v.kuaishou.com/GKTpYm"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_one_video_comment":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取作品一级评论/Fetch video comments","description":"# [中文]\n### 用途:\n- 获取单个作品评论数据\n### 参数:\n- photo_id: 作品ID\n- pcursor: 评论游标，第一次请求为空，后续请求使用返回响应中的pcursor值进行翻页。\n### 返回:\n- 评论数据\n\n# [English]\n### Purpose:\n- Fetch single video comment data\n### Parameters:\n- photo_id: Photo ID\n- pcursor: Comment cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests.\n### Returns:\n- Comments data\n\n# [示例/Example]\nphoto_id = \"3x7gxp2zhgjv832\"\npcursor = None","operationId":"fetch_one_video_comment_api_v1_kuaishou_web_fetch_one_video_comment_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"photo_id","in":"query","required":true,"schema":{"type":"string","title":"作品ID/Photo ID"},"example":"3x7gxp2zhgjv832"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"评论游标/Comment cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_one_video_sub_comment":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取作品二级评论/Fetch video sub comments","description":"# [中文]\n### 用途:\n- 获取单个作品二级评论数据\n### 参数:\n- photo_id: 作品ID\n- pcursor: 评论游标，第一次请求为空，后续请求使用返回响应中的pcursor值进行翻页。\n- root_comment_id: 根评论ID\n### 返回:\n- 评论数据\n\n# [English]\n### Purpose:\n- Fetch single video comment data\n### Parameters:\n- photo_id: Photo ID\n- pcursor: Comment cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests.\n- root_comment_id: Root comment ID\n### Returns:\n- Comments data\n\n# [示例/Example]\nphoto_id = \"3xgarycnydawq3g\"\npcursor = \"909377053156\"\nroot_comment_id = \"908850553827\"","operationId":"fetch_one_video_sub_comment_api_v1_kuaishou_web_fetch_one_video_sub_comment_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"photo_id","in":"query","required":true,"schema":{"type":"string","title":"作品ID/Photo ID"},"example":"3xgarycnydawq3g"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"评论游标/Comment cursor","default":""},"example":"909377053156"},{"name":"root_comment_id","in":"query","required":true,"schema":{"type":"string","title":"根评论ID/Root comment ID"},"example":"908850553827"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/generate_share_short_url":{"get":{"tags":["Kuaishou-Web-API"],"summary":"生成分享短连接/Generate share short URL","description":"# [中文]\n### 用途:\n- 生成分享短连接\n### 参数:\n- photo_id: 作品ID\n### 返回:\n- 短连接\n\n# [English]\n### Purpose:\n- Generate share short URL\n### Parameters:\n- photo_id: Photo ID\n### Returns:\n- Short URL\n\n# [示例/Example]\nbody = {\n    \"photo_id\": \"3xtdqvdnqd3psuc\"\n}\n\n# [返回示例/Example Response]\n```json\n{\n  \"code\": 200,\n  \"request_id\": \"3fe5f6dc-e88c-4915-a6fa-2a63a2743342\",\n  \"router\": \"/api/v1/kuaishou/web/generate_share_short_url\",\n  \"params\": {\n    \"photo_id\": \"3xtdqvdnqd3psuc\"\n  },\n  \"data\": {\n    \"result\": 1,\n    \"hostName\": \"public-bjzey-rs6-kce-node1155.idchb1az3.hb1.kwaidc.com\",\n    \"cache-scope\": \"nocache\",\n    \"error_msg\": null,\n    \"max-age\": 0,\n    \"share\": {\n      \"shareMethod\": \"TOKEN\",\n      \"shareMethodType\": null,\n      \"shareChannel\": \"COPY_LINK\",\n      \"shareMode\": \"APP\",\n      \"kpn\": \"KUAISHOU\",\n      \"subBiz\": \"BROWSE_SLIDE_PHOTO\",\n      \"appName\": \"as\",\n      \"appIconUrl\": \"https://static.yximgs.com/udata/pkg/ks-share-sdk/cardlogonew.png\",\n      \"shareObject\": {\n        \"copylinkSuccessTips\": \"链接复制成功，快去分享给朋友吧\",\n        \"shareMessage\": \"https://v.kuaishou.com/KDh1s1j1 上一秒他是市民，下一秒他是市长 大哥突如其来的专业，让人笑不活了。\"搞笑 \"非物质文化遗产 \"...更多\",\n        \"kwaiToken\": \"X8hIM7myjQen2bi\",\n        \"shareId\": \"18546252276277\",\n        \"shareObjectId\": \"3xtdqvdnqd3psuc\",\n        \"shareResourceType\": \"PHOTO_OTHER\",\n        \"shortLink\": \"https://v.kuaishou.com/KDh1s1j1\"\n      },\n      \"extParams\": {\n        \"shareMode\": \"app\",\n        \"tokenExtParams\": \"{}\",\n        \"expTag\": \"1_i/0_unknown0\",\n        \"shareMethod\": \"token\",\n        \"useMmuTitle\": false,\n        \"logExt\": \"{\"expTag\":\"1_i/0_unknown0\",\"trendingType\":\"\"}\",\n        \"templateStyle\": \"\",\n        \"shareInfoWrap\": \"{\"shareTitleInfo\":{\"title\":\"分享一个作品给你\",\"subTitle\":\"推荐你看这个视频\"},\"shareId\":\"18546252276277\",\"docId\":9,\"groupName\":\"\",\"shareType\":\"PHOTO_OTHER\",\"coverUrlKey\":null,\"coverUrl\":null,\"tagType\":null,\"webShareVerifyData\":null}\",\n        \"battleTemplateId\": \"\",\n        \"templateGenerationType\": \"\"\n      }\n    },\n    \"host-name\": \"public-bjzey-rs6-kce-node1155.idchb1az3.hb1.kwaidc.com\"\n  }\n}\n```","operationId":"generate_share_short_url_api_v1_kuaishou_web_generate_share_short_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"photo_id","in":"query","required":true,"schema":{"type":"string","title":"作品ID/Photo ID"},"example":"3xtdqvdnqd3psuc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_user_info":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取用户信息/Fetch user info","description":"# [中文]\n    ### 用途:\n    - 获取用户信息\n    - 备注：\n    - 此接口在请求时请将超时时间设置为30秒以上，否则可能会导致客户端未及时收到请求响应并且导致计费。\n    - 此接口由于风控的特殊性，我们尽可能保持稳定，但仍然无法保证100%稳定，如果遇到请求失败，请稍后重试。\n    - 推荐一直重复请求，直到成功为止，并且超时时间设置为30秒以上。\n    ### 参数:\n    - user_id: 用户ID，这个接口需要传入用户的 eid，可以从用户主页链接中提取\n    - 例如：https://www.kuaishou.com/profile/3xz63mn6fngqtiq 其中 3xz63mn6fngqtiq 即为用户的 eid\n    - 备注：不支持使用uid也就是纯数字的用户ID查询\n    ### 返回:\n    - 用户信息，包括昵称、头像、粉丝数、关注数、获赞数、性别等\n\n    # [English]\n    ### Purpose:\n    - Fetch user info\n    - Note: This API requires the user's eid, which can be extracted from the user's profile URL.\n    - For example: In the URL https://www.kuaishou.com/profile/3xz63mn6fngqtiq, the eid is 3xz63mn6fngqtiq.\n    - Note: Querying with uid (pure numeric user ID) is not supported.\n    - Note: Please set the timeout to more than 30 seconds when making requests to this API, otherwise it may cause the client to not receive the response in time and result in billing.\n    - Due to the special nature of risk control for this API, we try to keep it stable, but we still cannot guarantee 100% stability. If you encounter a request failure, please try again later.\n    - It is recommended to keep retrying until successful, and set the timeout to more than 30 seconds.\n    ### Parameters:\n    - user_id: User ID\n    ### Returns:\n    - User info, including nickname, avatar, number of followers, number of followings, number\n\n    # [示例/Example]\n    user_id = \"3xz63mn6fngqtiq\"\n\n    # [返回示例/Example Response]\n    ```json\n    {\n        \"code\": 200,\n        \"request_id\": \"782e6fa2-4c8e-4fac-b151-78db03c10b8d\",\n        \"router\": \"/api/v1/kuaishou/web/fetch_user_info\",\n        \"params\": {\n            \"user_id\": \"3xz63mn6fngqtiq\"\n        },\n        \"data\": {\n            \"result\": 1,\n            \"userProfile\": {\n                \"profile\": {\n                    \"user_profile_bg_url\": \"//s2-10623.kwimgs.com/kos/nlav10623/vision_images/profile_background.5bc08b1bf4fba1f4.svg\",\n                    \"user_id\": \"3xz63mn6fngqtiq\",\n                    \"user_name\": \"权少爱吃小汉堡🍔\",\n                    \"headurl\": \"https://p66-pro.a.yximgs.com/uhead/AB/2025/08/11/21/BMjAyNTA4MTEyMTEyNDlfMjI4OTA1ODAyXzFfaGQ5ODdfODg4_s.jpg\",\n                    \"user_text\": \"感谢你的关注木木哒 我玩得游戏叫:Gmod\n\n禁止冒充搬运视频 违者必究\"\n                },\n                \"gender\": \"M\",\n                \"showCollectTab\": false,\n                \"livingInfo\": {\n                    \"living\": false,\n                    \"livingId\": null,\n                    \"iconType\": 0\n                },\n                \"ownerCount\": {\n                    \"fan\": 4300985,\n                    \"like\": 37676016,\n                    \"follow\": 198,\n                    \"photo_public\": 237\n                },\n                \"userDefineId\": \"quanshaogmod\",\n                \"isFollowing\": false,\n                \"isUserIsolated\": false\n            },\n            \"host-name\": \"public-bjzey-c3-kce-node67.idchb1az3.hb1.kwaidc.com\"\n        }\n    }\n    ```","operationId":"fetch_user_info_api_v1_kuaishou_web_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","title":"用户 ID (eid)/User ID (eid)"},"example":"3xz63mn6fngqtiq"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_user_post":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取用户发布作品/Fetch user posts","description":"# [中文]\n### 用途:\n- 获取用户作品列表\n### 参数:\n- user_id: 用户ID，这个接口需要传入用户的 eid，可以从用户主页链接中提取\n- 例如：https://www.kuaishou.com/profile/3xz63mn6fngqtiq 其中 3xz63mn6fngqtiq 即为用户的 eid\n- 备注：\n- 不支持使用uid也就是纯数字的用户ID查询\n- 此接口在请求时请将超时时间设置为30秒以上，否则可能会导致客户端未及时收到请求响应并且导致计费。\n- 此接口由于风控的特殊性，我们尽可能保持稳定，但仍然无法保证100%稳定，如果遇到请求失败，请稍后重试。\n- 推荐一直重复请求，直到成功为止，并且超时时间设置为30秒以上。\n- pcursor: 作品游标，第一次请求为空，后续请求使用返回响应中的pcursor值进行翻页。\n### 返回:\n- 用户作品列表\n\n# [English]\n### Purpose:\n- Fetch user posts\n- Note: This API requires the user's eid, which can be extracted from the user's profile URL.\n- For example: In the URL https://www.kuaishou.com/profile/3xz63mn6fngqtiq, the eid is 3xz63mn6fngqtiq.\n- Note:\n- Querying with uid (pure numeric user ID) is not supported.\n- Note: Please set the timeout to more than 30 seconds when making requests to this API, otherwise it may cause the client to not receive the response in time and result in billing.\n- Due to the special nature of risk control for this API, we try to keep it\n- stable, but we still cannot guarantee 100% stability. If you encounter a request failure, please try again later.\n- It is recommended to keep retrying until successful, and set the timeout to more than 30 seconds.\n### Parameters:\n- user_id: User ID\n- pcursor: Post cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests.\n### Returns:\n- User posts list\n\n# [示例/Example]\nuser_id = \"3xz63mn6fngqtiq\"\npcursor = None\n\n# [部分返回示例/Part Example Response]\n```json\n{\n    \"code\": 200,\n    \"request_id\": \"de055431-bf7d-4a24-a332-9cc1654ab247\",\n    \"router\": \"/api/v1/kuaishou/web/fetch_user_post\",\n    \"params\": {\n        \"user_id\": \"3xz63mn6fngqtiq\",\n        \"pcursor\": \"1.698748219278E12\"\n    },\n    \"data\": {\n        \"result\": 1,\n        \"pcursor\": \"1.692702206373E12\",\n        \"feeds\": [\n            {\n                \"type\": 1,\n                \"photo\": {\n                    \"manifestH265\": {\n                        \"version\": \"1.0.0\",\n                        \"businessType\": 2,\n                        \"mediaType\": 2,\n                        \"videoId\": \"b1a31deb8e75e7be\",\n                        \"hideAuto\": false,\n                        \"manualDefaultSelect\": false,\n                        \"stereoType\": 0,\n                        \"adaptationSet\": [\n                            {\n                                \"id\": 1,\n                                \"duration\": 84937,\n                                \"representation\": [\n                                    {\n                                        \"id\": 1,\n                                        \"url\": \"https://k0u2ayecy7bycz.djvod.ndcimgs.com/upic/2023/10/31/18/BMjAyMzEwMzExODI5MTJfMjI4OTA1ODAyXzExNjE3NDE5NzU1M18yXzM=_hd15_Bfb2327ef432b8e22bee0565c052210d0.mp4?tag=1-1756664181-unknown-0-4pez7u9yx4-11bcd04505e80c93&provider=self&clientCacheKey=3xezqrk27gdc5a4_hd15.mp4&di=3da39dcf&bp=14734&x-ks-ptid=116174197553&kwai-not-alloc=self-cdn&kcdntag=p:Henan;i:ChinaUnicom;ft:UNKNOWN;h:COLD;pn:kuaishouVideoProjection&ocid=300000173&tt=hd15&ss=vpm\",\n                                        \"backupUrl\": [\n                                            \"https://v1.kwaicdn.com/ksc2/WsLapasbDJwa_d5-gSoI2EwR1RYcYI6MpzWrlOzqoBPJ1eG7TRpv8UtWiNxv2xy-tsiAXr2VvmiqAJQmxNCMawMQCe7orKomsXk6v-GJKt55XiiE9GdcOTmXM0Uj_MN1np_i8ffWmDHyxrrCfhiIKRMXGETtR5BcJTIxz5hg3BgWZAEVV8VxRcZ2PwP4phUM.mp4?pkey=AAWWdaRz9xwLglSkzE1QAdM0NoasskNdA0fRCgDJSWyTPo4tra_0jYCqgP_ieXHG4ky9vMQafXhiVaetL-iijtgENHHeQG2YMY8NxTVz_PjB8T1hTNmOXW8mQTnf2NHOa0k&tag=1-1756664181-unknown-1-0vq1m73bcl-d99c4fa7dba7dbf0&clientCacheKey=3xezqrk27gdc5a4_hd15.mp4&di=3da39dcf&bp=14734&kwai-not-alloc=0&tt=hd15&ss=vpm\"\n                                        ],\n                                        \"maxBitrate\": 3000,\n                                        \"avgBitrate\": 1622,\n                                        \"width\": 1280,\n                                        \"height\": 720,\n                                        \"frameRate\": 60.0,\n                                        \"quality\": 1.5,\n                                        \"kvqScore\": {\n                                            \"FR\": -1.0,\n                                            \"NR\": 3.4632160663604736,\n                                            \"FRPost\": -1.0,\n                                            \"NRPost\": -1.0,\n                                            \"sharpness\": 0.4285,\n                                            \"blur\": 0.2377\n                                        },\n                                        \"qualityType\": \"720p\",\n                                        \"qualityLabel\": \"高清\",\n                                        \"featureP2sp\": false,\n                                        \"p2spCode\": \"{\"fRsn\":0,\"fixOpt\":-1,\"schTask\":\"\",\"schCode\":-1,\"schRes\":\"\",\"pushTask\":\"v=0&p=0&s=0&d=0\",\"pushCode\":-1}\",\n                                        \"hidden\": false,\n                                        \"disableAdaptive\": false,\n                                        \"defaultSelect\": false,\n                                        \"comment\": \"videoId=b1a31deb8e75e7be/ttExplain=HEVC_Turbo2_720P_高码率/tt=hd15\",\n                                        \"hdrType\": 0,\n                                        \"fileSize\": 17227811,\n                                        \"agc\": false,\n                                        \"mute\": false,\n                                        \"oriLoudness\": 0.0,\n                                        \"makeupGain\": 0.0,\n                                        \"realLoudness\": -9.532,\n                                        \"realNormalizeGain\": 1.0,\n                                        \"normalizeGain\": 0.0\n                                    }\n                                ]\n                            }\n                        ],\n                        \"playInfo\": {\n                            \"bizType\": 0,\n                            \"cdnTimeRangeLevel\": 0\n                        },\n                        \"videoFeature\": {\n                            \"blurProbability\": 0.02436523512005806,\n                            \"blockyProbability\": 0.5486664772033691,\n                            \"avgEntropy\": 11.74826078414917,\n                            \"mosScore\": 0.6893717646598816\n                        }\n                    },\n                    \"photoUrls\": [\n                        {\n                            \"cdn\": \"k0u2ayecy7bycz.djvod.ndcimgs.com\",\n                            \"url\": \"https://k0u2ayecy7bycz.djvod.ndcimgs.com/upic/2023/10/31/18/BMjAyMzEwMzExODI5MTJfMjI4OTA1ODAyXzExNjE3NDE5NzU1M18yXzM=_b_Baea19a439f265123a9b5c73a99b387c9.mp4?tag=1-1756664181-unknown-0-ngtc9b5fkw-400249aac756fa3c&provider=self&clientCacheKey=3xezqrk27gdc5a4_b.mp4&di=3da39dcf&bp=14734&x-ks-ptid=116174197553&kwai-not-alloc=self-cdn&kcdntag=p:Henan;i:ChinaUnicom;ft:UNKNOWN;h:COLD;pn:kuaishouVideoProjection&ocid=300000173&tt=b&ss=vps\"\n                        },\n                        {\n                            \"cdn\": \"v2.kwaicdn.com\",\n                            \"url\": \"https://v2.kwaicdn.com/ksc2/PtGMNZW1atApoKjZtdZAeYBv_Hk3rukAMsduvp-BRuBp66aB3ZFXpDnlTON3Xy5ehrz5fc5c4ys3g0Nays7EXtftXSi7JkRjPKFMN-vbPXVZ68800hSKYaFZejJUW1GKp2ttjc9vIgAKHkCkn1E8e709mnQxJz6nzJRRixcAEvJ6PxVraa3OqiGkiA12zLt0.mp4?pkey=AAVID_YMrWOJ06oySpzkfx8i-z7z8Iyx34JyeXW13PQLMfVfPDvy1b0cEQh_2ri0Bs7F_GvTuADCNUK0SR0f0zes8DixR10HM6lJQkpQ64nHhqlVoxHkP9DQGPvgr1nZ-l4&tag=1-1756664181-unknown-1-cpfxvlhxnd-8304a252b8387036&clientCacheKey=3xezqrk27gdc5a4_b.mp4&di=3da39dcf&bp=14734&kwai-not-alloc=0&tt=b&ss=vps\"\n                        }\n                    ],\n                    \"manifest\": {\n                        \"version\": \"1.0.0\",\n                        \"businessType\": 2,\n                        \"mediaType\": 2,\n                        \"videoId\": \"b1a31deb8e75e7be\",\n                        \"hideAuto\": false,\n                        \"manualDefaultSelect\": false,\n                        \"stereoType\": 0,\n                        \"adaptationSet\": [\n                            {\n                                \"id\": 1,\n                                \"duration\": 84937,\n                                \"representation\": [\n                                    {\n                                        \"id\": 1,\n                                        \"url\": \"https://k0u2ayecy7bycz.djvod.ndcimgs.com/upic/2023/10/31/18/BMjAyMzEwMzExODI5MTJfMjI4OTA1ODAyXzExNjE3NDE5NzU1M18yXzM=_b_Baea19a439f265123a9b5c73a99b387c9.mp4?tag=1-1756664181-unknown-0-raca8mq3p7-df6cf126f2ba1979&provider=self&clientCacheKey=3xezqrk27gdc5a4_b.mp4&di=3da39dcf&bp=14734&x-ks-ptid=116174197553&kwai-not-alloc=self-cdn&kcdntag=p:Henan;i:ChinaUnicom;ft:UNKNOWN;h:COLD;pn:kuaishouVideoProjection&ocid=300000173&tt=b&ss=vpm\",\n                                        \"backupUrl\": [\n                                            \"https://v2.kwaicdn.com/ksc2/PtGMNZW1atApoKjZtdZAeYBv_Hk3rukAMsduvp-BRuBp66aB3ZFXpDnlTON3Xy5ehrz5fc5c4ys3g0Nays7EXtftXSi7JkRjPKFMN-vbPXVZ68800hSKYaFZejJUW1GKp2ttjc9vIgAKHkCkn1E8e709mnQxJz6nzJRRixcAEvJ6PxVraa3OqiGkiA12zLt0.mp4?pkey=AAUkTComC4sD_jFDy6Q8DZvnU7bttEcUKZYUyPGThMFjvLORo0aHnSv2Y7qhYldRnSBe9H1NRLi9yC1zprgWULvlD6mm7Q8pWup3vG3BabToQqpNmpHI2hwzk6m0UE-8j38&tag=1-1756664181-unknown-1-frwqzvnubq-3aeb9dc39d8958ed&clientCacheKey=3xezqrk27gdc5a4_b.mp4&di=3da39dcf&bp=14734&kwai-not-alloc=0&tt=b&ss=vpm\"\n                                        ],\n                                        \"maxBitrate\": 4900,\n                                        \"avgBitrate\": 3482,\n                                        \"width\": 1280,\n                                        \"height\": 720,\n                                        \"frameRate\": 60.0,\n                                        \"quality\": 1.5,\n                                        \"kvqScore\": {\n                                            \"FR\": -1.0,\n                                            \"NR\": 3.5491535663604736,\n                                            \"FRPost\": -1.0,\n                                            \"NRPost\": -1.0,\n                                            \"sharpness\": 0.3316,\n                                            \"blur\": 0.2374\n                                        },\n                                        \"qualityType\": \"720p\",\n                                        \"qualityLabel\": \"高清\",\n                                        \"featureP2sp\": false,\n                                        \"p2spCode\": \"{\"fRsn\":0,\"fixOpt\":-1,\"schTask\":\"\",\"schCode\":-1,\"schRes\":\"\",\"pushTask\":\"v=0&p=0&s=0&d=0\",\"pushCode\":-1}\",\n                                        \"hidden\": false,\n                                        \"disableAdaptive\": false,\n                                        \"defaultSelect\": false,\n                                        \"comment\": \"videoId=b1a31deb8e75e7be/ttExplain=AVC_VeryFast_720P_高码率_Basic/tt=b\",\n                                        \"hdrType\": 0,\n                                        \"fileSize\": 36976273,\n                                        \"bitratePattern\": [\n                                            5000,\n                                            3471,\n                                            6733,\n                                            481,\n                                            1569\n                                        ],\n                                        \"agc\": false,\n                                        \"mute\": false,\n                                        \"oriLoudness\": 0.0,\n                                        \"makeupGain\": 0.0,\n                                        \"realLoudness\": -9.532,\n                                        \"realNormalizeGain\": 1.0,\n                                        \"normalizeGain\": 0.0\n                                    }\n                                ]\n                            }\n                        ],\n                        \"playInfo\": {\n                            \"bizType\": 0,\n                            \"cdnTimeRangeLevel\": 0\n                        },\n                        \"videoFeature\": {\n                            \"blurProbability\": 0.02436523512005806,\n                            \"blockyProbability\": 0.5486664772033691,\n                            \"avgEntropy\": 11.74826078414917,\n                            \"mosScore\": 0.6893717646598816\n                        }\n                    },\n                    \"photoH265Urls\": [\n                        {\n                            \"cdn\": \"k0u2ayecy7bycz.djvod.ndcimgs.com\",\n                            \"url\": \"https://k0u2ayecy7bycz.djvod.ndcimgs.com/upic/2023/10/31/18/BMjAyMzEwMzExODI5MTJfMjI4OTA1ODAyXzExNjE3NDE5NzU1M18yXzM=_hd15_Bfb2327ef432b8e22bee0565c052210d0.mp4?tag=1-1756664181-unknown-0-ra3mc5pqwz-b5d377ade7d0a512&provider=self&clientCacheKey=3xezqrk27gdc5a4_hd15.mp4&di=3da39dcf&bp=14734&x-ks-ptid=116174197553&kwai-not-alloc=self-cdn&kcdntag=p:Henan;i:ChinaUnicom;ft:UNKNOWN;h:COLD;pn:kuaishouVideoProjection&ocid=300000173&tt=hd15&ss=vps\"\n                        },\n                        {\n                            \"cdn\": \"v1.kwaicdn.com\",\n                            \"url\": \"https://v1.kwaicdn.com/ksc2/WsLapasbDJwa_d5-gSoI2EwR1RYcYI6MpzWrlOzqoBPJ1eG7TRpv8UtWiNxv2xy-tsiAXr2VvmiqAJQmxNCMawMQCe7orKomsXk6v-GJKt55XiiE9GdcOTmXM0Uj_MN1np_i8ffWmDHyxrrCfhiIKRMXGETtR5BcJTIxz5hg3BgWZAEVV8VxRcZ2PwP4phUM.mp4?pkey=AAVktrin9oeeededNfrZf8LaIR1CvEQJ8FlSEH5iw-Azi03uiv1Eh297Xfd7f6yLLkZNDEyqFg4KqNphKlDhQmAw3TKsBqJYmLfLtR3cRWzJ5VY6FadrIRrGZvuCwgCob4A&tag=1-1756664181-unknown-1-tx8vx8qkhx-44a6a7306fccf2ff&clientCacheKey=3xezqrk27gdc5a4_hd15.mp4&di=3da39dcf&bp=14734&kwai-not-alloc=0&tt=hd15&ss=vps\"\n                        }\n                    ],\n                    \"viewCount\": 1594389,\n                    \"width\": 1280,\n                    \"id\": \"3xezqrk27gdc5a4\",\n                    \"animatedCoverUrl\": \"https://p1.a.yximgs.com/upic/2023/10/31/18/BMjAyMzEwMzExODI5MTJfMjI4OTA1ODAyXzExNjE3NDE5NzU1M18yXzM=_animatedV5_Beaaaeb032c640d38decbda1f52bc209e.webp?tag=1-1756664181-xpcwebprofile-0-tdiakvxcxz-98dff964a1098863&clientCacheKey=3xezqrk27gdc5a4_animatedV5.webp&di=3da39dcf&bp=14734\",\n                    \"overrideCoverUrl\": \"https://p1.a.yximgs.com/upic/2023/10/31/18/BMjAyMzEwMzExODI5MTJfMjI4OTA1ODAyXzExNjE3NDE5NzU1M18yXzM=_ccc_B39cbb17aaf65e0a76080064fd78dfc64.jpg?tag=1-1756664181-xpcwebprofile-0-gg941gqowe-afd116662be96449&clientCacheKey=3xezqrk27gdc5a4_ccc.jpg&di=3da39dcf&bp=14734\",\n                    \"collectCount\": 22057,\n                    \"riskTagContent\": null,\n                    \"expTag\": \"1_a/2008712974016392641_xpcwebprofilexxnull0\",\n                    \"riskTagUrl\": null,\n                    \"timestamp\": 1698748219278,\n                    \"stereoType\": 0,\n                    \"likeCount\": 75604,\n                    \"collected\": false,\n                    \"duration\": 84816,\n                    \"liked\": false,\n                    \"coverUrl\": \"https://p1.a.yximgs.com/upic/2023/10/31/18/BMjAyMzEwMzExODI5MTJfMjI4OTA1ODAyXzExNjE3NDE5NzU1M18yXzM=_ccc_B39cbb17aaf65e0a76080064fd78dfc64.jpg?tag=1-1756664181-xpcwebprofile-0-lznq3kgead-b3f7c6ea108bb5d1&clientCacheKey=3xezqrk27gdc5a4_ccc.jpg&di=3da39dcf&bp=14734\",\n                    \"caption\": \"健 身 鸭 脖\",\n                    \"height\": 720\n                },\n                \"author\": {\n                    \"id\": \"3xz63mn6fngqtiq\",\n                    \"headerUrl\": \"https://p66-pro.a.yximgs.com/uhead/AB/2025/08/11/21/BMjAyNTA4MTEyMTEyNDlfMjI4OTA1ODAyXzFfaGQ5ODdfODg4_s.jpg\",\n                    \"livingInfo\": {\n                        \"living\": false,\n                        \"livingId\": null,\n                        \"iconType\": 0\n                    },\n                    \"name\": \"权少爱吃小汉堡🍔\",\n                    \"following\": false\n                },\n                \"comment\": {\n                    \"us_c\": 0\n                },\n                \"danmakuSwitch\": true\n            }\n            },\n        ],\n        \"llsid\": \"2008712974016392641\",\n        \"host-name\": \"public-bjx-c26-kce-node642.idchb1az1.hb1.kwaidc.com\",\n        \"webPageArea\": \"profilexxnull\"\n    }\n}\n```","operationId":"fetch_user_post_api_v1_kuaishou_web_fetch_user_post_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","title":"用户 ID (eid)/User ID (eid)"},"example":"3xz63mn6fngqtiq"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"作品游标/Post cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_user_live_replay":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取用户直播回放/Fetch user live replay","description":"# [中文]\n### 用途:\n- 获取用户直播回放列表\n### 参数:\n- user_id: 用户ID，这个接口需要传入用户的 eid，可以从用户主页链接中提取\n- 例如：https://www.kuaishou.com/profile/3xz63mn6fngqtiq 其中 3xz63mn6fngqtiq 即为用户的 eid\n- 备注：不支持使用uid也就是纯数字的用户ID查询\n- pcursor: 作品游标，第一次请求为空，后续请求使用返回响应中的pcursor值进行翻页。\n### 返回:\n- 用户直播回放列表\n\n# [English]\n### Purpose:\n- Fetch user live replay\n- Note: This API requires the user's eid, which can be extracted from the user's profile URL.\n- For example: In the URL https://www.kuaishou.com/profile/3xz63mn6fngqtiq, the eid is 3xz63mn6fngqtiq.\n- Note: Querying with uid (pure numeric user ID) is not supported.\n### Parameters:\n- user_id: User ID\n- pcursor: Post cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests.\n### Returns:\n- User live replay list\n\n# [示例/Example]\nuser_id = \"3xz63mn6fngqtiq\"\npcursor = None\n\n# [返回示例/Example Response]\n```json\n\n```","operationId":"fetch_user_live_replay_api_v1_kuaishou_web_fetch_user_live_replay_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","title":"用户 ID (eid)/User ID (eid)"},"example":"3xz63mn6fngqtiq"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"作品游标/Post cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_user_collect":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取用户收藏作品/Fetch user collect","description":"# [中文]\n### 用途:\n- 获取用户收藏作品\n### 参数:\n- user_id: 用户ID，这个接口需要传入用户的 eid，可以从用户主页链接中提取\n- 例如：https://www.kuaishou.com/profile/3xz63mn6fngqtiq 其中 3xz63mn6fngqtiq 即为用户的 eid\n- 备注：不支持使用uid也就是纯数字的用户ID查询\n- pcursor: 作品游标，第一次请求为空，后续请求使用返回响应中的pcursor值进行翻页。\n### 返回:\n- 用户收藏作品列表\n\n# [English]\n### Purpose:\n- Fetch user favorite\n- Note: This API requires the user's eid, which can be extracted from the user's profile URL.\n- For example: In the URL https://www.kuaishou.com/profile/3xz63mn6fngqtiq, the eid is 3xz63mn6fngqtiq.\n- Note: Querying with uid (pure numeric user ID) is not supported.\n### Parameters:\n- user_id: User ID\n- pcursor: Post cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests.\n### Returns:\n- User favorite list\n\n# [示例/Example]\nuser_id = \"3xz63mn6fngqtiq\"\npcursor = None\n\n# [返回示例/Example Response]\n```json\n\n```","operationId":"fetch_user_collect_api_v1_kuaishou_web_fetch_user_collect_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","title":"用户 ID (eid)/User ID (eid)"},"example":"3xz63mn6fngqtiq"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"作品游标/Post cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_kuaishou_hot_list_v1":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取快手热榜 V1/Fetch Kuaishou Hot List V1","description":"# [中文]\n### 用途:\n- 获取快手热榜 V1\n### 参数:\n- 无\n### 返回:\n- 快手热榜 V1 列表\n\n# [English]\n### Purpose:\n- Fetch Kuaishou Hot List V1\n### Parameters:\n- None\n### Returns:\n- Kuaishou Hot List V1\n\n# [示例/Example]\n\n# [返回示例/Example Response]\n```json\n\n```","operationId":"fetch_kuaishou_hot_list_v1_api_v1_kuaishou_web_fetch_kuaishou_hot_list_v1_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/kuaishou/web/fetch_kuaishou_hot_list_v2":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取快手热榜 V2/Fetch Kuaishou Hot List V2","description":"# [中文]\n### 用途:\n- 获取快手热榜 V2\n### 参数:\n- board_type 榜单类型，默认值为 1:\n    1 - 热榜\n    2 - 文娱\n    3 - 社会\n    4 - 有用\n    5 - 挑战\n    6 - 搜索\n### 返回:\n- 快手热榜 V2 列表\n\n# [English]\n### Purpose:\n- Fetch Kuaishou Hot List V2\n### Parameters:\n- board_type: Board Type, default is 1:\n    1 - Hot List\n    2 - Entertainment\n    3 - Society\n    4 - Useful\n    5 - Challenge\n    6 - Search\n### Returns:\n- Kuaishou Hot List V2\n\n# [示例/Example]\n\n# [返回示例/Example Response]\n```json\n\n```","operationId":"fetch_kuaishou_hot_list_v2_api_v1_kuaishou_web_fetch_kuaishou_hot_list_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"board_type","in":"query","required":false,"schema":{"type":"string","title":"榜单类型 (board_type)/Board Type","default":"1"},"example":"1"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/web/fetch_get_user_id":{"get":{"tags":["Kuaishou-Web-API"],"summary":"获取用户ID/Fetch user ID","description":"# [中文]\n### 用途:\n- 通过用户分享链接获取用户ID\n### 参数:\n- share_link: 用户分享链接\n### 返回:\n- 用户ID\n\n# [English]\n### Purpose:\n- Fetch user ID via user share link\n### Parameters:\n- share_link: User share link\n### Returns:\n- User ID\n\n# [示例/Example]\nshare_link = \"https://v.kuaishou.com/KcdKDwFp\"\n\nshare_link = \"https://c.kuaishou.com/fw/user/3xcuu5habgc8z29\"\n\nshare_link = \"https://live.kuaishou.com/profile/3xcuu5habgc8z29?fid=2357689552&cc=share_copylink\"\n\n# [返回示例/Example Response]\n```json\n```","operationId":"fetch_get_user_id_api_v1_kuaishou_web_fetch_get_user_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_link","in":"query","required":true,"schema":{"type":"string","title":"用户分享链接/User Share Link"},"example":"https://v.kuaishou.com/KcdKDwFp"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_one_video":{"get":{"tags":["Kuaishou-App-API"],"summary":"视频详情V1/Video detailsV1","description":"# [中文]\n### 用途:\n- 获取单个作品数据接口 V1。\n### 参数:\n- photo_id: 作品ID，作品ID可以从分享链接中提取\n    - 格式备注：支持纯数字版本的ID，也支持短字符串版本（eID）的ID，两种ID可以混合使用。\n### 返回:\n- 视频数据\n\n# [English]\n### Purpose:\n- Fetch single video data API V1.\n### Parameters:\n- photo_id: Photo ID, the photo ID can be extracted from the share link\n    - Format note: Supports both pure digital version IDs and short string version (eID) IDs, both types can be mixed.\n### Returns:\n- Video data\n\n# [示例/Example]\nphoto_id = \"3xhpk3xcf6e4iac\"\nphoto_id = \"5246975215478907538\"","operationId":"fetch_one_video_v1_api_v1_kuaishou_app_fetch_one_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"photo_id","in":"query","required":true,"schema":{"type":"string","title":"作品ID/Photo ID"},"example":"3xhpk3xcf6e4iac"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_videos_batch":{"get":{"tags":["Kuaishou-App-API"],"summary":"快手批量视频查询接口/Kuaishou batch video query API","description":"# [中文]\n### 用途:\n- 批量获取多个作品数据，单次请求最多支持40个视频ID。\n- 如果此接口连续请求失败，可以尝试使用价格更昂贵的V2接口进行冗余请求。\n- 此接口收费标准默认为：40 * 0.001 = 0.04 美元/次。\n### 参数:\n- photo_ids: 作品ID列表，多个ID用英文逗号分隔，单次最多40个\n    - 格式备注：支持纯数字版本的ID，也支持短字符串版本（eID）的ID，两种ID可以混合使用。\n### 返回:\n- 视频数据列表\n\n# [English]\n### Purpose:\n- Batch fetch multiple video data, supports up to 40 video IDs per request.\n- If this API continuously fails, you can try to use the more expensive V2 API for redundant requests.\n- The default charging standard for this API is: 40 * 0.001 = 0.04 USD/time.\n### Parameters:\n- photo_ids: Photo ID list, multiple IDs separated by commas, max 40 per request\n    - Format note: Supports both pure digital version IDs and short string version (eID) IDs, both types can be mixed.\n### Returns:\n- Video data list\n\n# [示例/Example]\nphoto_ids = \"5228960823332207296,5196309727975443273,5222486898325987583\"","operationId":"fetch_videos_batch_api_v1_kuaishou_app_fetch_videos_batch_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"photo_ids","in":"query","required":true,"schema":{"type":"string","title":"作品ID列表(逗号分隔)/Photo ID list (comma separated)","description":"多个作品ID用逗号分隔，单次最多40个/Multiple photo IDs separated by commas, max 40 per request"},"description":"多个作品ID用逗号分隔，单次最多40个/Multiple photo IDs separated by commas, max 40 per request","example":"5228960823332207296,5196309727975443273,5222486898325987583"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_one_video_by_url":{"get":{"tags":["Kuaishou-App-API"],"summary":"根据链接获取单个作品数据/Fetch single video by URL","description":"# [中文]\n### 用途:\n- 根据链接获取单个作品数据，此接口默认使用价格更便宜的V1接口进行请求。\n### 参数:\n- share_text: 作品链接或分享文本\n### 返回:\n- 视频数据\n\n# [English]\n### Purpose:\n- Fetch single video by URL, this API defaults to using the cheaper V1 API for requests.\n### Parameters:\n- share_text: Photo URL or share text\n### Returns:\n- Video data\n\n# [示例/Example]\nshare_text = \"https://v.kuaishou.com/cNYP0Z\"","operationId":"fetch_one_video_by_share_text_api_v1_kuaishou_app_fetch_one_video_by_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_text","in":"query","required":true,"schema":{"type":"string","title":"作品链接/Photo URL"},"example":"https://v.kuaishou.com/cNYP0Z"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_one_video_comment":{"get":{"tags":["Kuaishou-App-API"],"summary":"获取单个作品评论数据/Get single video comment data","description":"# [中文]\n### 用途:\n- 获取单个作品评论数据\n### 参数:\n- photo_id: 作品ID\n    - 格式备注：支持纯数字版本的ID，也支持短字符串版本（eID）的ID，两种ID可以混合使用。\n- pcursor: 评论游标，第一次请求为空，后续请求使用返回响应中的pcursor值进行翻页。\n### 返回:\n- 评论数据\n\n# [English]\n### Purpose:\n- Fetch single video comment data\n### Parameters:\n- photo_id: Photo ID\n    - Format note: Supports both pure digital version IDs and short string version (eID) IDs, both types can be mixed.\n- pcursor: Comment cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests.\n### Returns:\n- Comments data\n\n# [示例/Example]\nphoto_id = \"3x7gxp2zhgjv832\"\npcursor = None","operationId":"fetch_video_comment_api_v1_kuaishou_app_fetch_one_video_comment_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"photo_id","in":"query","required":true,"schema":{"type":"string","title":"作品ID/Photo ID"},"example":"3x7gxp2zhgjv832"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"评论游标/Comment cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_one_user_v2":{"get":{"tags":["Kuaishou-App-API"],"summary":"获取单个用户数据V2/Get single user data V2","description":"# [中文]\n### 用途:\n- 获取单个用户数据 V2\n- 此接口收费较贵，但稳定性更高，具体价格请在用户后台查看价格表。\n### 参数:\n- user_id: 支持`eid`或`userId`，eid是用户主页链接中的一部分，user_id则可以从不同的接口中获取。\n- 两种用户ID都可以使用，下面是两种用户ID的示例，这两个ID都指向同一个用户：\n    - eid = \"3xz63mn6fngqtiq\"\n    - userId = \"228905802\"\n### 返回:\n- 用户数据\n\n# [English]\n### Purpose:\n- Fetch single user data V2\n- This API is more expensive, but more stable, please check the price list in the user background for specific prices.\n### Parameters:\n- user_id: Supports `eid` or `userId`, `eid` is part of the user profile link, and `user_id` can be obtained from different interfaces.\n- Both user IDs can be used, here are examples of the two user IDs, both of which point to the same user:\n    - eid = \"3xz63mn6fngqtiq\"\n    - userId = \"228905802\"\n### Returns:\n- User data\n\n# [示例/Example]\nuser_id = \"3xz63mn6fngqtiq\"","operationId":"fetch_one_user_v2_api_v1_kuaishou_app_fetch_one_user_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","title":"用户ID/User ID"},"example":"3xz63mn6fngqtiq"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_user_live_info":{"get":{"tags":["Kuaishou-App-API"],"summary":"获取用户直播信息/Get user live info","description":"# [中文]\n### 用途:\n- 获取用户直播信息\n### 参数:\n- user_id: 用户ID，此接口只支持用户ID，不支持用户eid，也就是输入必须要是纯数字ID。\n- user_id 可以从获取单个用户数据接口中获取。\n### 返回:\n- 直播信息\n\n# [English]\n### Purpose:\n- Get user live info\n### Parameters:\n- user_id: User ID, this API only supports user ID, not user eid, that is, the input must be a pure digital ID.\n- user_id can be obtained from the get single user data interface.\n### Returns:\n- Live info\n\n# [示例/Example]\nuser_id = \"1377082950\"","operationId":"fetch_user_live_info_api_v1_kuaishou_app_fetch_user_live_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","title":"用户ID/User ID"},"example":"1377082950"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_user_hot_post":{"get":{"tags":["Kuaishou-App-API"],"summary":"获取用户热门作品数据/Get user hot post data","description":"# [中文]\n### 用途:\n- 获取用户热门作品数据\n### 参数:\n- user_id: 用户ID，此接口只支持用户ID，不支持用户eid，也就是输入必须要是纯数字ID。\n- user_id 可以从获取单个用户数据接口中获取。\n- pcursor: 作品游标，第一次请求为空，后续请求使用返回响应中的pcursor值进行翻页。\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get user hot post data\n### Parameters:\n- user_id: User ID, this API only supports user ID, not user eid, that is, the input must be a pure digital ID.\n- user_id can be obtained from the get single user data interface.\n- pcursor: Post cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests.\n### Returns:\n- Post data\n\n# [示例/Example]\nuser_id = \"228905802\"\npcursor = None","operationId":"fetch_user_hot_post_api_v1_kuaishou_app_fetch_user_hot_post_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","title":"用户ID/User ID"},"example":"228905802"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"作品游标/Post cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_user_post_v2":{"get":{"tags":["Kuaishou-App-API"],"summary":"用户视频列表V2/User video list V2","description":"# [中文]\n### 用途:\n- 用户视频列表 V2\n- 此接口收费较贵，但稳定性更高，具体价格请在用户后台查看价格表。\n### 参数:\n- user_id: 用户ID，此接口只支持用户ID，不支持用户eid，也就是输入必须要是纯数字ID。\n- user_id 可以从获取单个用户数据接口中获取。\n- pcursor: 视频游标，第一次请求为空，后续请求使用返回响应中的pcursor值进行翻页。\n### 返回:\n- 视频数据\n\n# [English]\n### Purpose:\n- User video list V2\n- This API is more expensive, but more stable, please check the price list in the user background for specific prices.\n### Parameters:\n- user_id: User ID, this API only supports user ID, not user eid, that is, the input must be a pure digital ID.\n- user_id can be obtained from the get single user data interface.\n- pcursor: Video cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests.\n### Returns:\n- Videos data\n\n# [示例/Example]\nuser_id = \"903511772\"\npcursor = None","operationId":"fetch_user_post_v2_api_v1_kuaishou_app_fetch_user_post_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","title":"用户ID/User ID"},"example":"903511772"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"视频游标/Video cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/search_comprehensive":{"get":{"tags":["Kuaishou-App-API"],"summary":"综合搜索/Comprehensive search","description":"# [中文]\n### 用途:\n- 快手综合搜索接口，支持搜索视频、用户等内容，并提供多维度筛选功能。\n### 参数:\n- keyword: 搜索关键词（必填）\n- pcursor: 分页游标，首次请求为空，后续使用响应中的pcursor值\n- sort_type: 排序方式\n    - all: 综合排序（默认）\n    - newest: 最新发布\n    - most_likes: 最多点赞\n- publish_time: 发布时间筛选\n    - all: 全部时间（默认）\n    - one_day: 近一日\n    - one_week: 近一周\n    - one_month: 近一月\n- duration: 作品时长筛选\n    - all: 全部时长（默认）\n    - under_1_min: 1分钟以内\n    - 1_to_5_min: 1-5分钟\n    - over_5_min: 5分钟以上\n- search_scope: 搜索范围\n    - all: 全部（默认）\n### 返回:\n- 搜索结果数据\n\n# [English]\n### Purpose:\n- Kuaishou comprehensive search API, supports searching videos, users, etc., and provides multi-dimensional filtering.\n### Parameters:\n- keyword: Search keyword (required)\n- pcursor: Pagination cursor, empty for first request, use pcursor from response for subsequent pages\n- sort_type: Sort type\n    - all: Comprehensive sort (default)\n    - newest: Latest release\n    - most_likes: Most likes\n- publish_time: Publish time filter\n    - all: All time (default)\n    - one_day: Last day\n    - one_week: Last week\n    - one_month: Last month\n- duration: Duration filter\n    - all: All duration (default)\n    - under_1_min: Under 1 minute\n    - 1_to_5_min: 1-5 minutes\n    - over_5_min: Over 5 minutes\n- search_scope: Search scope\n    - all: All (default)\n### Returns:\n- Search result data\n\n# [示例/Example]\nkeyword = \"汽车之家\"\nsort_type = \"most_likes\"\npublish_time = \"one_week\"","operationId":"search_comprehensive_api_v1_kuaishou_app_search_comprehensive_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","title":"搜索关键词/Search keyword"},"example":"汽车之家"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"分页游标/Pagination cursor"}},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","title":"排序方式/Sort type","description":"可选值: all(综合排序), newest(最新发布), most_likes(最多点赞)","default":"all"},"description":"可选值: all(综合排序), newest(最新发布), most_likes(最多点赞)"},{"name":"publish_time","in":"query","required":false,"schema":{"type":"string","title":"发布时间/Publish time","description":"可选值: all(全部), one_day(近一日), one_week(近一周), one_month(近一月)","default":"all"},"description":"可选值: all(全部), one_day(近一日), one_week(近一周), one_month(近一月)"},{"name":"duration","in":"query","required":false,"schema":{"type":"string","title":"作品时长/Duration","description":"可选值: all(全部), under_1_min(1分钟以内), 1_to_5_min(1-5分钟), over_5_min(5分钟以上)","default":"all"},"description":"可选值: all(全部), under_1_min(1分钟以内), 1_to_5_min(1-5分钟), over_5_min(5分钟以上)"},{"name":"search_scope","in":"query","required":false,"schema":{"type":"string","title":"搜索范围/Search scope","description":"可选值: all(全部)","default":"all"},"description":"可选值: all(全部)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/search_video_v2":{"get":{"tags":["Kuaishou-App-API"],"summary":"搜索视频V2/Search video V2","description":"# [中文]\n### 用途:\n- 搜索视频 V2\n- 此接口收费较贵，但稳定性更高，具体价格请在用户后台查看价格表。\n### 参数:\n- keyword: 搜索关键词\n- page: 视频页数，从1开始\n### 返回:\n- 视频数据\n\n# [English]\n### Purpose:\n- Search video V2\n- This API is more expensive, but more stable, please check the price list in the user background for specific prices.\n### Parameters:\n- keyword: Search keyword\n- page: Page number, starting from 1\n### Returns:\n- Videos data\n\n# [示例/Example]\nkeyword = \"人工智能\"\npage = \"1\"","operationId":"search_video_v2_api_v1_kuaishou_app_search_video_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","title":"搜索关键词/Search keyword"},"example":"人工智能"},{"name":"page","in":"query","required":false,"schema":{"type":"string","title":"视频页数，从1开始/Page number, starting from 1","default":"1"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/search_user_v2":{"get":{"tags":["Kuaishou-App-API"],"summary":"搜索用户V2/Search user V2","description":"# [中文]\n### 用途:\n- 搜索用户 V2\n- 此接口收费较贵，但稳定性更高，具体价格请在用户后台查看价格表。\n### 参数:\n- keyword: 搜索关键词\n- page: 用户页数，从1开始\n### 返回:\n- 用户数据\n\n# [English]\n### Purpose:\n- Search user V2\n- This API is more expensive, but more stable, please check the price list in the user background for specific prices.\n### Parameters:\n- keyword: Search keyword\n- page: User page number, starting from 1\n### Returns:\n- User data\n\n# [示例/Example]\nkeyword = \"人工智能\"\npage = \"1\"","operationId":"search_user_v2_api_v1_kuaishou_app_search_user_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","title":"搜索关键词/Search keyword"},"example":"人工智能"},{"name":"page","in":"query","required":false,"schema":{"type":"string","title":"用户页数，从1开始/User page number, starting from 1","default":"1"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_hot_board_categories":{"get":{"tags":["Kuaishou-App-API"],"summary":"快手热榜分类/Kuaishou hot categories","description":"# [中文]\n### 用途:\n- 快手热榜分类\n### 返回:\n- 分类数据\n\n# [English]\n### Purpose:\n- Kuaishou hot categories\n### Returns:\n- Categories data","operationId":"fetch_hot_board_categories_api_v1_kuaishou_app_fetch_hot_board_categories_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/kuaishou/app/fetch_hot_board_detail":{"get":{"tags":["Kuaishou-App-API"],"summary":"快手热榜详情/Kuaishou hot board detail","description":"# [中文]\n### 用途:\n- 快手热榜详情\n### 参数:\n- boardType: 榜单类型\n- boardId: 榜单ID\n- boardType 和 boardId 可以从热榜分类接口中获取。\n### 返回:\n- 详情数据\n\n# [English]\n### Purpose:\n- Kuaishou hot board detail\n### Parameters:\n- boardType: Board type\n- boardId: Board ID\n- boardType and boardId can be obtained from the hot board categories interface.\n### Returns:\n- Detail data\n\n# [示例/Example]\nboardType = 1\nboardId = 1","operationId":"fetch_hot_board_detail_api_v1_kuaishou_app_fetch_hot_board_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"boardType","in":"query","required":false,"schema":{"type":"integer","title":"榜单类型/Board type","default":1}},{"name":"boardId","in":"query","required":false,"schema":{"type":"integer","title":"榜单ID/Board ID","default":"1"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_hot_search_person":{"get":{"tags":["Kuaishou-App-API"],"summary":"快手热搜人物榜单/Kuaishou hot search person board","description":"# [中文]\n### 用途:\n- 快手热搜人物榜单\n### 返回:\n- 榜单数据\n\n# [English]\n### Purpose:\n- Kuaishou hot search person board\n### Returns:\n- Board data","operationId":"fetch_hot_search_person_api_v1_kuaishou_app_fetch_hot_search_person_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/kuaishou/app/fetch_live_top_list":{"get":{"tags":["Kuaishou-App-API"],"summary":"快手直播榜单/Kuaishou live top list","description":"# [中文]\n### 用途:\n- 快手直播榜单\n### 参数:\n获取快手直播榜单，支持多个子榜单，具体参数如下：\n\n- 直播总榜对应参数：\n    - subTabId = 0\n    - subTabName = None\n- 直播音乐榜对应参数：\n    - subTabId = 102\n    - subTabName = \"音乐\"\n- 直播舞蹈榜对应参数：\n    - subTabId = 107\n    - subTabName = \"舞蹈\"\n- 直播颜值榜对应参数：\n    - subTabId = 101\n    - subTabName = \"颜值\"\n- 直播国艺榜对应参数：\n    - subTabId = 105\n    - subTabName = \"国艺\"\n- 直播相亲榜对应参数：\n    - subTabId = 111\n    - subTabName = \"相亲\"\n- 直播游戏榜对应参数：\n    - subTabId = 106\n    - subTabName = \"游戏\"\n- 直播二次元榜对应参数：\n    - subTabId = 110\n    - subTabName = \"二次元\"\n- 直播故事榜对应参数：\n    - subTabId = 104\n    - subTabName = \"故事\"\n- 直播团播榜对应参数：\n    - subTabId = 113\n    - subTabName = \"团播\"\n- 直播九宫格榜对应参数：\n    - subTabId = 114\n    - subTabName = \"九宫格\"\n\n### 返回:\n- 榜单数据\n\n# [English]\n### Purpose:\n- Kuaishou live top list\n### Parameters:\nGet the Kuaishou live top list, support multiple sub-top lists, specific parameters are as follows:\n\n- Corresponding parameters for the live total list:\n    - subTabId = 0\n    - subTabName = None\n- Corresponding parameters for the live music list:\n    - subTabId = 102\n    - subTabName = \"Music\"\n- Corresponding parameters for the live dance list:\n    - subTabId = 107\n    - subTabName = \"Dance\"\n- Corresponding parameters for the live beauty list:\n    - subTabId = 101\n    - subTabName = \"Beauty\"\n- Corresponding parameters for the live national art list:\n    - subTabId = 105\n    - subTabName = \"National Art\"\n- Corresponding parameters for the live blind date list:\n    - subTabId = 111\n    - subTabName = \"Blind Date\"\n- Corresponding parameters for the live game list:\n    - subTabId = 106\n    - subTabName = \"Game\"\n- Corresponding parameters for the live second element list:\n    - subTabId = 110\n    - subTabName = \"Second Element\"\n- Corresponding parameters for the live story list:\n    - subTabId = 104\n    - subTabName = \"Story\"\n- Corresponding parameters for the live group broadcast list:\n    - subTabId = 113\n    - subTabName = \"Group Broadcast\"\n- Corresponding parameters for the live nine-grid list:\n    - subTabId = 114\n    - subTabName = \"Nine Grid\"\n\n### Returns:\n- List data\n\n# [示例/Example]\nsubTabId = 0\nsubTabName = None","operationId":"fetch_live_top_list_api_v1_kuaishou_app_fetch_live_top_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subTabId","in":"query","required":false,"schema":{"type":"integer","title":"子标签ID/Sub tag ID","default":0}},{"name":"subTabName","in":"query","required":false,"schema":{"type":"string","title":"子标签名称/Sub tag name","default":""}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_shopping_top_list":{"get":{"tags":["Kuaishou-App-API"],"summary":"快手购物榜单/Kuaishou shopping top list","description":"# [中文]\n### 用途:\n- 快手购物榜单\n### 参数:\n获取快手购物榜单，支持多个子榜单，具体参数如下：\n\n- 购物榜单热门主播榜对应参数：\n    - subTabId = 0\n    - subTabName = None\n- 购物榜单热销商品榜对应参数：\n    - subTabId = 102\n    - subTabName = \"热销商品\"\n\n### 返回:\n- 榜单数据\n\n# [English]\n### Purpose:\n- Kuaishou shopping top list\n### Parameters:\nGet the Kuaishou shopping top list, support multiple sub-top lists, specific parameters are as follows:\n\n- Corresponding parameters for the shopping hot anchor list:\n    - subTabId = 0\n    - subTabName = None\n- Corresponding parameters for the shopping hot selling product list:\n    - subTabId = 102\n    - subTabName = \"Hot Selling Product\"\n\n### Returns:\n- List data\n\n# [示例/Example]\nsubTabId = 0\nsubTabName = None","operationId":"fetch_shopping_top_list_api_v1_kuaishou_app_fetch_shopping_top_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subTabId","in":"query","required":false,"schema":{"type":"integer","title":"子标签ID/Sub tag ID","default":0}},{"name":"subTabName","in":"query","required":false,"schema":{"type":"string","title":"子标签名称/Sub tag name","default":""}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_brand_top_list":{"get":{"tags":["Kuaishou-App-API"],"summary":"快手品牌榜单/Kuaishou brand top list","description":"# [中文]\n### 用途:\n- 快手品牌榜单\n### 参数:\n获取快手品牌榜单，支持多个子榜单，具体参数如下：\n\n- 品牌榜单热门美妆榜对应参数：\n    - subTabId = 0\n    - subTabName = None\n- 品牌榜单热门服饰榜对应参数：\n    - subTabId = 131\n    - subTabName = \"服饰\"\n- 品牌榜单热门汽车榜对应参数：\n    - subTabId = 1\n    - subTabName = \"汽车\"\n- 品牌榜单热门游戏榜对应参数：\n    - subTabId = 25\n    - subTabName = \"游戏\"\n- 品牌榜单热门医疗健康榜对应参数：\n    - subTabId = 24\n    - subTabName = \"医疗健康\"\n- 品牌榜单热门3C数码榜对应参数：\n    - subTabId = 130\n    - subTabName = \"3C数码\"\n- 品牌榜单热门手机榜对应参数：\n    - subTabId = 128\n    - subTabName = \"手机\"\n- 品牌榜单热门家电榜对应参数：\n    - subTabId = 11\n    - subTabName = \"家电\"\n- 品牌榜单热门母婴榜对应参数：\n    - subTabId = 4\n    - subTabName = \"母婴\"\n- 品牌榜单热门食品饮料榜对应参数：\n    - subTabId = 2\n    - subTabName = \"食品饮料\"\n\n### 返回:\n- 榜单数据\n\n# [English]\n### Purpose:\n- Kuaishou brand top list\n### Parameters:\nGet the Kuaishou brand top list, support multiple sub-top lists, specific parameters are as follows:\n\n- Corresponding parameters for the brand hot beauty list:\n    - subTabId = 0\n    - subTabName = None\n- Corresponding parameters for the brand hot clothing list:\n    - subTabId = 131\n    - subTabName = \"Clothing\"\n- Corresponding parameters for the brand hot car list:\n    - subTabId = 1\n    - subTabName = \"Car\"\n- Corresponding parameters for the brand hot game list:\n    - subTabId = 25\n    - subTabName = \"Game\"\n- Corresponding parameters for the brand hot medical health list:\n    - subTabId = 24\n    - subTabName = \"Medical Health\"\n- Corresponding parameters for the brand hot 3C digital list:\n    - subTabId = 130\n    - subTabName = \"3C Digital\"\n- Corresponding parameters for the brand hot mobile phone list:\n    - subTabId = 128\n    - subTabName = \"Mobile Phone\"\n- Corresponding parameters for the brand hot home appliance list:\n    - subTabId = 11\n    - subTabName = \"Home Appliance\"\n- Corresponding parameters for the brand hot maternal and child list:\n    - subTabId = 4\n    - subTabName = \"Maternal and Child\"\n- Corresponding parameters for the brand hot food and beverage list:\n    - subTabId = 2\n    - subTabName = \"Food and Beverage\"\n\n\n### Returns:\n- List data\n\n# [示例/Example]\nsubTabId = 0\nsubTabName = None","operationId":"fetch_brand_top_list_api_v1_kuaishou_app_fetch_brand_top_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subTabId","in":"query","required":false,"schema":{"type":"integer","title":"子标签ID/Sub tag ID","default":0}},{"name":"subTabName","in":"query","required":false,"schema":{"type":"string","title":"子标签名称/Sub tag name","default":""}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/generate_kuaishou_share_link":{"get":{"tags":["Kuaishou-App-API"],"summary":"生成快手分享链接/Generate Kuaishou share link","description":"# [中文]\n### 用途:\n- 生成快手分享链接\n### 参数:\n- shareObjectId: 作品ID\n### 返回:\n- 分享链接\n\n# [English]\n### Purpose:\n- Generate Kuaishou share link\n### Parameters:\n- photo_id: Photo ID\n### Returns:\n- Share link\n\n# [示例/Example]\nshareObjectId = \"3xg5wjqdtekbb3u\"","operationId":"generate_kuaishou_share_link_api_v1_kuaishou_app_generate_kuaishou_share_link_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"shareObjectId","in":"query","required":true,"schema":{"type":"string","title":"作品ID/Photo ID"},"example":"3xg5wjqdtekbb3u"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_magic_face_usage":{"get":{"tags":["Kuaishou-App-API"],"summary":"获取魔法表情使用人数/Fetch magic face usage count","description":"# [中文]\n### 用途:\n- 获取快手魔法表情使用人数（H5接口）\n### 参数:\n- magic_face_id: 魔法表情ID\n### 返回:\n- 魔法表情使用人数\n\n# [English]\n### Purpose:\n- Fetch Kuaishou magic face usage count (H5 API)\n### Parameters:\n- magic_face_id: Magic face ID\n### Returns:\n- Magic face usage count\n\n# [示例/Example]\nmagic_face_id = \"11541661\"","operationId":"fetch_magic_face_usage_api_v1_kuaishou_app_fetch_magic_face_usage_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"magic_face_id","in":"query","required":true,"schema":{"type":"string","title":"魔法表情ID/Magic Face ID"},"example":"11541661"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kuaishou/app/fetch_magic_face_hot":{"get":{"tags":["Kuaishou-App-API"],"summary":"获取魔法表情热门视频/Fetch magic face hot videos","description":"# [中文]\n### 用途:\n- 获取快手魔法表情热门视频列表（H5接口）\n### 参数:\n- magic_face_id: 魔法表情ID\n- pcursor: 分页游标，首页为\"0\"，后续使用响应中返回的pcursor值\n- count: 每页数量，默认18\n### 返回:\n- 魔法表情热门视频列表\n\n# [English]\n### Purpose:\n- Fetch Kuaishou magic face hot videos list (H5 API)\n### Parameters:\n- magic_face_id: Magic face ID\n- pcursor: Pagination cursor, \"0\" for first page, use pcursor from response for subsequent pages\n- count: Count per page, default 18\n### Returns:\n- Magic face hot videos list\n\n# [示例/Example]\nmagic_face_id = \"11541661\"\npcursor = \"0\"\ncount = 18","operationId":"fetch_magic_face_hot_api_v1_kuaishou_app_fetch_magic_face_hot_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"magic_face_id","in":"query","required":true,"schema":{"type":"string","title":"魔法表情ID/Magic Face ID"},"example":"11541661"},{"name":"pcursor","in":"query","required":false,"schema":{"type":"string","title":"分页游标/Pagination cursor","default":"0"},"example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","title":"每页数量/Count per page","default":18},"example":18}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_column_articles":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎专栏文章列表/Get Zhihu Column Articles","description":"# [中文]\n### 用途:\n- 获取知乎专栏文章列表\n### 参数:\n- column_id: 专栏ID\n- limit: 每页文章数量\n- offset: 偏移量\n### 返回:\n- 知乎专栏文章列表\n\n# [English]\n### Purpose:\n- Get Zhihu Column Articles\n### Parameters:\n- column_id: Column ID\n- limit: Number of articles per page\n- offset: Offset\n### Returns:\n- Zhihu Column Articles\n\n# [示例/Example]\ncolumn_id = \"zhangjiawei\"\nlimit = \"10\"\noffset = \"0\"","operationId":"fetch_column_articles_api_v1_zhihu_web_fetch_column_articles_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"column_id","in":"query","required":true,"schema":{"type":"string","description":"专栏ID/Column ID","title":"Column Id"},"description":"专栏ID/Column ID"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页文章数量/Number of articles per page","default":"10","title":"Limit"},"description":"每页文章数量/Number of articles per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_column_article_detail":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎专栏文章详情/Get Zhihu Column Article Detail","description":"# [中文]\n### 用途:\n- 获取知乎专栏文章详情\n### 参数:\n- article_id: 文章ID\n### 返回:\n- 知乎专栏文章详情\n\n# [English]\n### Purpose:\n- Get Zhihu Column Article Detail\n### Parameters:\n- article_id: Article ID\n### Returns:\n- Zhihu Column Article Detail\n\n# [示例/Example]\narticle_id = \"669214677\"","operationId":"fetch_column_article_detail_api_v1_zhihu_web_fetch_column_article_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"article_id","in":"query","required":true,"schema":{"type":"string","description":"文章ID/Article ID","title":"Article Id"},"description":"文章ID/Article ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_column_recommend":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎相似专栏推荐/Get Zhihu Similar Column Recommend","description":"# [中文]\n### 用途:\n- 获取知乎相似专栏推荐\n### 参数:\n- article_id: 文章ID\n- limit: 每页专栏数量\n- offset: 偏移量\n### 返回:\n- 知乎相似专栏推荐\n\n# [English]\n### Purpose:\n- Get Zhihu Similar Column Recommend\n### Parameters:\n- article_id: Article ID\n- limit: Number of columns per page\n- offset: Offset\n### Returns:\n- Zhihu Similar Column Recommend\n\n# [示例/Example]\narticle_id = \"669214677\"\nlimit = \"12\"\noffset = \"0\"","operationId":"fetch_column_recommend_api_v1_zhihu_web_fetch_column_recommend_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"article_id","in":"query","required":true,"schema":{"type":"string","description":"文章ID/Article ID","title":"Article Id"},"description":"文章ID/Article ID"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页专栏数量/Number of columns per page","default":"12","title":"Limit"},"description":"每页专栏数量/Number of columns per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_column_relationship":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎专栏文章互动关系/Get Zhihu Column Article Relationship","description":"# [中文]\n### 用途:\n- 获取知乎专栏文章互动关系\n### 参数:\n- article_id: 文章ID\n### 返回:\n- 知乎专栏互动关系\n\n# [English]\n### Purpose:\n- Get Zhihu Column Relationship\n### Parameters:\n- article_id: Article ID\n### Returns:\n- Zhihu Column Relationship\n\n# [示例/Example]\narticle_id = \"669214677\"","operationId":"fetch_column_relationship_api_v1_zhihu_web_fetch_column_relationship_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"article_id","in":"query","required":true,"schema":{"type":"string","description":"文章ID/Article ID","title":"Article Id"},"description":"文章ID/Article ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_column_comment_config":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎专栏评论区配置/Get Zhihu Column Comment Config","description":"# [中文]\n### 用途:\n- 获取知乎专栏评论区配置\n### 参数:\n- article_id: 文章ID\n### 返回:\n- 知乎专栏评论区配置\n\n# [English]\n### Purpose:\n- Get Zhihu Column Comment Config\n### Parameters:\n- article_id: Article ID\n### Returns:\n- Zhihu Column Comment Config\n\n# [示例/Example]\narticle_id = \"669214677\"","operationId":"fetch_column_comment_config_api_v1_zhihu_web_fetch_column_comment_config_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"article_id","in":"query","required":true,"schema":{"type":"string","description":"文章ID/Article ID","title":"Article Id"},"description":"文章ID/Article ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_hot_recommend":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎首页推荐/Get Zhihu Hot Recommend","description":"# [中文]\n### 用途:\n- 获取知乎首页推荐\n### 参数:\n- offset: 偏移量\n- page_number: 页码\n- session_token: 会话令牌\n### 返回:\n- 知乎首页推荐\n\n# [English]\n### Purpose:\n- Get Zhihu Hot Recommend\n### Parameters:\n- offset: Offset\n- page_number: Page Number\n- session_token: Session Token\n\n# [示例/Example]\noffset = \"0\"\npage_number = \"1\"\nsession_token = \"\"","operationId":"fetch_hot_recommend_api_v1_zhihu_web_fetch_hot_recommend_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"page_number","in":"query","required":false,"schema":{"type":"string","description":"页码/Page Number","default":"1","title":"Page Number"},"description":"页码/Page Number"},{"name":"session_token","in":"query","required":false,"schema":{"type":"string","description":"会话令牌/Session Token","default":"","title":"Session Token"},"description":"会话令牌/Session Token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_hot_list":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎首页热榜/Get Zhihu Hot List","description":"# [中文]\n### 用途:\n- 获取知乎首页热榜\n### 参数:\n- limit: 每页文章数量\n- desktop: 是否为桌面端\n### 返回:\n- 知乎首页热榜\n\n# [English]\n### Purpose:\n- Get Zhihu Hot List\n### Parameters:\n- limit: Number of articles per page\n- desktop: Is it a desktop\n### Returns:\n- Zhihu Hot List\n\n# [示例/Example]\nlimit = \"50\"\ndesktop = \"true\"","operationId":"fetch_hot_list_api_v1_zhihu_web_fetch_hot_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页文章数量/Number of articles per page","default":"50","title":"Limit"},"description":"每页文章数量/Number of articles per page"},{"name":"desktop","in":"query","required":false,"schema":{"type":"string","description":"是否为桌面端/Is it a desktop","default":"true","title":"Desktop"},"description":"是否为桌面端/Is it a desktop"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_video_list":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎首页视频榜/Get Zhihu Video List","description":"# [中文]\n### 用途:\n- 获取知乎首页视频榜\n### 参数:\n- offset: 偏移量\n- limit: 每页视频数量\n### 返回:\n- 知乎首页视频榜\n\n# [English]\n### Purpose:\n- Get Zhihu Video List\n### Parameters:\n- offset: Offset\n- limit: Number of videos per page\n### Returns:\n- Zhihu Video List\n\n# [示例/Example]\noffset = \"\"\nlimit = \"12\"","operationId":"fetch_video_list_api_v1_zhihu_web_fetch_video_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页视频数量/Number of videos per page","default":"12","title":"Limit"},"description":"每页视频数量/Number of videos per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_article_search_v3":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎文章搜索V3/Get Zhihu Article Search V3","description":"# [中文]\n### 用途:\n- 获取知乎文章搜索V3\n### 参数:\n- keyword: 搜索关键词\n- offset: 偏移量\n- limit: 每页文章数量\n- show_all_topics: 显示所有主题，\n    - 0 不显示话题\n    - 1 显示话题\n- search_source: 搜索来源\n    - Filter 过滤参数生效\n    - Normal 为普通结果\n- search_hash_id: 搜索哈希ID，用于过滤重复搜索结果\n- vertical: 空 不限类型\n    - answer 只看回答\n    - article 只看文章\n    - zvideo 只看视频\n- sort: 空 综合排序\n    - upvoted_count 最多赞同\n    - created_time 最新发布\n- time_interval: 时间间隔\n    - 空 不限时间\n    - a_day 一天内\n    - a_week 一周内\n    - a_month 一个月内\n    - three_months 三个月内\n    - half_a_year 半年内\n    - a_year 一年内\n- vertical_info: 垂类信息\n    - 0,0,0,0,0,0,0,0,0,0,0,0 不限类型，不会设置勿填\n### 返回:\n- 知乎文章搜索V3\n\n# [English]\n### Purpose:\n- Get Zhihu Article Search V3\n### Parameters:\n- keyword: Search Keywords\n- offset: Offset\n- limit: Number of articles per page\n- show_all_topics: Show all topics\n    - 0 Do not show topics\n    - 1 Show topics\n- search_source: Search Source\n    - Filter parameter takes effect\n    - Normal is normal result\n- search_hash_id: Search Hash ID, used to filter duplicate search results\n- vertical: Empty unlimited type\n    - answer only see answers\n    - article only see articles\n    - zvideo only see videos\n- sort: Empty comprehensive sorting\n    - upvoted_count most upvoted\n    - created_time latest release\n- time_interval: Time interval\n    - Empty unlimited time\n    - a_day within a day\n    - a_week within a week\n    - a_month within a month\n    - three_months within three months\n    - half_a_year within half a year\n    - a_year within a year\n- vertical_info: Vertical information\n    - 0,0,0,0,0,0,0,0,0,0,0,0 unlimited type, do not set do not fill\n### Returns:\n- Zhihu Article Search V3\n\n# [示例/Example]\n# 默认搜索，综合排序，不限时间\nkeyword = \"deepseek\"\noffset = \"0\"\nlimit = \"20\"\nshow_all_topics = 0\nsearch_source = \"Normal\"\nsearch_hash_id = \"\"\nvertical = \"\"\nsort = \"\"\ntime_interval = \"\"\nvertical_info = \"\"\n\n# 只看回答，最多赞同，三月内\nkeyword = \"deepseek\"\noffset = \"0\"\nlimit = \"20\"\nshow_all_topics = 0\nsearch_source = \"Filter\"\nsearch_hash_id = \"\"\nvertical = \"answer\"\nsort = \"upvoted_count\"\ntime_interval = \"three_months\"\nvertical_info = \"0,0,0,0,0,0,0,0,0,0,0,0\"","operationId":"fetch_article_search_v3_api_v1_zhihu_web_fetch_article_search_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search Keywords","title":"Keyword"},"description":"搜索关键词/Search Keywords"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页文章数量/Number of articles per page","default":"20","title":"Limit"},"description":"每页文章数量/Number of articles per page"},{"name":"show_all_topics","in":"query","required":false,"schema":{"type":"integer","description":"显示所有主题/Show all topics","default":0,"title":"Show All Topics"},"description":"显示所有主题/Show all topics"},{"name":"search_source","in":"query","required":false,"schema":{"type":"string","description":"搜索来源/Search Source","default":"Normal","title":"Search Source"},"description":"搜索来源/Search Source"},{"name":"search_hash_id","in":"query","required":false,"schema":{"type":"string","description":"搜索哈希ID/Search Hash ID","default":"","title":"Search Hash Id"},"description":"搜索哈希ID/Search Hash ID"},{"name":"vertical","in":"query","required":false,"schema":{"type":"string","description":"垂类/Vertical Type","default":"","title":"Vertical"},"description":"垂类/Vertical Type"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序/Sort","default":"","title":"Sort"},"description":"排序/Sort"},{"name":"time_interval","in":"query","required":false,"schema":{"type":"string","description":"时间间隔/Time Interval","default":"","title":"Time Interval"},"description":"时间间隔/Time Interval"},{"name":"vertical_info","in":"query","required":false,"schema":{"type":"string","description":"垂类信息/Vertical Info","default":"","title":"Vertical Info"},"description":"垂类信息/Vertical Info"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_search_v3":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户搜索V3/Get Zhihu User Search V3","description":"# [中文]\n### 用途:\n- 获取知乎用户搜索V3\n### 参数:\n- keyword: 搜索关键词\n- offset: 偏移量\n- limit: 每页用户数量\n### 返回:\n- 知乎用户搜索V3\n\n# [English]\n### Purpose:\n- Get Zhihu User Search V3\n### Parameters:\n- keyword: Search Keywords\n- offset: Offset\n- limit: Number of users per page\n### Returns:\n- Zhihu User Search V3\n\n# [示例/Example]\nkeyword = \"deepseek\"\noffset = \"0\"\nlimit = \"25\"","operationId":"fetch_user_search_v3_api_v1_zhihu_web_fetch_user_search_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search Keywords","title":"Keyword"},"description":"搜索关键词/Search Keywords"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页用户数量/Number of users per page","default":"25","title":"Limit"},"description":"每页用户数量/Number of users per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_topic_search_v3":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎话题搜索V3/Get Zhihu Topic Search V3","description":"# [中文]\n### 用途:\n- 获取知乎话题搜索V3\n### 参数:\n- keyword: 搜索关键词\n- offset: 偏移量\n- limit: 每页话题数量\n### 返回:\n- 知乎话题搜索V3\n\n# [English]\n### Purpose:\n- Get Zhihu Topic Search V3\n### Parameters:\n- keyword: Search Keywords\n- offset: Offset\n- limit: Number of topics per page\n### Returns:\n- Zhihu Topic Search V3\n\n# [示例/Example]\nkeyword = \"deepseek\"\noffset = \"0\"\nlimit = \"25\"","operationId":"fetch_topic_search_v3_api_v1_zhihu_web_fetch_topic_search_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search Keywords","title":"Keyword"},"description":"搜索关键词/Search Keywords"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页话题数量/Number of topics per page","default":"25","title":"Limit"},"description":"每页话题数量/Number of topics per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_scholar_search_v3":{"post":{"tags":["Zhihu-Web-API"],"summary":"获取知乎论文搜索V3/Get Zhihu Scholar Search V3","description":"# [中文]\n### 用途:\n- 获取知乎论文搜索V3\n### 参数:\n- keyword: 搜索关键词\n- offset: 偏移量\n- limit: 每页论文数量\n- filter_fields: 过滤字段\n### 返回:\n- 知乎论文搜索V3\n\n# [English]\n### Purpose:\n- Get Zhihu Scholar Search V3\n### Parameters:\n- keyword: Search Keywords\n- offset: Offset\n- limit: Number of papers per page\n- filter_fields: Filter Fields\n### Returns:\n- Zhihu Scholar Search V3\n\n# [示例/Example]\nkeyword = \"人工智能\"\noffset = \"0\"\nlimit = \"25\"","operationId":"fetch_scholar_search_v3_api_v1_zhihu_web_fetch_scholar_search_v3_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search Keywords","title":"Keyword"},"description":"搜索关键词/Search Keywords"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页论文数量/Number of papers per page","default":"25","title":"Limit"},"description":"每页论文数量/Number of papers per page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"description":"过滤字段/Filter Fields","default":{"advanced_filter":"keywords,title,authors,abstract","indexed_by":"","classification":""},"title":"Filter Fields"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_ai_search":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎AI搜索/Get Zhihu AI Search","description":"# [中文]\n### 用途:\n- 获取知乎AI搜索\n### 参数:\n- message_content: 搜索内容\n### 返回:\n- 知乎AI搜索消息ID，用于请求搜索结果\n\n# [English]\n### Purpose:\n- Get Zhihu AI Search\n### Parameters:\n- message_content: Search Content\n### Returns:\n- Zhihu AI Search Message ID for requesting search results\n\n# [示例/Example]\nmessage_content = \"deepseek\"","operationId":"fetch_ai_search_api_v1_zhihu_web_fetch_ai_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"message_content","in":"query","required":true,"schema":{"type":"string","description":"搜索内容/Search Content","title":"Message Content"},"description":"搜索内容/Search Content"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_ai_search_result":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎AI搜索结果/Get Zhihu AI Search Result","description":"# [中文]\n### 用途:\n- 获取知乎AI搜索结果\n### 参数:\n- message_id: 消息ID\n### 返回:\n- 知乎AI搜索结果\n\n# [English]\n### Purpose:\n- Get Zhihu AI Search Result\n### Parameters:\n- message_id: Message ID\n### Returns:\n- Zhihu AI Search Result\n\n# [示例/Example]\nmessage_id = \"5f8b4f4a-0b7c-4d1b-8c4f-2e5c0d6c1b9d\"","operationId":"fetch_ai_search_result_api_v1_zhihu_web_fetch_ai_search_result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"message_id","in":"query","required":true,"schema":{"type":"string","description":"消息ID/Message ID","title":"Message Id"},"description":"消息ID/Message ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_video_search_v3":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎视频搜索V3/Get Zhihu Video Search V3","description":"# [中文]\n### 用途:\n- 获取知乎视频搜索V3\n### 参数:\n- keyword: 搜索关键词\n- limit: 每页视频数量\n- offset: 偏移量\n- search_hash_id: 搜索哈希ID\n### 返回:\n- 知乎视频搜索V3\n\n# [English]\n### Purpose:\n- Get Zhihu Video Search V3\n### Parameters:\n- keyword: Search Keywords\n- limit: Number of videos per page\n- offset: Offset\n- search_hash_id: Search Hash ID\n### Returns:\n- Zhihu Video Search V3\n\n# [示例/Example]\nkeyword = \"deepseek\"\nlimit = \"20\"\noffset = \"0\"\nsearch_hash_id = \"\"","operationId":"fetch_video_search_v3_api_v1_zhihu_web_fetch_video_search_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search Keywords","title":"Keyword"},"description":"搜索关键词/Search Keywords"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页视频数量/Number of videos per page","default":"20","title":"Limit"},"description":"每页视频数量/Number of videos per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"search_hash_id","in":"query","required":false,"schema":{"type":"string","description":"搜索哈希ID/Search Hash ID","default":"","title":"Search Hash Id"},"description":"搜索哈希ID/Search Hash ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_column_search_v3":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎专栏搜索V3/Get Zhihu Column Search V3","description":"# [中文]\n### 用途:\n- 获取知乎专栏搜索V3\n### 参数:\n- keyword: 搜索关键词\n- offset: 偏移量\n- limit: 每页专栏数量\n- search_hash_id: 搜索哈希ID\n### 返回:\n- 知乎专栏搜索V3\n\n# [English]\n### Purpose:\n- Get Zhihu Column Search V3\n### Parameters:\n- keyword: Search Keywords\n- offset: Offset\n- limit: Number of columns per page\n- search_hash_id: Search Hash ID\n### Returns:\n- Zhihu Column Search V3\n\n# [示例/Example]\nkeyword = \"deepseek\"\nlimit = \"20\"\noffset = \"0\"\nsearch_hash_id = \"\"","operationId":"fetch_column_search_v3_api_v1_zhihu_web_fetch_column_search_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search Keywords","title":"Keyword"},"description":"搜索关键词/Search Keywords"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页专栏数量/Number of columns per page","default":"20","title":"Limit"},"description":"每页专栏数量/Number of columns per page"},{"name":"search_hash_id","in":"query","required":false,"schema":{"type":"string","description":"搜索哈希ID/Search Hash ID","default":"","title":"Search Hash Id"},"description":"搜索哈希ID/Search Hash ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_salt_search_v3":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎盐选内容搜索V3/Get Zhihu Salt Search V3","description":"# [中文]\n### 用途:\n- 获取知乎盐选内容搜索V3\n### 参数:\n- keyword: 搜索关键词\n- offset: 偏移量\n- limit: 每页内容数量\n- search_hash_id: 搜索哈希ID\n### 返回:\n- 知乎盐选内容搜索V3\n\n# [English]\n### Purpose:\n- Get Zhihu Salt Search V3\n### Parameters:\n- keyword: Search Keywords\n- offset: Offset\n- limit: Number of contents per page\n- search_hash_id: Search Hash ID\n### Returns:\n- Zhihu Salt Search V3\n\n# [示例/Example]\nkeyword = \"deepseek\"\nlimit = \"20\"\noffset = \"0\"\nsearch_hash_id = \"\"","operationId":"fetch_salt_search_v3_api_v1_zhihu_web_fetch_salt_search_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search Keywords","title":"Keyword"},"description":"搜索关键词/Search Keywords"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页内容数量/Number of contents per page","default":"20","title":"Limit"},"description":"每页内容数量/Number of contents per page"},{"name":"search_hash_id","in":"query","required":false,"schema":{"type":"string","description":"搜索哈希ID/Search Hash ID","default":"","title":"Search Hash Id"},"description":"搜索哈希ID/Search Hash ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_ebook_search_v3":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎电子书搜索V3/Get Zhihu Ebook Search V3","description":"# [中文]\n### 用途:\n- 获取知乎电子书搜索V3\n### 参数:\n- keyword: 搜索关键词\n- offset: 偏移量\n- limit: 每页电子书数量\n- search_hash_id: 搜索哈希ID\n### 返回:\n- 知乎电子书搜索V3\n\n# [English]\n### Purpose:\n- Get Zhihu Ebook Search V3\n### Parameters:\n- keyword: Search Keywords\n- offset: Offset\n- limit: Number of ebooks per page\n- search_hash_id: Search Hash ID\n### Returns:\n- Zhihu Ebook Search V3\n\n# [示例/Example]\nkeyword = \"deepseek\"\nlimit = \"20\"\noffset = \"0\"\nsearch_hash_id = \"\"","operationId":"fetch_ebook_search_v3_api_v1_zhihu_web_fetch_ebook_search_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search Keywords","title":"Keyword"},"description":"搜索关键词/Search Keywords"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页电子书数量/Number of ebooks per page","default":"20","title":"Limit"},"description":"每页电子书数量/Number of ebooks per page"},{"name":"search_hash_id","in":"query","required":false,"schema":{"type":"string","description":"搜索哈希ID/Search Hash ID","default":"","title":"Search Hash Id"},"description":"搜索哈希ID/Search Hash ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_preset_search":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎搜索预设词/Get Zhihu Preset Search","description":"# [中文]\n### 用途:\n- 获取知乎搜索预设词\n### 参数:\n- 无\n### 返回:\n- 知乎搜索预设词\n\n# [English]\n### Purpose:\n- Get Zhihu Preset Search\n### Parameters:\n- None\n### Returns:\n- Zhihu Preset Search","operationId":"fetch_preset_search_api_v1_zhihu_web_fetch_preset_search_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/zhihu/web/fetch_search_recommend":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎搜索发现/Get Zhihu Search Recommend","description":"# [中文]\n### 用途:\n- 获取知乎搜索发现\n### 参数:\n- 无\n### 返回:\n- 知乎搜索发现\n\n# [English]\n### Purpose:\n- Get Zhihu Search Recommend\n### Parameters:\n- None\n### Returns:\n- Zhihu Search Recommend","operationId":"fetch_search_recommend_api_v1_zhihu_web_fetch_search_recommend_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/zhihu/web/fetch_search_suggest":{"get":{"tags":["Zhihu-Web-API"],"summary":"知乎搜索预测词/Get Zhihu Search Suggest","description":"# [中文]\n### 用途:\n- 知乎搜索预测词\n### 参数:\n- keyword: 搜索关键词\n### 返回:\n- 知乎搜索预测词\n\n# [English]\n### Purpose:\n- Get Zhihu Search Suggest\n### Parameters:\n- keyword: Search Keywords\n### Returns:\n- Zhihu Search Suggest\n\n# [示例/Example]\nkeyword = \"deepseek\"","operationId":"fetch_search_suggest_api_v1_zhihu_web_fetch_search_suggest_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search Keywords","title":"Keyword"},"description":"搜索关键词/Search Keywords"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_comment_v5":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎评论区V5/Get Zhihu Comment V5","description":"# [中文]\n### 用途:\n- 获取知乎评论区V5\n### 参数:\n- answer_id: 回答ID\n- order_by: 排序\n    - score 最热排序\n    - ts 最新排序\n- limit: 每页评论数量\n- offset: 偏移量/页码\n### 返回:\n- 知乎评论区V5\n\n# [English]\n### Purpose:\n- Get Zhihu Comment V5\n### Parameters:\n- answer_id: Answer ID\n- order_by: Sort\n    - score Hottest Sort\n    - ts Latest Sort\n- limit: Number of comments per page\n- offset: Offset/Page Number\n### Returns:\n- Zhihu Comment V5\n\n# [示例/Example]\nanswer_id = \"89226347214\"\norder_by = \"score\"\nlimit = \"20\"\noffset = \"\" # 1739257701_11108372663_0","operationId":"fetch_comment_v5_api_v1_zhihu_web_fetch_comment_v5_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"answer_id","in":"query","required":true,"schema":{"type":"string","description":"回答ID/Answer ID","title":"Answer Id"},"description":"回答ID/Answer ID"},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"排序/Sort","default":"score","title":"Order By"},"description":"排序/Sort"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页评论数量/Number of comments per page","default":"20","title":"Limit"},"description":"每页评论数量/Number of comments per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"","title":"Offset"},"description":"偏移量/Offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_sub_comment_v5":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎子评论区V5/Get Zhihu Sub Comment V5","description":"# [中文]\n### 用途:\n- 获取知乎子评论区V5\n### 参数:\n- comment_id: 评论ID\n- order_by: 排序\n    - score 最热排序\n    - ts 最新排序\n- limit: 每页评论数量\n- offset: 偏移量/页码\n### 返回:\n- 知乎子评论区V5\n\n# [English]\n### Purpose:\n- Get Zhihu Sub Comment V5\n### Parameters:\n- comment_id: Comment ID\n- order_by: Sort\n    - score Hottest Sort\n    - ts Latest Sort\n- limit: Number of comments per page\n- offset: Offset/Page Number\n### Returns:\n- Zhihu Sub Comment V5\n\n# [示例/Example]\ncomment_id = \"11100789728\"\norder_by = \"score\"\nlimit = \"20\"\noffset = \"\"","operationId":"fetch_sub_comment_v5_api_v1_zhihu_web_fetch_sub_comment_v5_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论ID/Comment ID","title":"Comment Id"},"description":"评论ID/Comment ID"},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"排序/Sort","default":"score","title":"Order By"},"description":"排序/Sort"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页评论数量/Number of comments per page","default":"20","title":"Limit"},"description":"每页评论数量/Number of comments per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"","title":"Offset"},"description":"偏移量/Offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_info":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户信息/Get Zhihu User Info","description":"# [中文]\n### 用途:\n- 获取知乎用户信息\n### 参数:\n- user_url_token: 用户ID\n### 返回:\n- 知乎用户信息\n\n# [English]\n### Purpose:\n- Get Zhihu User Info\n### Parameters:\n- user_url_token: User ID\n### Returns:\n- Zhihu User Info\n\n# [示例/Example]\nuser_url_token = \"ming-he-43-93\"","operationId":"fetch_user_info_api_v1_zhihu_web_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_url_token","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Url Token"},"description":"用户ID/User ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_followees":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户关注列表/Get Zhihu User Following","description":"# [中文]\n### 用途:\n- 获取知乎用户关注列表\n### 参数:\n- user_url_token: 用户ID\n- offset: 偏移量\n- limit: 每页用户数量\n### 返回:\n- 知乎用户关注列表\n\n# [English]\n### Purpose:\n- Get Zhihu User Following\n### Parameters:\n- user_url_token: User ID\n- offset: Offset\n- limit: Number of users per page\n### Returns:\n- Zhihu User Following\n\n# [示例/Example]\nuser_url_token = \"ming-he-43-93\"\noffset = \"0\"\nlimit = \"20\"","operationId":"fetch_user_followees_api_v1_zhihu_web_fetch_user_followees_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_url_token","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Url Token"},"description":"用户ID/User ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页用户数量/Number of users per page","default":"20","title":"Limit"},"description":"每页用户数量/Number of users per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_followers":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户粉丝列表/Get Zhihu User Followers","description":"# [中文]\n### 用途:\n- 获取知乎用户粉丝列表\n### 参数:\n- user_url_token: 用户ID\n- offset: 偏移量\n- limit: 每页用户数量\n### 返回:\n- 知乎用户粉丝列表\n\n# [English]\n### Purpose:\n- Get Zhihu User Followers\n### Parameters:\n- user_url_token: User ID\n- offset: Offset\n- limit: Number of users per page\n### Returns:\n- Zhihu User Followers\n\n# [示例/Example]\nuser_url_token = \"ming-he-43-93\"\noffset = \"0\"\nlimit = \"20\"","operationId":"fetch_user_followers_api_v1_zhihu_web_fetch_user_followers_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_url_token","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Url Token"},"description":"用户ID/User ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页用户数量/Number of users per page","default":"20","title":"Limit"},"description":"每页用户数量/Number of users per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_articles":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户的文章列表/Get Zhihu User Articles","description":"# [中文]\n### 用途:\n- 获取知乎用户的文章列表\n### 参数:\n- user_url_token: 用户ID\n- offset: 偏移量\n- limit: 每页文章数量\n- sort_type: 排序类型\n    - created 按发布时间排序\n    - voteups 按点赞数排序\n### 返回:\n- 知乎用户的文章列表\n\n# [English]\n### Purpose:\n- Get Zhihu User Articles\n### Parameters:\n- user_url_token: User ID\n- offset: Offset\n- limit: Number of articles per page\n- sort_type: Sort Type\n    - created Sort by creation time\n    - voteups Sort by vote ups\n### Returns:\n- Zhihu User Articles\n\n# [示例/Example]\nuser_url_token = \"ming-he-43-93\"\noffset = \"0\"\nlimit = \"20\"\nsort_type = \"created\"","operationId":"fetch_user_articles_api_v1_zhihu_web_fetch_user_articles_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_url_token","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Url Token"},"description":"用户ID/User ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页文章数量/Number of articles per page","default":"20","title":"Limit"},"description":"每页文章数量/Number of articles per page"},{"name":"sort_type","in":"query","required":false,"schema":{"enum":["created","voteups"],"type":"string","description":"排序类型/Sort Type","default":"created","title":"Sort Type"},"description":"排序类型/Sort Type"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_included_articles":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户的被收录文章列表/Get Zhihu User Included Articles","description":"# [中文]\n### 用途:\n- 获取知乎用户的被收录文章列表\n### 参数:\n- user_url_token: 用户ID\n- offset: 偏移量\n- limit: 每页文章数量\n### 返回:\n- 知乎用户的被收录文章列表\n\n# [English]\n### Purpose:\n- Get Zhihu User Included Articles\n### Parameters:\n- user_url_token: User ID\n- offset: Offset\n- limit: Number of articles per page\n### Returns:\n- Zhihu User Included Articles\n\n# [示例/Example]\nuser_url_token = \"jzwa\"\noffset = \"0\"\nlimit = \"20\"","operationId":"fetch_user_included_articles_api_v1_zhihu_web_fetch_user_included_articles_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_url_token","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Url Token"},"description":"用户ID/User ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页文章数量/Number of articles per page","default":"20","title":"Limit"},"description":"每页文章数量/Number of articles per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_follow_columns":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户订阅的专栏/Get Zhihu User Columns","description":"# [中文]\n### 用途:\n- 获取知乎用户订阅的专栏\n### 参数:\n- user_url_token: 用户ID\n- offset: 偏移量\n- limit: 每页专栏数量\n### 返回:\n- 知乎用户订阅的专栏\n\n# [English]\n### Purpose:\n- Get Zhihu User Columns\n### Parameters:\n- user_url_token: User ID\n- offset: Offset\n- limit: Number of columns per page\n### Returns:\n- Zhihu User Columns\n\n# [示例/Example]\nuser_url_token = \"ming-he-43-93\"\noffset = \"0\"\nlimit = \"20\"","operationId":"fetch_user_follow_columns_api_v1_zhihu_web_fetch_user_follow_columns_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_url_token","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Url Token"},"description":"用户ID/User ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页专栏数量/Number of columns per page","default":"20","title":"Limit"},"description":"每页专栏数量/Number of columns per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_follow_questions":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户关注的问题/Get Zhihu User Follow Questions","description":"# [中文]\n### 用途:\n- 获取知乎用户关注的问题\n### 参数:\n- user_url_token: 用户ID\n- offset: 偏移量\n- limit: 每页问题数量\n### 返回:\n- 知乎用户关注的问题\n\n# [English]\n### Purpose:\n- Get Zhihu User Follow Questions\n### Parameters:\n- user_url_token: User ID\n- offset: Offset\n- limit: Number of questions per page\n### Returns:\n- Zhihu User Follow Questions\n\n# [示例/Example]\nuser_url_token = \"ming-he-43-93\"\noffset = \"0\"\nlimit = \"20\"","operationId":"fetch_user_follow_questions_api_v1_zhihu_web_fetch_user_follow_questions_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_url_token","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Url Token"},"description":"用户ID/User ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页问题数量/Number of questions per page","default":"20","title":"Limit"},"description":"每页问题数量/Number of questions per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_follow_collections":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户关注的收藏/Get Zhihu User Follow Collections","description":"# [中文]\n### 用途:\n- 获取知乎用户关注的收藏\n### 参数:\n- user_url_token: 用户ID\n- offset: 偏移量\n- limit: 每页收藏数量\n### 返回:\n- 知乎用户关注的收藏\n\n# [English]\n### Purpose:\n- Get Zhihu User Follow Collections\n### Parameters:\n- user_url_token: User ID\n- offset: Offset\n- limit: Number of collections per page\n### Returns:\n- Zhihu User Follow Collections\n\n# [示例/Example]\nuser_url_token = \"ming-he-43-93\"\noffset = \"0\"\nlimit = \"20\"","operationId":"fetch_user_follow_collections_api_v1_zhihu_web_fetch_user_follow_collections_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_url_token","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Url Token"},"description":"用户ID/User ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页收藏数量/Number of collections per page","default":"20","title":"Limit"},"description":"每页收藏数量/Number of collections per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_user_follow_topics":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎用户关注的话题/Get Zhihu User Follow Topics","description":"# [中文]\n### 用途:\n- 获取知乎用户关注的话题\n### 参数:\n- user_url_token: 用户ID\n- offset: 偏移量\n- limit: 每页话题数量\n### 返回:\n- 知乎用户关注的话题\n\n# [English]\n### Purpose:\n- Get Zhihu User Follow Topics\n### Parameters:\n- user_url_token: User ID\n- offset: Offset\n- limit: Number of topics per page\n### Returns:\n- Zhihu User Follow Topics\n\n# [示例/Example]\nuser_url_token = \"ming-he-43-93\"\noffset = \"0\"\nlimit = \"20\"","operationId":"fetch_user_follow_topics_api_v1_zhihu_web_fetch_user_follow_topics_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_url_token","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Url Token"},"description":"用户ID/User ID"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"string","description":"每页话题数量/Number of topics per page","default":"20","title":"Limit"},"description":"每页话题数量/Number of topics per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/zhihu/web/fetch_recommend_followees":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎推荐关注列表/Get Zhihu Recommend Followees","description":"# [中文]\n### 用途:\n- 获取知乎推荐关注列表\n### 参数:\n- 无\n### 返回:\n- 知乎推荐关注列表\n\n# [English]\n### Purpose:\n- Get Zhihu Recommend Followees\n### Parameters:\n- None\n### Returns:\n- Zhihu Recommend Followees","operationId":"fetch_recommend_followees_api_v1_zhihu_web_fetch_recommend_followees_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/zhihu/web/fetch_question_answers":{"get":{"tags":["Zhihu-Web-API"],"summary":"获取知乎问题回答列表/Get Zhihu Question Answers","description":"# [中文]\n### 用途:\n- 获取知乎问题的回答列表\n### 参数:\n- question_id: 问题ID\n- cursor: 分页游标，用于获取下一页数据，从返回的字段里提取\n- limit: 每页回答数量，默认5\n- offset: 偏移量，默认0\n- order: 排序方式，default=默认排序，updated=按时间排序\n- session_id: 会话ID，用于分页时保持状态，从返回的字段里提取\n### 返回:\n- 知乎问题回答列表数据\n\n# [English]\n### Purpose:\n- Get Zhihu Question Answers List\n### Parameters:\n- question_id: Question ID\n- cursor: Pagination cursor for next page, extracted from response fields\n- limit: Number of answers per page, default 5\n- offset: Offset, default 0\n- order: Sort order, default=default sort, updated=sort by time\n- session_id: Session ID for pagination state, extracted from response fields\n### Returns:\n- Zhihu Question Answers List Data\n\n# [示例/Example]\nquestion_id = \"37811449\"\ncursor = \"\"\nlimit = 5\noffset = 0\norder = \"default\"  # 或 \"updated\" 按时间排序\nsession_id = \"\"\n\n# 获取下一页 (Get next page):\ncursor = \"d88f09569eba20b966bcf15076977430\"\noffset = 1\nsession_id = \"1757928778451769939\"\n\n# 按时间排序 (Sort by time):\norder = \"updated\"","operationId":"fetch_question_answers_api_v1_zhihu_web_fetch_question_answers_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"question_id","in":"query","required":true,"schema":{"type":"string","description":"问题ID/Question ID","title":"Question Id"},"description":"问题ID/Question ID"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor","default":"","title":"Cursor"},"description":"分页游标/Pagination cursor"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"每页回答数量/Number of answers per page","default":5,"title":"Limit"},"description":"每页回答数量/Number of answers per page"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","description":"偏移量/Offset","default":0,"title":"Offset"},"description":"偏移量/Offset"},{"name":"order","in":"query","required":false,"schema":{"type":"string","description":"排序方式：default=默认排序，updated=按时间排序/Sort order: default=default sort, updated=sort by time","default":"default","title":"Order"},"description":"排序方式：default=默认排序，updated=按时间排序/Sort order: default=default sort, updated=sort by time"},{"name":"session_id","in":"query","required":false,"schema":{"type":"string","description":"会话ID/Session ID","default":"","title":"Session Id"},"description":"会话ID/Session ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_post_detail":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取单个作品数据/Get single video data","description":"# [中文]\n### 用途:\n- 获取单个作品数据，支持图文、视频等。\n### 参数:\n- cell_id: 作品id，可以从分享链接中获取。\n- cell_type: 作品类型，1为视频，多大数保持默认值即可。\n### 返回:\n- 作品数据\n\n# [English]\n### Purpose:\n- Get single video data, support photo, video, etc.\n### Parameters:\n- cell_id: AKA video id, can be obtained from the share link.\n- cell_type: Video type, 1 for video, keep the default value for other types.\n### Return:\n- Video data\n\n# [示例/Example]\ncell_id = \"7411193113223371043\"","operationId":"fetch_post_detail_api_v1_pipixia_app_fetch_post_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cell_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Cell Id"},"description":"作品id/Video id","example":"7411193113223371043"},{"name":"cell_type","in":"query","required":false,"schema":{"type":"integer","description":"作品类型/Video type","default":1,"title":"Cell Type"},"description":"作品类型/Video type","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_increase_post_view_count":{"get":{"tags":["PiPiXia-App-API"],"summary":"增加作品浏览数/Increase post view count","description":"# [中文]\n### 用途:\n- 增加作品浏览数。\n### 参数:\n- cell_id: 作品id，可以从分享链接中获取。\n- cell_type: 作品类型，1为视频，多大数保持默认值即可。\n### 返回:\n- 执行结果\n\n# [English]\n### Purpose:\n- Increase post view count.\n### Parameters:\n- cell_id: AKA video id, can be obtained from the share link.\n- cell_type: Video type, 1 for video, keep the default value for other types.\n### Return:\n- Execution result\n\n# [示例/Example]\ncell_id = \"7411193113223371043\"\ncell_type = 1","operationId":"fetch_increase_post_view_count_api_v1_pipixia_app_fetch_increase_post_view_count_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cell_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Cell Id"},"description":"作品id/Video id","example":"7411193113223371043"},{"name":"cell_type","in":"query","required":false,"schema":{"type":"integer","description":"作品类型/Video type","default":1,"title":"Cell Type"},"description":"作品类型/Video type","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_post_statistics":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取作品统计数据/Get post statistics","description":"# [中文]\n### 用途:\n- 获取单个作品的统计数据，如点赞数、评论数、转发数等。\n### 参数:\n- cell_id: 作品id，可以从分享链接中获取。\n### 返回:\n- 作品统计数据\n\n# [English]\n### Purpose:\n- Get the statistics of a single post, such as the number of likes, comments, reposts, etc.\n### Parameters:\n- cell_id: AKA video id, can be obtained from the share link.\n### Return:\n- Post statistics\n\n# [示例/Example]\ncell_id = \"7411193113223371043\"","operationId":"fetch_post_statistics_api_v1_pipixia_app_fetch_post_statistics_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cell_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Cell Id"},"description":"作品id/Video id","example":"7411193113223371043"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_user_info":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取用户信息/Get user information","description":"# [中文]\n### 用途:\n- 获取用户信息，如昵称、性别、头像等。\n### 参数:\n- user_id: 用户id，可以从分享链接中获取。\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get user information, such as nickname and avatar.\n### Parameters:\n- user_id: AKA user id, can be obtained from the share link.\n### Return:\n- User information\n\n# [示例/Example]\nuser_id = \"1310254082831248\"","operationId":"fetch_user_info_api_v1_pipixia_app_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"User Id"},"description":"用户id/User id","example":"1020401"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_user_post_list":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取用户作品列表/Get user post list","description":"# [中文]\n### 用途:\n- 获取用户作品列表，如视频、图文等。\n### 参数:\n- user_id: 用户id，可以从分享链接中获取。\n- cursor: 翻页游标，默认为0，后续页码从上一页返回的 `loadmore_cursor` Key中获取对应值。\n- feed_count: 翻页数量，默认为0，后续每次翻页加1，比如第一页为0，第二页为1，第三页为2，以此类推。\n### 返回:\n- 用户作品列表\n\n# [English]\n### Purpose:\n- Get user post list, such as videos, photos, etc.\n### Parameters:\n- user_id: AKA user id, can be obtained from the share link.\n- cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page.\n- feed_count: Page count, default is 0, add 1 for each page, such as 0 for the first page, 1 for the second page, 2 for the third page, and so on.\n### Return:\n- User post list\n\n# [示例/Example]\nuser_id = \"1310254082831248\"\ncursor = \"0\"\nfeed_count = \"0\"","operationId":"fetch_user_post_list_api_v1_pipixia_app_fetch_user_post_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"User Id"},"description":"用户id/User id","example":"1310254082831248"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Page cursor","default":"0","title":"Cursor"},"description":"翻页游标/Page cursor","example":"0"},{"name":"feed_count","in":"query","required":false,"schema":{"type":"string","description":"翻页数量/Page count","default":"0","title":"Feed Count"},"description":"翻页数量/Page count","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_user_follower_list":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取用户粉丝列表/Get user follower list","description":"# [中文]\n### 用途:\n- 获取用户的粉丝列表。\n### 参数:\n- user_id: 用户id，可以从分享链接中获取。\n- cursor: 翻页游标，默认为0，后续页码从上一页返回的 `loadmore_cursor` Key中获取对应值。\n### 返回:\n- 用户粉丝列表\n\n# [English]\n### Purpose:\n- Get user's follower list.\n### Parameters:\n- user_id: AKA user id, can be obtained from the share link.\n- cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page.\n### Return:\n- User follower list\n\n# [示例/Example]\nuser_id = \"1310254082831248\"\ncursor = \"0\"","operationId":"fetch_user_follower_list_api_v1_pipixia_app_fetch_user_follower_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"User Id"},"description":"用户id/User id","example":"1310254082831248"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Page cursor","default":"0","title":"Cursor"},"description":"翻页游标/Page cursor","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_user_following_list":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取用户关注列表/Get user following list","description":"# [中文]\n### 用途:\n- 获取用户的关注列表。\n### 参数:\n- user_id: 用户id，可以从分享链接中获取。\n- cursor: 翻页游标，默认为0，后续页码从上一页返回的 `loadmore_cursor` Key中获取对应值。\n### 返回:\n- 用户关注列表\n\n# [English]\n### Purpose:\n- Get user's following list.\n### Parameters:\n- user_id: AKA user id, can be obtained from the share link.\n- cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page.\n### Return:\n- User following list\n\n# [示例/Example]\nuser_id = \"1310254082831248\"\ncursor = \"0\"","operationId":"fetch_user_following_list_api_v1_pipixia_app_fetch_user_following_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"User Id"},"description":"用户id/User id","example":"1310254082831248"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Page cursor","default":"0","title":"Cursor"},"description":"翻页游标/Page cursor","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_post_comment_list":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取作品评论列表/Get post comment list","description":"# [中文]\n### 用途:\n- 获取作品的评论列表。\n### 参数:\n- cell_id: 作品id，可以从分享链接中获取。\n- cell_type: 作品类型，1为视频，多大数保持默认值即可。\n- offset: 翻页游标，默认为0，后续页码从上一页返回的 `offset` Key中获取对应值。\n### 返回:\n- 作品评论列表\n\n# [English]\n### Purpose:\n- Get the comment list of a post.\n### Parameters:\n- cell_id: AKA video id, can be obtained from the share link.\n- cell_type: Video type, 1 for video, keep the default value for other types.\n- offset: Page cursor, default is 0, get the corresponding value from the `offset` Key in the previous page.\n### Return:\n- Post comment list\n\n# [示例/Example]\ncell_id = \"7411193113223371043\"\ncell_type = 1\noffset = \"0\"","operationId":"fetch_post_comment_list_api_v1_pipixia_app_fetch_post_comment_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cell_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Cell Id"},"description":"作品id/Video id","example":"7411193113223371043"},{"name":"cell_type","in":"query","required":false,"schema":{"type":"integer","description":"作品类型/Video type","default":1,"title":"Cell Type"},"description":"作品类型/Video type","example":1},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Page cursor","default":"0","title":"Offset"},"description":"翻页游标/Page cursor","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_short_url":{"get":{"tags":["PiPiXia-App-API"],"summary":"生成短连接/Generate short URL","description":"# [中文]\n### 用途:\n- 生成短连接。\n### 参数:\n- original_url: 原始链接，可以是任意链接。\n### 返回:\n- 短连接\n\n# [English]\n### Purpose:\n- Generate short URL.\n### Parameters:\n- original_url: Original URL, can be any link.\n### Return:\n- Short URL\n\n# [示例/Example]\noriginal_url = \"https://h5.pipix.com/item/7385813877985909043\"","operationId":"fetch_short_url_api_v1_pipixia_app_fetch_short_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"original_url","in":"query","required":true,"schema":{"type":"string","description":"原始链接/Original URL","title":"Original Url"},"description":"原始链接/Original URL","example":"https://h5.pipix.com/item/7385813877985909043"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_home_feed":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取首页推荐/Get home feed","description":"# [中文]\n### 用途:\n- 获取首页推荐数据。\n### 参数:\n- cursor: 翻页游标，默认为0，后续页码从上一页返回的 `loadmore_cursor` Key中获取对应值。\n### 返回:\n- 首页推荐数据\n\n# [English]\n### Purpose:\n- Get home feed data.\n### Parameters:\n- cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page.\n### Return:\n- Home feed data\n\n# [示例/Example]\ncursor = \"0\"","operationId":"fetch_home_feed_api_v1_pipixia_app_fetch_home_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Page cursor","default":"0","title":"Cursor"},"description":"翻页游标/Page cursor","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_hot_search_words":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取热搜词条/Get hot search words","description":"# [中文]\n### 用途:\n- 获取热搜词条数据。\n### 返回:\n- 热搜词条数据\n\n# [English]\n### Purpose:\n- Get hot search words data.\n### Return:\n- Hot search words data\n\n# [示例/Example]\n无/None","operationId":"fetch_hot_search_words_api_v1_pipixia_app_fetch_hot_search_words_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/pipixia/app/fetch_hot_search_board_list":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取热搜榜单列表/Get hot search board list","description":"# [中文]\n### 用途:\n- 获取热搜榜单列表数据。\n### 返回:\n- 热搜榜单列表数据\n\n# [English]\n### Purpose:\n- Get hot search board list data.\n### Return:\n- Hot search board list data\n\n# [示例/Example]\n无/None","operationId":"fetch_hot_search_board_list_api_v1_pipixia_app_fetch_hot_search_board_list_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/pipixia/app/fetch_hot_search_board_detail":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取热搜榜单详情/Get hot search board detail","description":"# [中文]\n### 用途:\n- 获取热搜榜单详情数据。\n### 参数:\n- block_type: 榜单类型，可以从`/fetch_hot_search_board_list`接口中获取。\n### 返回:\n- 热搜榜单详情数据\n\n# [English]\n### Purpose:\n- Get hot search board detail data.\n### Parameters:\n- block_type: Board type, can be obtained from the `/fetch_hot_search_board_list` interface.\n### Return:\n- Hot search board detail data\n\n# [示例/Example]\nblock_type = 12","operationId":"fetch_hot_search_board_detail_api_v1_pipixia_app_fetch_hot_search_board_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"block_type","in":"query","required":true,"schema":{"type":"integer","description":"榜单类型/Board type","title":"Block Type"},"description":"榜单类型/Board type","example":12}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_search":{"get":{"tags":["PiPiXia-App-API"],"summary":"搜索接口/Search API","description":"# [中文]\n### 用途:\n- 搜索接口，支持搜索用户、作品等。\n### 参数:\n- keyword: 搜索关键词。\n- offset: 翻页游标，默认为0，后续页码从上一页返回的 `offset` Key中获取对应值。\n- search_type: 搜索类型，可用值如下：\n    - 1: 综合\n    - 8: 热门\n    - 9: 新鲜\n    - 2：视频\n    - 3：图文\n    - 4：用户\n    - 5：话题\n### 返回:\n- 搜索结果\n\n# [English]\n### Purpose:\n- Search API, support search user, post, etc.\n### Parameters:\n- keyword: Search keyword.\n- offset: Page cursor, default is 0, get the corresponding value from the `offset` Key in the previous page.\n- search_type: Search type, available values are as follows:\n    - 1: Comprehensive\n    - 8: Hot\n    - 9: Fresh\n    - 2: Video\n    - 3: Photo\n    - 4: User\n    - 5: Hashtag\n### Return:\n- Search result\n\n# [示例/Example]\nkeyword = \"皮皮虾\"\noffset = \"0\"\nsearch_type = \"1\"","operationId":"fetch_search_api_v1_pipixia_app_fetch_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"皮皮虾"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Page cursor","default":"0","title":"Offset"},"description":"翻页游标/Page cursor","example":"0"},{"name":"search_type","in":"query","required":false,"schema":{"type":"string","description":"搜索类型/Search type","default":"1","title":"Search Type"},"description":"搜索类型/Search type","example":"1"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_hashtag_detail":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取话题详情/Get hashtag detail","description":"# [中文]\n### 用途:\n- 获取话题详情数据。\n### 参数:\n- hashtag_id: 话题id，可以从分享链接中获取。\n### 返回:\n- 话题详情数据\n\n# [English]\n### Purpose:\n- Get hashtag detail data.\n### Parameters:\n- hashtag_id: AKA hashtag id, can be obtained from the share link.\n### Return:\n- Hashtag detail data\n# [示例/Example]\nhashtag_id = \"129559\"","operationId":"fetch_hashtag_detail_api_v1_pipixia_app_fetch_hashtag_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"hashtag_id","in":"query","required":true,"schema":{"type":"string","description":"话题id/Hashtag id","title":"Hashtag Id"},"description":"话题id/Hashtag id","example":"129559"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_hashtag_post_list":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取话题作品列表/Get hashtag post list","description":"# [中文]\n### 用途:\n- 获取话题作品列表数据。\n### 参数:\n- hashtag_id: 话题id，可以从分享链接中获取。\n- cursor: 翻页游标，默认为0，后续页码从上一页返回的 `loadmore_cursor` Key中获取对应值。\n- feed_count: 翻页数量，默认为0，后续每次翻页加1，比如第一页为0，第二页为1，第三页为2，以此类推。\n- hashtag_request_type: 话题请求类型，默认为0，可用值如下：\n    - 0: 热门\n    - 1: 最新\n    - 2: 精华\n- hashtag_sort_type: 话题排序类型，默认为3，可用值如下：\n    - 3: 按热度\n    - 2: 按时间，从新到旧\n    - 1: 精华\n### 返回:\n- 话题作品列表数据\n\n# [English]\n### Purpose:\n- Get hashtag post list data.\n### Parameters:\n- hashtag_id: AKA hashtag id, can be obtained from the share link.\n- cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page.\n- feed_count: Page count, default is 0, add 1 for each page, such as 0 for the first page, 1 for the second page, 2 for the third page, and so on.\n### Return:\n- Hashtag post list data\n\n# [示例/Example]\nhashtag_id = \"129559\"\ncursor = \"0\"\nfeed_count = \"0\"","operationId":"fetch_hashtag_post_list_api_v1_pipixia_app_fetch_hashtag_post_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"hashtag_id","in":"query","required":true,"schema":{"type":"string","description":"话题id/Hashtag id","title":"Hashtag Id"},"description":"话题id/Hashtag id","example":"129559"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Page cursor","default":"0","title":"Cursor"},"description":"翻页游标/Page cursor","example":"0"},{"name":"feed_count","in":"query","required":false,"schema":{"type":"string","description":"翻页数量/Page count","default":"0","title":"Feed Count"},"description":"翻页数量/Page count","example":"0"},{"name":"hashtag_request_type","in":"query","required":false,"schema":{"type":"string","description":"话题请求类型/Hashtag request type","default":"0","title":"Hashtag Request Type"},"description":"话题请求类型/Hashtag request type","example":"0"},{"name":"hashtag_sort_type","in":"query","required":false,"schema":{"type":"string","description":"话题排序类型/Hashtag sort type","default":"3","title":"Hashtag Sort Type"},"description":"话题排序类型/Hashtag sort type","example":"3"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/pipixia/app/fetch_home_short_drama_feed":{"get":{"tags":["PiPiXia-App-API"],"summary":"获取首页短剧推荐/Get home short drama feed","description":"# [中文]\n### 用途:\n- 获取首页短剧推荐数据。\n### 参数:\n- page: 页码，默认为1，每次翻页加1。\n### 返回:\n- 首页短剧推荐数据\n\n# [English]\n### Purpose:\n- Get home short drama feed data.\n### Parameters:\n- page: Page number, default is 1, add 1 for each page.\n### Return:\n- Home short drama feed data\n\n# [示例/Example]\npage = 1","operationId":"fetch_home_short_drama_feed_api_v1_pipixia_app_fetch_home_short_drama_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web/fetch_config_list":{"get":{"tags":["Weibo-Web-API"],"summary":"获取频道配置列表/Get channel config list","description":"# [中文]\n### 用途:\n- 获取微博移动端所有频道的配置信息\n### 返回:\n- 频道列表，包含频道名称和 containerid\n### 说明:\n- 返回的 containerid 可用于 fetch_trend_top 接口获取对应频道的热门内容\n\n# [English]\n### Purpose:\n- Get all channel configuration information from Weibo mobile\n### Return:\n- Channel list, including channel name and containerid\n### Note:\n- The returned containerid can be used in fetch_trend_top endpoint to get trending content of the corresponding channel","operationId":"fetch_config_list_api_v1_weibo_web_fetch_config_list_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web/fetch_trend_top":{"get":{"tags":["Weibo-Web-API"],"summary":"获取频道热门趋势/Get channel trend top","description":"# [中文]\n### 用途:\n- 获取指定频道的热门趋势内容\n### 参数:\n- containerid: 频道容器ID，可从 fetch_config_list 接口获取\n- page: 页码，默认1\n### 返回:\n- 热门微博列表\n### 说明:\n- containerid 示例: 102803_ctg1_8999_-_ctg1_8999_home\n- 可通过 fetch_config_list 获取所有可用的 containerid\n\n# [English]\n### Purpose:\n- Get trending content of the specified channel\n### Parameters:\n- containerid: Channel container ID, can be obtained from fetch_config_list endpoint\n- page: Page number, default 1\n### Return:\n- Trending Weibo list\n### Note:\n- containerid example: 102803_ctg1_8999_-_ctg1_8999_home\n- You can get all available containerids from fetch_config_list\n\n# [示例/Example]\ncontainerid = \"102803_ctg1_8999_-_ctg1_8999_home\"\npage = 1","operationId":"fetch_trend_top_api_v1_weibo_web_fetch_trend_top_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"containerid","in":"query","required":true,"schema":{"type":"string","description":"频道容器ID/Channel container ID","title":"Containerid"},"description":"频道容器ID/Channel container ID","example":"102803_ctg1_8999_-_ctg1_8999_home"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web/fetch_channel_feed":{"get":{"tags":["Weibo-Web-API"],"summary":"根据频道名称获取热门内容/Get channel feed by name","description":"# [中文]\n### 用途:\n- 根据频道名称获取热门内容（便捷接口）\n### 参数:\n- channel_name: 频道名称，如 \"热门\"、\"榜单\"、\"社会\" 等，不传则使用默认频道\n- page: 页码，默认1\n### 返回:\n- 热门微博列表\n### 说明:\n- 此接口会自动调用 fetch_config_list 获取频道配置，然后获取对应频道的热门内容\n- 如果指定的频道名称不存在，会返回错误信息\n- 可用频道：热门、榜单、同城、社会、科技、明星、电影、音乐、数码、汽车、游戏\n\n# [English]\n### Purpose:\n- Get trending content by channel name (convenience endpoint)\n### Parameters:\n- channel_name: Channel name, such as \"热门\", \"榜单\", \"社会\", etc. Use default if not provided\n- page: Page number, default 1\n### Return:\n- Trending Weibo list\n### Note:\n- This endpoint will automatically call fetch_config_list to get channel config, then fetch trending content\n- Returns error if the specified channel name does not exist\n- Available channels: 热门, 榜单, 同城, 社会, 科技, 明星, 电影, 音乐, 数码, 汽车, 游戏\n\n# [示例/Example]\nchannel_name = \"热门\"\npage = 1","operationId":"fetch_channel_feed_api_v1_weibo_web_fetch_channel_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_name","in":"query","required":false,"schema":{"type":"string","description":"频道名称，不传则使用默认频道/Channel name, use default if not provided","title":"Channel Name"},"description":"频道名称，不传则使用默认频道/Channel name, use default if not provided","example":"热门"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web/fetch_user_info":{"get":{"tags":["Weibo-Web-API"],"summary":"获取用户信息/Get user information","description":"# [中文]\n### 用途:\n- 获取微博用户信息\n### 参数:\n- uid: 用户ID\n### 返回:\n- 用户信息\n\n# [English]\n### Purpose:\n- Get Weibo user information\n### Parameters:\n- uid: User ID\n### Return:\n- User information\n\n# [示例/Example]\nuid = \"2992978081\"","operationId":"fetch_user_info_api_v1_weibo_web_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"Uid"},"description":"用户ID/User ID","example":"2992978081"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web/fetch_user_posts":{"get":{"tags":["Weibo-Web-API"],"summary":"获取用户微博列表/Get user posts","description":"# [中文]\n### 用途:\n- 获取微博用户的微博列表\n### 参数:\n- uid: 用户ID\n- page: 页码，默认1\n- since_id: 翻页用的ID，从上一页返回结果中获取\n### 返回:\n- 用户微博列表\n\n# [English]\n### Purpose:\n- Get Weibo user's posts list\n### Parameters:\n- uid: User ID\n- page: Page number, default 1\n- since_id: Pagination ID from previous page result\n### Return:\n- User posts list\n\n# [示例/Example]\nuid = \"7277477906\"\npage = 1","operationId":"fetch_user_posts_api_v1_weibo_web_fetch_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"Uid"},"description":"用户ID/User ID","example":"7277477906"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"since_id","in":"query","required":false,"schema":{"type":"string","description":"翻页ID，从上一页结果获取/Pagination ID from previous page","title":"Since Id"},"description":"翻页ID，从上一页结果获取/Pagination ID from previous page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web/fetch_post_detail":{"get":{"tags":["Weibo-Web-API"],"summary":"获取微博详情/Get post detail","description":"# [中文]\n### 用途:\n- 获取单条微博的详情\n### 参数:\n- post_id: 微博ID\n### 返回:\n- 微博详情\n\n# [English]\n### Purpose:\n- Get single Weibo post detail\n### Parameters:\n- post_id: Post ID\n### Return:\n- Post detail\n\n# [示例/Example]\npost_id = \"5092682368025584\"","operationId":"fetch_post_detail_api_v1_weibo_web_fetch_post_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":true,"schema":{"type":"string","description":"微博ID/Post ID","title":"Post Id"},"description":"微博ID/Post ID","example":"5092682368025584"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web/fetch_post_comments":{"get":{"tags":["Weibo-Web-API"],"summary":"获取微博评论/Get post comments","description":"# [中文]\n### 用途:\n- 获取微博的评论列表（热门评论流）\n### 参数:\n- post_id: 微博ID\n- mid: 微博MID\n- max_id: 翻页用的ID，从上一页返回结果中获取\n- max_id_type: max_id类型，默认0\n### 返回:\n- 评论列表\n\n# [English]\n### Purpose:\n- Get Weibo post comments (hot comments flow)\n### Parameters:\n- post_id: Post ID\n- mid: Post MID\n- max_id: Pagination ID from previous page result\n- max_id_type: max_id type, default 0\n### Return:\n- Comments list\n\n# [示例/Example]\npost_id = \"5100663548412324\"\nmid = \"5100663548412324\"","operationId":"fetch_post_comments_api_v1_weibo_web_fetch_post_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":true,"schema":{"type":"string","description":"微博ID/Post ID","title":"Post Id"},"description":"微博ID/Post ID","example":"5100663548412324"},{"name":"mid","in":"query","required":true,"schema":{"type":"string","description":"微博MID/Post MID","title":"Mid"},"description":"微博MID/Post MID","example":"5100663548412324"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"翻页ID/Pagination ID","title":"Max Id"},"description":"翻页ID/Pagination ID"},{"name":"max_id_type","in":"query","required":false,"schema":{"type":"integer","description":"翻页ID类型/Pagination ID type","default":0,"title":"Max Id Type"},"description":"翻页ID类型/Pagination ID type","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web/fetch_comment_replies":{"get":{"tags":["Weibo-Web-API"],"summary":"获取评论子评论/Get comment replies","description":"# [中文]\n### 用途:\n- 获取评论的子评论（回复）\n### 参数:\n- cid: 根评论ID（从 fetch_post_comments 返回的评论中获取）\n- max_id: 翻页用的ID，默认0为第一页，从上一页返回结果中获取下一页的max_id\n### 返回:\n- 子评论列表\n\n# [English]\n### Purpose:\n- Get comment replies (sub-comments)\n### Parameters:\n- cid: Root comment ID (from fetch_post_comments response)\n- max_id: Pagination ID, default 0 for first page, get next page max_id from previous response\n### Return:\n- Sub-comments list\n\n# [示例/Example]\ncid = \"5100663573318494\"\nmax_id = \"0\"","operationId":"fetch_comment_replies_api_v1_weibo_web_fetch_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cid","in":"query","required":true,"schema":{"type":"string","description":"根评论ID/Root comment ID","title":"Cid"},"description":"根评论ID/Root comment ID","example":"5100663573318494"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"翻页ID，默认0为第一页/Pagination ID, default 0 for first page","default":"0","title":"Max Id"},"description":"翻页ID，默认0为第一页/Pagination ID, default 0 for first page","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web/fetch_search":{"get":{"tags":["Weibo-Web-API"],"summary":"搜索微博/Search Weibo","description":"# [中文]\n### 用途:\n- 搜索微博内容\n### 参数:\n- **keyword**: 搜索关键词\n    - 普通搜索: `游戏`、`新闻`\n    - 话题搜索: `#话题名#`（如 `#大冰建议女生不要找老登#`）\n- **page**: 页码\n    - 从 **1** 开始递增: 1, 2, 3, 4...\n    - 每页约返回 10-20 条结果\n    - **不是** 1, 10, 20 这种偏移量模式\n- **search_type**: 搜索类型\n    - **1**: 综合（默认，按相关性排序）\n    - **61**: 实时（按时间排序，最新优先）\n    - **3**: 用户（搜索用户账号）\n    - **60**: 热门（按热度排序）\n    - **64**: 视频（仅视频内容）\n    - **63**: 图片（仅图片内容）\n    - **21**: 文章（仅长文章）\n- **time_scope**: 时间范围筛选\n    - **null/不传**: 不限时间（默认）\n    - **hour**: 一小时内\n    - **day**: 一天内（24小时）\n    - **week**: 一周内\n    - **month**: 一个月内\n### 返回:\n- 搜索结果列表\n### 注意:\n- 此接口会自动生成游客Cookie，无需登录即可使用\n- 如遇到 432 错误，系统会自动重试\n\n# [English]\n### Purpose:\n- Search Weibo content\n### Parameters:\n- **keyword**: Search keyword\n    - Normal search: `game`, `news`\n    - Hashtag search: `#topic#` (e.g., `#TopicName#`)\n- **page**: Page number\n    - Starts from **1** and increments: 1, 2, 3, 4...\n    - Returns ~10-20 results per page\n    - **NOT** offset mode like 1, 10, 20\n- **search_type**: Search type\n    - **1**: Comprehensive (default, sorted by relevance)\n    - **61**: Real-time (sorted by time, newest first)\n    - **3**: Users (search user accounts)\n    - **60**: Hot (sorted by popularity)\n    - **64**: Video (video content only)\n    - **63**: Pictures (image content only)\n    - **21**: Articles (long articles only)\n- **time_scope**: Time range filter\n    - **null/empty**: No time limit (default)\n    - **hour**: Within one hour\n    - **day**: Within one day (24 hours)\n    - **week**: Within one week\n    - **month**: Within one month\n### Return:\n- Search results list\n### Note:\n- This endpoint auto-generates visitor cookies, no login required\n- Auto-retry on 432 error\n\n# [示例/Example]\nkeyword = \"游戏\"\npage = 1\nsearch_type = \"1\"\ntime_scope = null","operationId":"fetch_search_api_v1_weibo_web_fetch_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词，支持话题搜索如 #话题名#/Search keyword, supports hashtag like #topic#","title":"Keyword"},"description":"搜索关键词，支持话题搜索如 #话题名#/Search keyword, supports hashtag like #topic#","example":"游戏"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"页码，从1开始递增(1,2,3...)，每页约10-20条/Page number, starts from 1 (1,2,3...), ~10-20 results per page","default":1,"title":"Page"},"description":"页码，从1开始递增(1,2,3...)，每页约10-20条/Page number, starts from 1 (1,2,3...), ~10-20 results per page","example":1},{"name":"search_type","in":"query","required":false,"schema":{"type":"string","description":"搜索类型/Search type: 1=综合, 61=实时, 3=用户, 60=热门, 64=视频, 63=图片, 21=文章","default":"1","title":"Search Type"},"description":"搜索类型/Search type: 1=综合, 61=实时, 3=用户, 60=热门, 64=视频, 63=图片, 21=文章","example":"1"},{"name":"time_scope","in":"query","required":false,"schema":{"type":"string","description":"时间范围/Time scope: hour=一小时内, day=一天内, week=一周内, month=一个月内, null=不限","title":"Time Scope"},"description":"时间范围/Time scope: hour=一小时内, day=一天内, week=一周内, month=一个月内, null=不限"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web/fetch_hot_search":{"get":{"tags":["Weibo-Web-API"],"summary":"获取热搜榜/Get hot search ranking","description":"# [中文]\n### 用途:\n- 获取微博实时热搜榜（Top 50）和实时上升热点\n### 返回:\n- 热搜榜列表，包含：\n    - **实时热搜榜**: 当前最热门的50个话题，按热度排序\n    - **实时上升热点**: 正在快速上升的热门话题\n### 说明:\n- 这是微博官方热搜榜数据\n- 每个热搜包含：排名、话题名、热度值、标签（如：新、热、沸）等\n- 与 `fetch_search_topics` 不同，此接口返回的是完整的热搜排行榜\n\n# [English]\n### Purpose:\n- Get Weibo real-time hot search ranking (Top 50) and rising trends\n### Return:\n- Hot search list, including:\n    - **Real-time Hot Search**: Top 50 hottest topics, sorted by popularity\n    - **Rising Trends**: Topics that are rapidly gaining attention\n### Note:\n- This is official Weibo hot search data\n- Each entry includes: rank, topic name, heat value, tags (new, hot, trending), etc.\n- Different from `fetch_search_topics`, this returns the complete hot search ranking","operationId":"fetch_hot_search_api_v1_weibo_web_fetch_hot_search_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web/fetch_search_topics":{"get":{"tags":["Weibo-Web-API"],"summary":"获取搜索页热搜词/Get search page hot topics","description":"# [中文]\n### 用途:\n- 获取搜索页的热搜词列表（搜索建议/热门话题）\n### 返回:\n- 搜索热词列表\n### 说明:\n- 这是搜索页面展示的热门搜索词\n- 通常用于搜索框下方的热门推荐\n- 与 `fetch_hot_search` 不同，此接口返回的是搜索建议词\n\n# [English]\n### Purpose:\n- Get search page hot topics list (search suggestions/trending topics)\n### Return:\n- Search hot topics list\n### Note:\n- These are hot search terms displayed on the search page\n- Usually used for trending recommendations below the search box\n- Different from `fetch_hot_search`, this returns search suggestion terms","operationId":"fetch_search_topics_api_v1_weibo_web_fetch_search_topics_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web_v2/check_allow_comment_with_pic":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"检查微博是否允许带图评论/Check if Weibo allows image comments","description":"# [中文]\n### 用途:\n- 检查指定微博是否允许用户在评论时上传图片。\n### 参数:\n- id: 微博ID（必填）\n### 返回:\n- result: true表示允许带图评论，false表示不允许\n### 注意:\n- 不同微博的图片评论权限可能不同\n\n# [English]\n### Purpose:\n- Check if a specific Weibo post allows image comments.\n### Parameters:\n- id: Weibo post ID (required)\n### Return:\n- result: true means image comments allowed, false means not allowed\n### Note:\n- Different posts may have different image comment permissions\n\n# [示例/Example]\nid = \"5092682368025584\"","operationId":"check_allow_comment_with_pic_api_v1_weibo_web_v2_check_allow_comment_with_pic_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","description":"微博ID/Weibo ID","title":"Id"},"description":"微博ID/Weibo ID","example":"5092682368025584"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_post_detail":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取单个作品数据/Get single post data","description":"# [中文]\n### 用途:\n- 获取指定微博的详细信息，包括内容、作者、互动数据等。\n### 参数:\n- id: 微博ID（必填）\n- is_get_long_text: 是否获取长微博全文（默认\"true\"）\n### 返回:\n- 微博详细数据，包含完整文本、图片、视频、点赞数、评论数、转发数等\n\n# [English]\n### Purpose:\n- Get detailed information of a specific Weibo post, including content, author, interaction data.\n### Parameters:\n- id: Weibo post ID (required)\n- is_get_long_text: Whether to get full text of long posts (default \"true\")\n### Return:\n- Post detailed data, including full text, images, videos, likes, comments, reposts count\n\n# [示例/Example]\nid = \"5092682368025584\"\nis_get_long_text = \"true\"","operationId":"fetch_post_detail_api_v1_weibo_web_v2_fetch_post_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Post id","title":"Id"},"description":"作品id/Post id","example":"5092682368025584"},{"name":"is_get_long_text","in":"query","required":false,"schema":{"type":"string","description":"是否获取长微博全文/Whether to get the full text of long Weibo posts (true/false)","default":"true","title":"Is Get Long Text"},"description":"是否获取长微博全文/Whether to get the full text of long Weibo posts (true/false)","example":"true"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_info":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取用户信息/Get user information","description":"# [中文]\n### 用途:\n- 获取微博用户的详细信息，包括昵称、头像、简介、关注数、粉丝数等。\n### 参数:\n- uid: 用户ID（可选，与custom二选一）\n- custom: 自定义用户名（可选，与uid二选一）\n### 返回:\n- 用户详细信息数据\n### 注意:\n- uid和custom参数至少需要提供一个\n- 如果同时提供，优先使用uid\n- 建议优先使用uid参数\n\n# [English]\n### Purpose:\n- Get detailed information of Weibo users, including nickname, avatar, bio, following count, followers count.\n### Parameters:\n- uid: User ID (optional, choose one with custom)\n- custom: Custom username (optional, choose one with uid)\n### Return:\n- User detailed information data\n### Note:\n- At least one of uid and custom must be provided\n- If both provided, uid takes priority\n- It's recommended to use uid parameter first\n\n# [示例/Example]\nuid = \"1722594714\"\n# or\ncustom = \"shuqi\"","operationId":"fetch_user_info_api_v1_weibo_web_v2_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"用户id/User id","default":"","title":"Uid"},"description":"用户id/User id","example":"1722594714"},{"name":"custom","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"自定义微博用户名/Custom Weibo username","default":"","title":"Custom"},"description":"自定义微博用户名/Custom Weibo username","example":"shuqi"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_basic_info":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取用户基本信息/Get user basic information","description":"# [中文]\n### 用途:\n- 获取微博用户的基本信息（轻量级接口）。\n### 参数:\n- uid: 用户ID（必填）\n### 返回:\n- 用户基本信息，包括用户ID、用户名、头像、简介、认证信息\n### 注意:\n- 与fetch_user_info相比，本接口返回数据更少，响应更快\n- 适合批量用户信息获取和用户卡片展示\n\n# [English]\n### Purpose:\n- Get basic information of Weibo users (lightweight API).\n### Parameters:\n- uid: User ID (required)\n### Return:\n- User basic info, including user ID, username, avatar, bio, verification\n### Note:\n- Compared to fetch_user_info, this API returns less data with faster response\n- Suitable for batch user info retrieval and user card display\n\n# [示例/Example]\nuid = \"7277477906\"","operationId":"fetch_user_basic_info_api_v1_weibo_web_v2_fetch_user_basic_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"Uid"},"description":"用户id/User id","example":"7277477906"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_posts":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博用户文章数据/Get Weibo user posts","description":"# [中文]\n### 用途:\n- 获取指定用户发布的微博列表，支持分页和多种数据详细程度。\n### 参数:\n- uid: 用户ID（必填）\n- page: 页码，从1开始（默认1）\n- feature: 数据特征值（默认0）\n    - 0: 返回10条基础数据\n    - 1: 返回20条扩展数据\n    - 2: 返回20条图片相关数据\n    - 3: 返回20条完整数据\n- since_id: 翻页标识，用于获取下一页数据\n### 返回:\n- 微博列表数据，包含微博内容、图片、视频等信息\n- 包含 since_id 字段用于翻页\n### 注意:\n- feature=0性能最佳，feature=3数据最全\n\n# [English]\n### Purpose:\n- Get the list of posts published by specified user, support pagination and multiple data detail levels.\n### Parameters:\n- uid: User ID (required)\n- page: Page number, starts from 1 (default 1)\n- feature: Data feature value (default 0)\n    - 0: Return 10 basic posts\n    - 1: Return 20 extended posts\n    - 2: Return 20 image-related posts\n    - 3: Return 20 complete posts\n- since_id: Pagination identifier for next page\n### Return:\n- Post list data, including post content, images, videos, etc.\n- Contains since_id field for pagination\n### Note:\n- feature=0 has best performance, feature=3 has most complete data\n\n# [示例/Example]\nuid = \"7277477906\"\npage = 1\nfeature = 0","operationId":"fetch_user_posts_api_v1_weibo_web_v2_fetch_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"Uid"},"description":"用户id/User id","example":"7277477906"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页数/Page number","default":1,"title":"Page"},"description":"页数/Page number","example":1},{"name":"feature","in":"query","required":false,"schema":{"type":"integer","description":"特征值，控制返回数据的数量和字段：0=返回10条基础数据，1=返回20条扩展数据，2=返回20条图片相关数据，3=返回20条视频相关数据，字段逐级增加/Feature type: 0=10 basic posts, 1=20 extended posts, 2=20 image-related posts, 3=20 video-related posts, fields increase progressively","default":0,"title":"Feature"},"description":"特征值，控制返回数据的数量和字段：0=返回10条基础数据，1=返回20条扩展数据，2=返回20条图片相关数据，3=返回20条视频相关数据，字段逐级增加/Feature type: 0=10 basic posts, 1=20 extended posts, 2=20 image-related posts, 3=20 video-related posts, fields increase progressively","example":0},{"name":"since_id","in":"query","required":false,"schema":{"type":"string","description":"翻页标识，用于获取下一页数据/Pagination identifier for getting next page data","default":"","title":"Since Id"},"description":"翻页标识，用于获取下一页数据/Pagination identifier for getting next page data","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_original_posts":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博用户原创微博数据/Get Weibo user original posts","description":"# [中文]\n### 用途:\n- 获取指定用户发布的原创微博列表（排除转发内容）。\n### 参数:\n- uid: 用户ID（必填）\n- page: 页码，从1开始（默认1）\n- since_id: 翻页标识（第一页必须从fetch_user_posts接口获取）\n### 返回:\n- 原创微博列表，包含微博内容、图片、视频、互动数据等\n### 注意:\n- 与fetch_user_posts的区别：本接口只返回原创微博，排除转发\n- since_id必须先调用fetch_user_posts获取，第一页必传，后续页面不传\n\n# [English]\n### Purpose:\n- Get original posts published by specified user (excluding reposts).\n### Parameters:\n- uid: User ID (required)\n- page: Page number, starts from 1 (default 1)\n- since_id: Pagination identifier (first page must get from fetch_user_posts)\n### Return:\n- Original post list, including content, images, videos, interaction data\n### Note:\n- Difference from fetch_user_posts: this API only returns original posts, excludes reposts\n- since_id must be obtained from fetch_user_posts first, required for first page, not needed for subsequent pages\n\n# [示例/Example]\nuid = \"7277477906\"\npage = 1\nsince_id = \"4924526881242703\"  # from fetch_user_posts response","operationId":"fetch_user_original_posts_api_v1_weibo_web_v2_fetch_user_original_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户id/User id","title":"Uid"},"description":"用户id/User id","example":"7277477906"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页数/Page number","default":1,"title":"Page"},"description":"页数/Page number","example":1},{"name":"since_id","in":"query","required":false,"schema":{"type":"string","description":"翻页标识，用于获取下一页数据/Pagination identifier for getting next page data","default":"","title":"Since Id"},"description":"翻页标识，用于获取下一页数据/Pagination identifier for getting next page data","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_post_comments":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博评论/Get Weibo comments","description":"# [中文]\n### 用途:\n- 获取指定微博的一级评论列表。\n### 参数:\n- id: 微博ID（必填）\n- count: 评论数量（默认10）\n- max_id: 翻页游标，首次请求传空，后续请求使用返回的max_id值\n### 返回:\n- 评论列表数据，包含评论内容、评论者信息、点赞数等\n- 包含 max_id 字段用于翻页\n### 注意:\n- 当没有更多评论时，max_id 为空\n\n# [English]\n### Purpose:\n- Get the first-level comment list of specified post.\n### Parameters:\n- id: Weibo post ID (required)\n- count: Number of comments (default 10)\n- max_id: Pagination cursor, pass empty for first request, use returned max_id for subsequent requests\n### Return:\n- Comment list data, including comment content, commenter info, likes count\n- Contains max_id field for pagination\n### Note:\n- When no more comments, max_id is empty\n\n# [示例/Example]\nid = \"5188973773455957\"\ncount = 10\nmax_id = \"\"","operationId":"fetch_post_comments_api_v1_weibo_web_v2_fetch_post_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","description":"微博ID/Weibo ID","title":"Id"},"description":"微博ID/Weibo ID","example":"5188973773455957"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"评论数量/Number of comments","default":10,"title":"Count"},"description":"评论数量/Number of comments","example":10},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"页码/Page number","default":"","title":"Max Id"},"description":"页码/Page number","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_post_sub_comments":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博子评论/Get Weibo sub-comments","description":"# [中文]\n### 用途:\n- 获取指定评论的回复（子评论）列表。\n### 参数:\n- id: 主评论ID（必填）\n- count: 子评论数量（默认10）\n- max_id: 翻页游标，首次请求传空，后续请求使用返回的max_id值\n### 返回:\n- 子评论列表数据，包含回复内容、回复者信息、点赞数等\n- 包含 max_id 字段用于翻页\n### 注意:\n- 与fetch_post_comments的区别：本接口获取的是评论的回复，而非微博的主评论\n\n# [English]\n### Purpose:\n- Get the reply (sub-comment) list of a specified comment.\n### Parameters:\n- id: Main comment ID (required)\n- count: Number of sub-comments (default 10)\n- max_id: Pagination cursor, pass empty for first request, use returned max_id for subsequent requests\n### Return:\n- Sub-comment list data, including reply content, replier info, likes count\n- Contains max_id field for pagination\n### Note:\n- Difference from fetch_post_comments: this API gets replies to comments, not main comments of posts\n\n# [示例/Example]\nid = \"5201793550385562\"\ncount = 10\nmax_id = \"\"","operationId":"fetch_post_sub_comments_api_v1_weibo_web_v2_fetch_post_sub_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","description":"主评论ID/Comment ID","title":"Id"},"description":"主评论ID/Comment ID","example":"5201793550385562"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"子评论数量/Number of sub-comments","default":10,"title":"Count"},"description":"子评论数量/Number of sub-comments","example":10},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"分页标识/Page identifier","default":"","title":"Max Id"},"description":"分页标识/Page identifier","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/search_user_posts":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"搜索用户微博/Search user posts","description":"# [中文]\n### 用途:\n- 在指定用户的微博中搜索包含特定关键词的内容。\n### 参数:\n- uid: 用户ID（必填）\n- q: 搜索关键词（必填）\n- page: 页码，从1开始（默认1）\n- starttime: 开始时间戳（可选，Unix时间戳格式）\n- endtime: 结束时间戳（可选，Unix时间戳格式）\n- hasori: 是否包含原创（默认1包含）\n- hasret: 是否包含转发（默认1包含）\n- hastext: 是否包含文字（默认1包含）\n- haspic: 是否包含图片（默认1包含）\n- hasvideo: 是否包含视频（默认1包含）\n- hasmusic: 是否包含音乐（默认1包含）\n### 返回:\n- 搜索结果列表，包含微博内容、作者信息、互动数据等\n### 注意:\n- 搜索结果受用户隐私设置影响\n- 时间戳参数使用Unix时间戳格式\n\n# [English]\n### Purpose:\n- Search for content containing specific keywords in a specified user's posts.\n### Parameters:\n- uid: User ID (required)\n- q: Search keyword (required)\n- page: Page number, starts from 1 (default 1)\n- starttime: Start timestamp (optional, Unix timestamp format)\n- endtime: End timestamp (optional, Unix timestamp format)\n- hasori: Include original posts (default 1 include)\n- hasret: Include retweets (default 1 include)\n- hastext: Include text posts (default 1 include)\n- haspic: Include image posts (default 1 include)\n- hasvideo: Include video posts (default 1 include)\n- hasmusic: Include music posts (default 1 include)\n### Return:\n- Search result list, including post content, author info, interaction data\n### Note:\n- Search results affected by user privacy settings\n- Timestamp parameters use Unix timestamp format\n\n# [示例/Example]\nuid = \"7277477906\"\nq = \"python\"\npage = 1","operationId":"search_user_posts_api_v1_weibo_web_v2_search_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"Uid"},"description":"用户ID/User ID","example":"7277477906"},{"name":"q","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Q"},"description":"搜索关键词/Search keyword","example":"python"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页数/Page number","default":1,"title":"Page"},"description":"页数/Page number","example":1},{"name":"starttime","in":"query","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"开始时间戳/Start timestamp","title":"Starttime"},"description":"开始时间戳/Start timestamp"},{"name":"endtime","in":"query","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"结束时间戳/End timestamp","title":"Endtime"},"description":"结束时间戳/End timestamp"},{"name":"hasori","in":"query","required":false,"schema":{"type":"integer","description":"是否包含原创微博，1=包含，0=不包含/Include original posts, 1=include, 0=exclude","default":1,"title":"Hasori"},"description":"是否包含原创微博，1=包含，0=不包含/Include original posts, 1=include, 0=exclude","example":1},{"name":"hasret","in":"query","required":false,"schema":{"type":"integer","description":"是否包含转发微博，1=包含，0=不包含/Include retweets, 1=include, 0=exclude","default":1,"title":"Hasret"},"description":"是否包含转发微博，1=包含，0=不包含/Include retweets, 1=include, 0=exclude","example":1},{"name":"hastext","in":"query","required":false,"schema":{"type":"integer","description":"是否包含文字微博，1=包含，0=不包含/Include text posts, 1=include, 0=exclude","default":1,"title":"Hastext"},"description":"是否包含文字微博，1=包含，0=不包含/Include text posts, 1=include, 0=exclude","example":1},{"name":"haspic","in":"query","required":false,"schema":{"type":"integer","description":"是否包含图片微博，1=包含，0=不包含/Include image posts, 1=include, 0=exclude","default":1,"title":"Haspic"},"description":"是否包含图片微博，1=包含，0=不包含/Include image posts, 1=include, 0=exclude","example":1},{"name":"hasvideo","in":"query","required":false,"schema":{"type":"integer","description":"是否包含视频微博，1=包含，0=不包含/Include video posts, 1=include, 0=exclude","default":1,"title":"Hasvideo"},"description":"是否包含视频微博，1=包含，0=不包含/Include video posts, 1=include, 0=exclude","example":1},{"name":"hasmusic","in":"query","required":false,"schema":{"type":"integer","description":"是否包含音乐微博，1=包含，0=不包含/Include music posts, 1=include, 0=exclude","default":1,"title":"Hasmusic"},"description":"是否包含音乐微博，1=包含，0=不包含/Include music posts, 1=include, 0=exclude","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_video_collection_list":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取用户微博视频收藏夹列表/Get user video collection list","description":"# [中文]\n### 用途:\n- 获取指定用户的视频收藏夹列表。\n### 参数:\n- uid: 用户ID（必填）\n### 返回:\n- 收藏夹列表，包含收藏夹ID、名称、描述、视频数量等\n### 注意:\n- 收藏夹列表受用户隐私设置影响\n- 部分用户可能没有创建视频收藏夹\n\n# [English]\n### Purpose:\n- Get video collection list of specified user.\n### Parameters:\n- uid: User ID (required)\n### Return:\n- Collection list, including collection ID, name, description, video count\n### Note:\n- Collection list affected by user privacy settings\n- Some users may not have created video collections\n\n# [示例/Example]\nuid = \"7277477906\"","operationId":"fetch_user_video_collection_list_api_v1_weibo_web_v2_fetch_user_video_collection_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"Uid"},"description":"用户ID/User ID","example":"7277477906"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_video_collection_detail":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取用户微博视频收藏夹详情/Get user video collection detail","description":"# [中文]\n### 用途:\n- 获取指定收藏夹的详细内容，包括视频列表。\n### 参数:\n- cid: 收藏夹ID（必填，从fetch_user_video_collection_list获取）\n- cursor: 分页游标，首次请求传空，后续使用返回的cursor\n- tab_code: 排序方式（0=默认，1=最热，2=最新）\n### 返回:\n- 收藏夹信息和视频列表，包含视频标题、封面、时长、播放数等\n- 包含 next_cursor 和 has_more 字段用于翻页\n### 注意:\n- 不同排序方式的cursor不通用，切换排序需重新开始分页\n\n# [English]\n### Purpose:\n- Get detailed content of specified collection, including video list.\n### Parameters:\n- cid: Collection ID (required, get from fetch_user_video_collection_list)\n- cursor: Pagination cursor, pass empty for first request, use returned cursor for subsequent\n- tab_code: Sort type (0=default, 1=hottest, 2=latest)\n### Return:\n- Collection info and video list, including video title, cover, duration, views\n- Contains next_cursor and has_more fields for pagination\n### Note:\n- Cursors for different sorting methods are not universal, switching sorting requires restarting pagination\n\n# [示例/Example]\ncid = \"4883992307236954\"\ncursor = \"\"\ntab_code = 0","operationId":"fetch_user_video_collection_detail_api_v1_weibo_web_v2_fetch_user_video_collection_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cid","in":"query","required":true,"schema":{"type":"string","description":"收藏夹ID/Collection ID","title":"Cid"},"description":"收藏夹ID/Collection ID","example":"4883992307236954"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor","default":"","title":"Cursor"},"description":"分页游标/Pagination cursor","example":""},{"name":"tab_code","in":"query","required":false,"schema":{"type":"integer","description":"排序方式：0=默认，1=最热，2=最新/Sort type: 0=default, 1=hottest, 2=latest","default":0,"title":"Tab Code"},"description":"排序方式：0=默认，1=最热，2=最新/Sort type: 0=default, 1=hottest, 2=latest","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_video_list":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博用户全部视频/Get user all videos","description":"# [中文]\n### 用途:\n- 获取指定用户发布的所有视频内容（瀑布流展示）。\n### 参数:\n- uid: 用户ID（必填）\n- cursor: 翻页游标，初次请求传\"0\"，后续请求使用返回的next_cursor值\n### 返回:\n- 视频列表数据，包含视频标题、封面、播放量等信息\n- 包含 next_cursor 和 has_more 字段用于翻页\n### 注意:\n- 与收藏夹接口的区别：本接口获取用户发布的视频，收藏夹接口获取用户收藏的视频\n\n# [English]\n### Purpose:\n- Get all videos published by specified user (waterfall layout).\n### Parameters:\n- uid: User ID (required)\n- cursor: Pagination cursor, pass \"0\" for first request, use returned next_cursor for subsequent requests\n### Return:\n- Video list data, including video title, cover, views, etc.\n- Contains next_cursor and has_more fields for pagination\n### Note:\n- Difference from collection APIs: this API gets user published videos, collection APIs get user collected videos\n\n# [示例/Example]\nuid = \"7277477906\"\ncursor = \"0\"","operationId":"fetch_user_video_list_api_v1_weibo_web_v2_fetch_user_video_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"Uid"},"description":"用户ID/User ID","example":"7277477906"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor","default":"0","title":"Cursor"},"description":"分页游标/Pagination cursor","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_following":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取用户关注列表/Get user following list","description":"# [中文]\n### 用途:\n- 获取指定用户的关注列表（该用户关注了谁）。\n### 参数:\n- uid: 用户ID（必填）\n- page: 页码，从0开始（默认0）\n### 返回:\n- 关注用户列表，包含用户名、头像、简介、粉丝数等\n### 注意:\n- 关注列表受用户隐私设置影响\n- page参数从0开始，而不是1\n- 与fetch_user_fans的区别：本接口获取用户关注了谁，fetch_user_fans获取谁关注了该用户\n\n# [English]\n### Purpose:\n- Get the following list of specified user (who the user follows).\n### Parameters:\n- uid: User ID (required)\n- page: Page number, starts from 0 (default 0)\n### Return:\n- Following user list, including username, avatar, bio, followers count\n### Note:\n- Following list affected by user privacy settings\n- page parameter starts from 0, not 1\n- Difference from fetch_user_fans: this API gets who user follows, fetch_user_fans gets who follows the user\n\n# [示例/Example]\nuid = \"1722594714\"\npage = 0","operationId":"fetch_user_following_api_v1_weibo_web_v2_fetch_user_following_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"Uid"},"description":"用户ID/User ID","example":"1722594714"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":0,"title":"Page"},"description":"页码/Page number","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_fans":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取用户粉丝列表/Get user fans list","description":"# [中文]\n### 用途:\n- 获取指定用户的粉丝列表（谁关注了该用户）。\n### 参数:\n- uid: 用户ID（必填）\n- page: 页码，从0开始（默认0）\n### 返回:\n- 粉丝用户列表，包含用户名、头像、简介、粉丝数等\n### 注意:\n- 粉丝列表受用户隐私设置影响\n- page参数从0开始，而不是1\n- 与fetch_user_following的区别：本接口获取谁关注了该用户，fetch_user_following获取用户关注了谁\n\n# [English]\n### Purpose:\n- Get the fans list of specified user (who follows the user).\n### Parameters:\n- uid: User ID (required)\n- page: Page number, starts from 0 (default 0)\n### Return:\n- Fans user list, including username, avatar, bio, followers count\n### Note:\n- Fans list affected by user privacy settings\n- page parameter starts from 0, not 1\n- Difference from fetch_user_following: this API gets who follows the user, fetch_user_following gets who user follows\n\n# [示例/Example]\nuid = \"1722594714\"\npage = 0","operationId":"fetch_user_fans_api_v1_weibo_web_v2_fetch_user_fans_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"Uid"},"description":"用户ID/User ID","example":"1722594714"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":0,"title":"Page"},"description":"页码/Page number","example":0}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_all_groups":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取所有分组信息/Get all groups information","description":"# [中文]\n### 用途:\n- 获取微博平台的所有分组信息，包括默认分组和用户自定义分组。\n### 参数:\n- 无需额外参数\n### 返回:\n- 分组列表，包含分组ID、名称、容器ID等\n### 注意:\n- 返回的gid和containerid可用于时间轴接口的参数\n- 分组信息变化不频繁，建议缓存\n\n# [English]\n### Purpose:\n- Get all group information on Weibo platform, including default and user-defined groups.\n### Parameters:\n- No additional parameters required\n### Return:\n- Group list, including group ID, name, container ID, etc.\n### Note:\n- Returned gid and containerid can be used as parameters for timeline API\n- Group information changes infrequently, recommend caching\n\n# [示例/Example]\n# No parameters needed","operationId":"fetch_all_groups_api_v1_weibo_web_v2_fetch_all_groups_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web_v2/fetch_user_recommend_timeline":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博主页推荐时间轴/Get user recommend timeline","description":"# [中文]\n### 用途:\n- 获取微博主页的推荐时间轴内容，基于用户兴趣展示个性化推荐。\n### 参数:\n- refresh: 刷新类型（0=正常刷新，1=强制刷新）\n- group_id: 分组ID（可通过fetch_all_groups获取）\n- containerid: 容器ID（通常与group_id相同）\n- extparam: 扩展参数（默认\"discover|new_feed\"）\n- max_id: 翻页游标，首次请求传\"0\"\n- count: 获取数量（默认10，建议5-20）\n### 返回:\n- 推荐微博列表，包含微博内容、作者信息、互动数据等\n- 包含 max_id 字段用于翻页\n### 注意:\n- 建议先调用fetch_all_groups获取可用分组\n\n# [English]\n### Purpose:\n- Get recommended timeline content from Weibo homepage, displaying personalized recommendations based on user interests.\n### Parameters:\n- refresh: Refresh type (0=normal refresh, 1=force refresh)\n- group_id: Group ID (can be obtained through fetch_all_groups)\n- containerid: Container ID (usually same as group_id)\n- extparam: Extended parameters (default \"discover|new_feed\")\n- max_id: Pagination cursor, pass \"0\" for first request\n- count: Count (default 10, suggested 5-20)\n### Return:\n- Recommended post list, including post content, author info, interaction data\n- Contains max_id field for pagination\n### Note:\n- Recommend calling fetch_all_groups first to get available groups\n\n# [示例/Example]\nrefresh = 0\ngroup_id = \"102803\"\ncontainerid = \"102803\"\nmax_id = \"0\"\ncount = 10","operationId":"fetch_user_recommend_timeline_api_v1_weibo_web_v2_fetch_user_recommend_timeline_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"refresh","in":"query","required":false,"schema":{"type":"integer","description":"刷新类型，0=正常刷新，1=强制刷新/Refresh type, 0=normal refresh, 1=force refresh","default":0,"title":"Refresh"},"description":"刷新类型，0=正常刷新，1=强制刷新/Refresh type, 0=normal refresh, 1=force refresh","example":0},{"name":"group_id","in":"query","required":false,"schema":{"type":"string","description":"分组ID/Group ID","default":"102803","title":"Group Id"},"description":"分组ID/Group ID","example":"102803"},{"name":"containerid","in":"query","required":false,"schema":{"type":"string","description":"容器ID/Container ID","default":"102803","title":"Containerid"},"description":"容器ID/Container ID","example":"102803"},{"name":"extparam","in":"query","required":false,"schema":{"type":"string","description":"扩展参数/Extended parameters","default":"discover|new_feed","title":"Extparam"},"description":"扩展参数/Extended parameters","example":"discover|new_feed"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"最大ID/Max ID","default":"0","title":"Max Id"},"description":"最大ID/Max ID","example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"获取数量/Count","default":10,"title":"Count"},"description":"获取数量/Count","example":10}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_hot_ranking_timeline":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博热门榜单时间轴/Get hot ranking timeline","description":"# [中文]\n### 用途:\n- 获取微博平台各种类型的热门榜单内容。\n### 参数:\n- ranking_type: 榜单类型（必填）\n    - hour: 小时榜\n    - yesterday: 昨日榜\n    - day_before: 前日榜\n    - week: 周榜\n    - male: 男榜\n    - female: 女榜\n- max_id: 翻页游标，首次请求传\"0\"\n- count: 获取数量（默认10）\n### 返回:\n- 热门微博列表，包含微博内容、作者信息、互动数据等\n### 注意:\n- 不同榜单更新频率不同：小时榜实时性最强，周榜影响力较大\n\n# [English]\n### Purpose:\n- Get various types of hot ranking content from Weibo platform.\n### Parameters:\n- ranking_type: Ranking type (required)\n    - hour: Hourly ranking\n    - yesterday: Yesterday ranking\n    - day_before: Day before ranking\n    - week: Weekly ranking\n    - male: Male ranking\n    - female: Female ranking\n- max_id: Pagination cursor, pass \"0\" for first request\n- count: Count (default 10)\n### Return:\n- Hot post list, including post content, author info, interaction data\n### Note:\n- Different rankings have different update frequencies: hourly has highest real-time relevance, weekly has high influence\n\n# [示例/Example]\nranking_type = \"hour\"\nmax_id = \"0\"\ncount = 10","operationId":"fetch_hot_ranking_timeline_api_v1_weibo_web_v2_fetch_hot_ranking_timeline_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ranking_type","in":"query","required":true,"schema":{"type":"string","description":"榜单类型：hour=小时榜，yesterday=昨日榜，day_before=前日榜，week=周榜，male=男榜，female=女榜/Ranking type: hour=hourly, yesterday=yesterday, day_before=day before, week=weekly, male=male ranking, female=female ranking","title":"Ranking Type"},"description":"榜单类型：hour=小时榜，yesterday=昨日榜，day_before=前日榜，week=周榜，male=男榜，female=女榜/Ranking type: hour=hourly, yesterday=yesterday, day_before=day before, week=weekly, male=male ranking, female=female ranking","example":"hour"},{"name":"since_id","in":"query","required":false,"schema":{"type":"string","description":"分页标识，默认为0/Pagination identifier, default is 0","default":"0","title":"Since Id"},"description":"分页标识，默认为0/Pagination identifier, default is 0","example":"0"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"最大ID，默认为0/Max ID, default is 0","default":"0","title":"Max Id"},"description":"最大ID，默认为0/Max ID, default is 0","example":"0"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"获取数量，默认10/Count, default is 10","default":10,"title":"Count"},"description":"获取数量，默认10/Count, default is 10","example":10}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_hot_search_index":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博热搜词条(10条)/Get Weibo hot search index (10 items)","description":"# [中文]\n### 用途:\n- 快速获取微博热搜前10条。\n### 参数:\n- 无需额外参数\n### 返回:\n- 热搜词条列表，包含关键词、热度值、排名等\n### 注意:\n- 只返回前10条热搜\n- 热搜更新频繁，建议缓存2-5分钟\n- 如需完整热搜，使用fetch_hot_search_summary\n\n# [English]\n### Purpose:\n- Quickly get top 10 Weibo hot search items.\n### Parameters:\n- No additional parameters required\n### Return:\n- Hot search term list, including keyword, popularity value, rank\n### Note:\n- Only returns top 10 hot search items\n- Hot search updates frequently, recommend caching for 2-5 minutes\n- For complete hot search, use fetch_hot_search_summary\n\n# [示例/Example]\n# No parameters needed","operationId":"fetch_hot_search_index_api_v1_weibo_web_v2_fetch_hot_search_index_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web_v2/fetch_hot_search_summary":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博完整热搜榜单(50条)/Get Weibo complete hot search ranking (50 items)","description":"# [中文]\n### 用途:\n- 获取微博完整热搜榜单（50条）。\n### 参数:\n- 无需额外参数\n### 返回:\n- 完整热搜列表，包含排名、关键词、标签（热点/沸点/官宣/新）、热度值\n### 注意:\n- 与fetch_hot_search_index的区别：本接口返回50条，fetch_hot_search_index返回10条\n- rank为0表示置顶内容\n- 建议缓存5-10分钟\n\n# [English]\n### Purpose:\n- Get complete Weibo hot search ranking (50 items).\n### Parameters:\n- No additional parameters required\n### Return:\n- Complete hot search list, including rank, keyword, tag (Hot/Boiling/Official/New), heat value\n### Note:\n- Difference from fetch_hot_search_index: this API returns 50 items, fetch_hot_search_index returns 10 items\n- rank 0 indicates pinned content\n- Recommend caching for 5-10 minutes\n\n# [示例/Example]\n# No parameters needed","operationId":"fetch_hot_search_summary_api_v1_weibo_web_v2_fetch_hot_search_summary_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web_v2/fetch_hot_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博热搜榜单/Get Weibo hot search ranking","description":"# [中文]\n### 用途:\n- 获取微博实时热搜榜单数据。\n### 参数:\n- 无需额外参数\n### 返回:\n- 热搜数据，包含realtime（实时热搜）、hotgov等多个板块\n### 注意:\n- 热搜更新频繁，建议缓存2-5分钟\n\n# [English]\n### Purpose:\n- Get Weibo real-time hot search ranking data.\n### Parameters:\n- No additional parameters required\n### Return:\n- Hot search data, including realtime (real-time hot search), hotgov and other sections\n### Note:\n- Hot search updates frequently, recommend caching for 2-5 minutes\n\n# [示例/Example]\n# No parameters needed","operationId":"fetch_hot_search_api_v1_weibo_web_v2_fetch_hot_search_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web_v2/fetch_entertainment_ranking":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博文娱榜单/Get Weibo entertainment ranking","description":"# [中文]\n### 用途:\n- 获取微博文娱榜单数据（娱乐圈、影视、综艺等）。\n### 参数:\n- 无需额外参数\n### 返回:\n- 文娱话题列表，包含话题、热度值、排名、分类等\n### 注意:\n- 建议缓存5-10分钟\n\n# [English]\n### Purpose:\n- Get Weibo entertainment ranking data (entertainment, film & TV, variety shows).\n### Parameters:\n- No additional parameters required\n### Return:\n- Entertainment topic list, including topic, heat value, rank, category\n### Note:\n- Recommend caching for 5-10 minutes\n\n# [示例/Example]\n# No parameters needed","operationId":"fetch_entertainment_ranking_api_v1_weibo_web_v2_fetch_entertainment_ranking_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web_v2/fetch_life_ranking":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博生活榜单/Get Weibo life ranking","description":"# [中文]\n### 用途:\n- 获取微博生活榜单数据（美食、旅游、健康、时尚等）。\n### 参数:\n- 无需额外参数\n### 返回:\n- 生活话题列表，包含话题、热度值、排名、分类等\n### 注意:\n- 建议缓存5-10分钟\n\n# [English]\n### Purpose:\n- Get Weibo life ranking data (food, travel, health, fashion).\n### Parameters:\n- No additional parameters required\n### Return:\n- Life topic list, including topic, heat value, rank, category\n### Note:\n- Recommend caching for 5-10 minutes\n\n# [示例/Example]\n# No parameters needed","operationId":"fetch_life_ranking_api_v1_weibo_web_v2_fetch_life_ranking_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web_v2/fetch_social_ranking":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博社会榜单/Get Weibo social ranking","description":"# [中文]\n### 用途:\n- 获取微博社会榜单数据（时事新闻、社会热点、民生话题等）。\n### 参数:\n- 无需额外参数\n### 返回:\n- 社会话题列表，包含话题、热度值、排名、分类等\n### 注意:\n- 社会热点变化较快，建议缓存2-5分钟\n\n# [English]\n### Purpose:\n- Get Weibo social ranking data (current affairs, social hotspots, livelihood topics).\n### Parameters:\n- No additional parameters required\n### Return:\n- Social topic list, including topic, heat value, rank, category\n### Note:\n- Social hotspots change rapidly, recommend caching for 2-5 minutes\n\n# [示例/Example]\n# No parameters needed","operationId":"fetch_social_ranking_api_v1_weibo_web_v2_fetch_social_ranking_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/weibo/web_v2/fetch_similar_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"获取微博相似搜索词推荐/Get Weibo similar search recommendations","description":"# [中文]\n### 用途:\n- 根据关键词获取微博推荐的相似搜索词。\n### 参数:\n- keyword: 搜索关键词（必填，支持话题标签格式如#话题名#）\n### 返回:\n- 相似搜索词列表，包含推荐词、搜索次数等\n### 注意:\n- 相似词推荐相对稳定，可缓存15-30分钟\n\n# [English]\n### Purpose:\n- Get similar search word recommendations based on keyword.\n### Parameters:\n- keyword: Search keyword (required, supports topic tag format like #TopicName#)\n### Return:\n- Similar search term list, including suggestion, search count\n### Note:\n- Similar word recommendations are relatively stable, can cache for 15-30 minutes\n\n# [示例/Example]\nkeyword = \"#微博奇遇记#\"","operationId":"fetch_similar_search_api_v1_weibo_web_v2_fetch_similar_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"#微博奇遇记#"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_ai_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"微博智能搜索/Weibo AI Search","description":"# [中文]\n### 用途:\n- 通过微博AI智能搜索获取搜索结果。\n### 参数:\n- query: 搜索关键词（必填，建议使用话题格式#话题名#）\n### 返回:\n- AI搜索结果，包含推荐内容、相关话题等\n### 注意:\n- AI搜索结果会根据用户行为进行个性化调整\n\n# [English]\n### Purpose:\n- Get search results through Weibo AI intelligent search.\n### Parameters:\n- query: Search keyword (required, recommend using topic format #TopicName#)\n### Return:\n- AI search results, including recommended content, related topics\n### Note:\n- AI search results are personalized based on user behavior\n\n# [示例/Example]\nquery = \"#法国#\"","operationId":"fetch_ai_search_api_v1_weibo_web_v2_fetch_ai_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"#法国#"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_ai_related_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"微博AI搜索内容扩展/Weibo AI Search Content Extension","description":"# [中文]\n### 用途:\n- 获取与关键词相关的内容扩展（相关问题、博主推荐、参考博文等）。\n### 参数:\n- keyword: 搜索关键词（必填，建议使用话题格式#话题名#）\n### 返回:\n- HTML格式的扩展内容，包含相关问题、博主推荐、参考博文等\n### 注意:\n- 返回内容为HTML格式，需要进行HTML解析处理\n- HTML结构可能会发生变化，需要做好容错处理\n\n# [English]\n### Purpose:\n- Get content extensions related to keyword (related questions, blogger recommendations, reference posts).\n### Parameters:\n- keyword: Search keyword (required, recommend using topic format #TopicName#)\n### Return:\n- HTML format extension content, including related questions, blogger recommendations, reference posts\n### Note:\n- Returned content is in HTML format, requires HTML parsing\n- HTML structure may change, need proper error handling\n\n# [示例/Example]\nkeyword = \"#微博奇遇记#\"","operationId":"fetch_ai_related_search_api_v1_weibo_web_v2_fetch_ai_related_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"#微博奇遇记#"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_advanced_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"微博高级搜索/Weibo Advanced Search","description":"# [中文]\n### 用途:\n- 微博高级搜索，支持多维度筛选。\n### 参数:\n- q: 搜索关键词（必填）\n- search_type: 搜索类型（all/hot/original/verified/media/viewpoint）\n- include_type: 包含类型（all/pic/video/music/link）\n- timescope: 时间范围（格式: custom:开始日期:结束日期，如 custom:2025-09-01-0:2025-09-08-23）\n- page: 页码（默认1）\n### 返回:\n- 搜索结果列表，包含微博内容、作者信息、图片、视频、互动数据等\n### 注意:\n- 视频播放需设置请求头 Referer=https://weibo.com/\n\n# [English]\n### Purpose:\n- Weibo advanced search with multi-dimensional filtering.\n### Parameters:\n- q: Search keyword (required)\n- search_type: Search type (all/hot/original/verified/media/viewpoint)\n- include_type: Include type (all/pic/video/music/link)\n- timescope: Time scope (format: custom:start_date:end_date, e.g. custom:2025-09-01-0:2025-09-08-23)\n- page: Page number (default 1)\n### Return:\n- Search result list, including post content, author info, images, videos, interaction data\n### Note:\n- Video playback requires setting header Referer=https://weibo.com/\n\n# [示例/Example]\nq = \"python\"\nsearch_type = \"hot\"\ninclude_type = \"pic\"\npage = 1","operationId":"fetch_advanced_search_api_v1_weibo_web_v2_fetch_advanced_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Q"},"description":"搜索关键词/Search keyword","example":"yu7"},{"name":"search_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"搜索类型/Search type: all(全部), hot(热门), original(原创), verified(认证用户), media(媒体), viewpoint(观点)","title":"Search Type"},"description":"搜索类型/Search type: all(全部), hot(热门), original(原创), verified(认证用户), media(媒体), viewpoint(观点)","example":"hot"},{"name":"include_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"包含类型/Include type: all(全部), pic(含图片), video(含视频), music(含音乐), link(含短链)","title":"Include Type"},"description":"包含类型/Include type: all(全部), pic(含图片), video(含视频), music(含音乐), link(含短链)","example":"pic"},{"name":"timescope","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"时间范围/Time scope (custom:start:end)","title":"Timescope"},"description":"时间范围/Time scope (custom:start:end)","example":"custom:2025-09-01-0:2025-09-08-23"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_city_list":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"地区省市映射/Region City List","description":"# [中文]\n### 用途:\n- 获取地区省市映射数据，用于用户搜索等接口的地区筛选参数。\n### 参数:\n- normalized: 是否返回标准化结构（默认True）\n### 返回:\n- 省市映射数据，用于fetch_user_search等接口的region参数\n### 注意:\n- 返回的编码格式为 custom:省代码:市代码，如 custom:11:1\n\n# [English]\n### Purpose:\n- Get region city mapping data for region filter parameter in user search APIs.\n### Parameters:\n- normalized: Whether to return normalized structure (default True)\n### Return:\n- Province-city mapping data, for region parameter in fetch_user_search and other APIs\n### Note:\n- Returned code format is custom:province_code:city_code, e.g. custom:11:1\n\n# [示例/Example]\nnormalized = True","operationId":"fetch_city_list_api_v1_weibo_web_v2_fetch_city_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"normalized","in":"query","required":false,"schema":{"type":"boolean","description":"是否返回标准化结构（省份列表+城市数组）/Whether to return normalized structure","default":true,"title":"Normalized"},"description":"是否返回标准化结构（省份列表+城市数组）/Whether to return normalized structure"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_realtime_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"实时搜索/Weibo Realtime Search","description":"# [中文]\n### 用途:\n- 获取微博实时搜索结果（按时间排序的最新微博）。\n### 参数:\n- query: 搜索关键词（必填）\n- page: 页码（默认1）\n### 返回:\n- 实时搜索结果列表，包含微博内容、作者信息、图片、视频、互动数据等\n### 注意:\n- 视频播放需设置请求头 Referer=https://weibo.com/\n- 返回结构与高级搜索一致\n\n# [English]\n### Purpose:\n- Get Weibo realtime search results (latest posts sorted by time).\n### Parameters:\n- query: Search keyword (required)\n- page: Page number (default 1)\n### Return:\n- Realtime search result list, including post content, author info, images, videos, interaction data\n### Note:\n- Video playback requires setting header Referer=https://weibo.com/\n- Return structure is same as advanced search\n\n# [示例/Example]\nquery = \"苹果发布会\"\npage = 1","operationId":"fetch_realtime_search_api_v1_weibo_web_v2_fetch_realtime_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"yu7"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_user_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"用户搜索/User search","description":"# [中文]\n### 用途:\n- 搜索微博用户，支持多种筛选条件。\n### 参数:\n- query: 搜索关键词（可选）\n- page: 页码（默认1）\n- region: 地区编码，从/fetch_city_list获取（可选）\n- auth: 认证类型 org_vip/per_vip/ord（可选）\n- gender: 性别 man/women（可选）\n- age: 年龄段 18y/22y/29y/39y/40y（可选）\n- nickname: 昵称筛选（可选）\n- tag: 标签筛选（可选）\n- school: 学校筛选（可选）\n- work: 公司筛选（可选）\n### 返回:\n- 用户列表，包含uid、昵称、头像、粉丝数、主页链接\n### 注意:\n- 筛选参数过多可能导致无结果\n\n# [English]\n### Purpose:\n- Search Weibo users with multiple filter options.\n### Parameters:\n- query: Search keyword (optional)\n- page: Page number (default 1)\n- region: Region code from /fetch_city_list (optional)\n- auth: Auth type org_vip/per_vip/ord (optional)\n- gender: Gender man/women (optional)\n- age: Age bucket 18y/22y/29y/39y/40y (optional)\n- nickname: Nickname filter (optional)\n- tag: Tag filter (optional)\n- school: School filter (optional)\n- work: Company filter (optional)\n### Return:\n- User list with uid, nickname, avatar, fans count, profile URL\n### Note:\n- Too many filters may result in no results\n\n# [示例/Example]\nquery = \"yu7\"\npage = 1","operationId":"fetch_user_search_api_v1_weibo_web_v2_fetch_user_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"搜索关键词/Query（提供则视为“全部”搜索；留空则仅应用高级筛选参数）","title":"Query"},"description":"搜索关键词/Query（提供则视为“全部”搜索；留空则仅应用高级筛选参数）","example":"yu7"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page","default":1,"title":"Page"},"description":"页码/Page","example":1},{"name":"region","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"地区编码，从 /city_list 获取/Region code from /city_list","title":"Region"},"description":"地区编码，从 /city_list 获取/Region code from /city_list","example":"custom:11:1"},{"name":"auth","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"认证类型 org_vip(机构)/per_vip(个人)/ord(普通)/Auth type","title":"Auth"},"description":"认证类型 org_vip(机构)/per_vip(个人)/ord(普通)/Auth type","example":"org_vip"},{"name":"gender","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"性别 man / women / Gender","title":"Gender"},"description":"性别 man / women / Gender","example":"man"},{"name":"age","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"年龄段 18y/22y/29y/39y/40y / Age bucket","title":"Age"},"description":"年龄段 18y/22y/29y/39y/40y / Age bucket","example":"22y"},{"name":"nickname","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"昵称筛选/Nickname filter","title":"Nickname"},"description":"昵称筛选/Nickname filter","example":"张三"},{"name":"tag","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"标签筛选/Tag filter","title":"Tag"},"description":"标签筛选/Tag filter","example":"摄影"},{"name":"school","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"学校筛选/School filter","title":"School"},"description":"学校筛选/School filter","example":"清华大学"},{"name":"work","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"公司筛选/Company filter","title":"Work"},"description":"公司筛选/Company filter","example":"字节跳动"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_video_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"视频搜索（热门/全部）/Weibo video search (hot/all)","description":"# [中文]\n### 用途:\n- 搜索微博视频内容，支持热门和全部模式。\n### 参数:\n- query: 搜索关键词（必填）\n- mode: 搜索模式 hot=热门 / all=全部（默认hot）\n- page: 页码（默认1）\n### 返回:\n- 视频列表，包含微博ID、作者、内容、视频链接、互动数据\n### 注意:\n- 播放视频需设置Referer=https://weibo.com/\n\n# [English]\n### Purpose:\n- Search Weibo video content, supports hot and all modes.\n### Parameters:\n- query: Search keyword (required)\n- mode: Search mode hot=popular / all=all (default hot)\n- page: Page number (default 1)\n### Return:\n- Video list with weibo ID, author, content, video URL, interaction data\n### Note:\n- Video playback requires setting Referer=https://weibo.com/\n\n# [示例/Example]\nquery = \"yu7\"\nmode = \"hot\"\npage = 1","operationId":"fetch_video_search_api_v1_weibo_web_v2_fetch_video_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"yu7"},{"name":"mode","in":"query","required":false,"schema":{"type":"string","description":"搜索模式：hot=热门 / all=全部","default":"hot","title":"Mode"},"description":"搜索模式：hot=热门 / all=全部","example":"hot"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_pic_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"图片搜索/Weibo picture search","description":"# [中文]\n### 用途:\n- 搜索微博图片内容，按微博ID聚合多图。\n### 参数:\n- query: 搜索关键词（必填）\n- page: 页码（默认1）\n### 返回:\n- 图片列表，包含微博ID、缩略图、原图链接、作者信息、图片数量\n### 注意:\n- 缩略图会自动转换为原图链接\n\n# [English]\n### Purpose:\n- Search Weibo picture content, aggregated by weibo ID.\n### Parameters:\n- query: Search keyword (required)\n- page: Page number (default 1)\n### Return:\n- Image list with weibo ID, thumbnail, large image URL, author info, image count\n### Note:\n- Thumbnails are automatically converted to large image URLs\n\n# [示例/Example]\nquery = \"yu7\"\npage = 1","operationId":"fetch_pic_search_api_v1_weibo_web_v2_fetch_pic_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"yu7"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/web_v2/fetch_topic_search":{"get":{"tags":["Weibo-Web-V2-API"],"summary":"话题搜索/Weibo topic search","description":"# [中文]\n### 用途:\n- 搜索微博话题，获取话题名称、封面、讨论量、阅读量。\n### 参数:\n- query: 搜索关键词（必填）\n- page: 页码（默认1）\n### 返回:\n- 话题列表，包含话题名、封面图、讨论数、阅读数\n### 注意:\n- 数量单位（万/亿）已转换为整数\n\n# [English]\n### Purpose:\n- Search Weibo topics, get topic name, cover, discussion count, read count.\n### Parameters:\n- query: Search keyword (required)\n- page: Page number (default 1)\n### Return:\n- Topic list with topic name, cover image, discussion count, read count\n### Note:\n- Count units (万/亿) are converted to integers\n\n# [示例/Example]\nquery = \"yu7\"\npage = 1","operationId":"fetch_topic_search_api_v1_weibo_web_v2_fetch_topic_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"yu7"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_user_info":{"get":{"tags":["Weibo-App-API"],"summary":"获取用户信息/Get user information","description":"# [中文]\n### 用途:\n- 获取微博用户的基本信息，包括昵称、头像、简介、关注数、粉丝数等。\n### 参数:\n- uid: 用户ID（必填）\n### 返回:\n- 用户基本信息数据\n### 注意:\n- 如果用户设置了隐私保护，部分信息可能无法获取\n\n# [English]\n### Purpose:\n- Get basic information of Weibo users, including nickname, avatar, bio, following count, followers count, etc.\n### Parameters:\n- uid: User ID (required)\n### Return:\n- User basic information data\n### Note:\n- Some information may not be available if user has set privacy protection\n\n# [示例/Example]\nuid = \"7648703289\"","operationId":"fetch_user_info_api_v1_weibo_app_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID","title":"Uid"},"description":"用户ID","example":"7648703289"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_user_info_detail":{"get":{"tags":["Weibo-App-API"],"summary":"获取用户详细信息/Get user detail information","description":"# [中文]\n### 用途:\n- 获取微博用户的详细信息，比基本信息更加完整，包括认证信息、标签、等级等。\n### 参数:\n- uid: 用户ID（必填）\n### 返回:\n- 用户详细信息数据\n### 注意:\n- 如果用户设置了隐私保护，部分信息可能无法获取\n\n# [English]\n### Purpose:\n- Get detailed information of Weibo users, more complete than basic info, including verification info, tags, level, etc.\n### Parameters:\n- uid: User ID (required)\n### Return:\n- User detailed information data\n### Note:\n- Some information may not be available if user has set privacy protection\n\n# [示例/Example]\nuid = \"7648703289\"","operationId":"fetch_user_info_detail_api_v1_weibo_app_fetch_user_info_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID","title":"Uid"},"description":"用户ID","example":"7648703289"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_user_timeline":{"get":{"tags":["Weibo-App-API"],"summary":"获取用户发布的微博/Get user timeline","description":"# [中文]\n### 用途:\n- 获取指定用户发布的微博列表，支持分页和多种内容筛选。\n### 参数:\n- uid: 用户ID（必填）\n- page: 页码，从1开始（默认1）\n- filter_type: 筛选类型（默认\"all\"）\n    - all: 全部微博\n    - original: 原创微博\n    - likes: 她/他的赞\n    - video: 视频微博\n    - pic: 图片微博\n    - location: 签到足迹\n    - month: 按时间筛选（需要同时传入month参数）\n- month: 时间筛选参数，格式YYYYMMDD（仅当filter_type=month时使用）\n### 返回:\n- 微博列表数据，包含微博内容、图片、视频等信息\n### 注意:\n- 如果用户设置了隐私保护，可能无法获取微博列表\n- 每页返回数量约为20条微博\n- 使用时间筛选时必须同时指定filter_type=month和month参数\n\n# [English]\n### Purpose:\n- Get the list of posts published by specified user, support pagination and multiple content filters.\n### Parameters:\n- uid: User ID (required)\n- page: Page number, starts from 1 (default 1)\n- filter_type: Filter type (default \"all\")\n    - all: All posts\n    - original: Original posts\n    - likes: Liked posts\n    - video: Video posts\n    - pic: Picture posts\n    - location: Location check-in posts\n    - month: Filter by time (must pass month parameter)\n- month: Time filter parameter, format YYYYMMDD (only used when filter_type=month)\n### Return:\n- Post list data, including post content, images, videos, etc.\n### Note:\n- If user has set privacy protection, post list may not be available\n- About 20 posts per page\n- When using time filter, must specify both filter_type=month and month parameter\n\n# [示例/Example]\nuid = \"7648703289\"\npage = 1\nfilter_type = \"all\"\n# or filter_type = \"video\" for videos only\n# or filter_type = \"month\" with month = \"20251010\" for time filter","operationId":"fetch_user_timeline_api_v1_weibo_app_fetch_user_timeline_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID","title":"Uid"},"description":"用户ID","example":"7648703289"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"页码","default":1,"title":"Page"},"description":"页码","example":1},{"name":"filter_type","in":"query","required":false,"schema":{"type":"string","description":"筛选类型","default":"all","title":"Filter Type"},"description":"筛选类型","example":"all"},{"name":"month","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"时间筛选(YYYYMMDD格式)","title":"Month"},"description":"时间筛选(YYYYMMDD格式)","example":"20251010"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_user_videos":{"get":{"tags":["Weibo-App-API"],"summary":"获取用户视频列表/Get user videos","description":"# [中文]\n### 用途:\n- 获取指定用户发布的视频列表（瀑布流展示）。\n### 参数:\n- uid: 用户ID（必填）\n- since_id: 翻页游标，初次请求不传，后续请求使用返回的since_id值\n### 返回:\n- 视频列表数据，包含视频标题、封面、播放量等信息\n- 包含 moreInfo.params.since_id 字段用于翻页\n### 注意:\n- 只返回包含视频的微博\n- 使用游标翻页（since_id），不使用页码翻页\n\n# [English]\n### Purpose:\n- Get the video list published by specified user (waterfall layout).\n### Parameters:\n- uid: User ID (required)\n- since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests\n### Return:\n- Video list data, including video title, cover, views, etc.\n- Contains moreInfo.params.since_id field for pagination\n### Note:\n- Only returns posts with videos\n- Uses cursor pagination (since_id), not page numbers\n\n# [示例/Example]\n# First page\nuid = \"7648703289\"\nsince_id = None\n\n# Next page (use since_id from previous response)\n# since_id = \"4763250669650541\"","operationId":"fetch_user_videos_api_v1_weibo_app_fetch_user_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID","title":"Uid"},"description":"用户ID","example":"7648703289"},{"name":"since_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页游标","title":"Since Id"},"description":"翻页游标"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_user_super_topics":{"get":{"tags":["Weibo-App-API"],"summary":"获取用户参与的超话列表/Get user super topics","description":"# [中文]\n### 用途:\n- 获取指定用户参与的超话列表。\n### 参数:\n- uid: 用户ID（必填）\n- page: 页码，从1开始（默认1）\n### 返回:\n- 用户参与的超话列表数据\n### 注意:\n- 如果用户设置了隐私保护，可能无法获取超话列表\n\n# [English]\n### Purpose:\n- Get the super topics list that user participated in.\n### Parameters:\n- uid: User ID (required)\n- page: Page number, starts from 1 (default 1)\n### Return:\n- User's super topics list data\n### Note:\n- If user has set privacy protection, super topics list may not be available\n\n# [示例/Example]\nuid = \"7648703289\"\npage = 1","operationId":"fetch_user_super_topics_api_v1_weibo_app_fetch_user_super_topics_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID","title":"Uid"},"description":"用户ID","example":"7648703289"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"页码","default":1,"title":"Page"},"description":"页码","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_user_album":{"get":{"tags":["Weibo-App-API"],"summary":"获取用户相册/Get user album","description":"# [中文]\n### 用途:\n- 获取指定用户的相册内容。\n### 参数:\n- uid: 用户ID（必填）\n- since_id: 翻页游标，初次请求不传，后续请求使用返回的since_id值\n### 返回:\n- 用户相册数据，包含图片列表等信息\n### 注意:\n- 如果用户设置了隐私保护，可能无法获取相册\n- 使用游标翻页（since_id），不使用页码翻页\n\n# [English]\n### Purpose:\n- Get the album content of specified user.\n### Parameters:\n- uid: User ID (required)\n- since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests\n### Return:\n- User album data, including image list, etc.\n### Note:\n- If user has set privacy protection, album may not be available\n- Uses cursor pagination (since_id), not page numbers\n\n# [示例/Example]\nuid = \"7648703289\"\nsince_id = None  # First page\n# since_id = \"5012154263666753_4990205358511630|1034:4990204960768042_20240328_-1\"  # Next page","operationId":"fetch_user_album_api_v1_weibo_app_fetch_user_album_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID","title":"Uid"},"description":"用户ID","example":"7648703289"},{"name":"since_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页游标","title":"Since Id"},"description":"翻页游标"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_user_articles":{"get":{"tags":["Weibo-App-API"],"summary":"获取用户文章列表/Get user articles","description":"# [中文]\n### 用途:\n- 获取指定用户发布的文章列表。\n### 参数:\n- uid: 用户ID（必填）\n- since_id: 翻页游标，初次请求不传，后续请求使用返回的since_id值\n### 返回:\n- 用户文章列表数据\n### 注意:\n- 如果用户没有发布过文章，返回空列表\n- 使用游标翻页（since_id），不使用页码翻页\n\n# [English]\n### Purpose:\n- Get the article list published by specified user.\n### Parameters:\n- uid: User ID (required)\n- since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests\n### Return:\n- User article list data\n### Note:\n- If user has not published any articles, returns empty list\n- Uses cursor pagination (since_id), not page numbers\n\n# [示例/Example]\nuid = \"1725941200\"\nsince_id = None  # First page","operationId":"fetch_user_articles_api_v1_weibo_app_fetch_user_articles_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID","title":"Uid"},"description":"用户ID","example":"1725941200"},{"name":"since_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页游标","title":"Since Id"},"description":"翻页游标"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_user_audios":{"get":{"tags":["Weibo-App-API"],"summary":"获取用户音频列表/Get user audios","description":"# [中文]\n### 用途:\n- 获取指定用户发布的音频列表。\n### 参数:\n- uid: 用户ID（必填）\n- since_id: 翻页游标，初次请求不传，后续请求使用返回的since_id值\n### 返回:\n- 用户音频列表数据\n### 注意:\n- 如果用户没有发布过音频，返回空列表\n- 使用游标翻页（since_id），不使用页码翻页\n\n# [English]\n### Purpose:\n- Get the audio list published by specified user.\n### Parameters:\n- uid: User ID (required)\n- since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests\n### Return:\n- User audio list data\n### Note:\n- If user has not published any audios, returns empty list\n- Uses cursor pagination (since_id), not page numbers\n\n# [示例/Example]\nuid = \"1725941200\"\nsince_id = None  # First page","operationId":"fetch_user_audios_api_v1_weibo_app_fetch_user_audios_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID","title":"Uid"},"description":"用户ID","example":"1725941200"},{"name":"since_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页游标","title":"Since Id"},"description":"翻页游标"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_user_profile_feed":{"get":{"tags":["Weibo-App-API"],"summary":"获取用户主页动态/Get user profile feed","description":"# [中文]\n### 用途:\n- 获取指定用户主页的动态流。\n### 参数:\n- uid: 用户ID（必填）\n- since_id: 翻页游标，初次请求不传，后续请求使用返回的since_id值\n### 返回:\n- 用户主页动态数据\n### 注意:\n- 如果用户设置了隐私保护，可能无法获取动态\n- 使用游标翻页（since_id），不使用页码翻页\n\n# [English]\n### Purpose:\n- Get the profile feed of specified user.\n### Parameters:\n- uid: User ID (required)\n- since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests\n### Return:\n- User profile feed data\n### Note:\n- If user has set privacy protection, feed may not be available\n- Uses cursor pagination (since_id), not page numbers\n\n# [示例/Example]\nuid = \"6580994757\"\nsince_id = None  # First page\n# since_id = \"2|1769360821762|5258923930289595,,,,,,1768788000,,,,,-1,-1\"  # Next page","operationId":"fetch_user_profile_feed_api_v1_weibo_app_fetch_user_profile_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户ID","title":"Uid"},"description":"用户ID","example":"6580994757"},{"name":"since_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页游标","title":"Since Id"},"description":"翻页游标"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_status_detail":{"get":{"tags":["Weibo-App-API"],"summary":"获取微博详情/Get post detail","description":"# [中文]\n### 用途:\n- 获取指定微博的详细信息。\n### 参数:\n- status_id: 微博ID（必填）\n### 返回:\n- 微博详细数据，包含完整文本、图片、视频、点赞数、评论数、转发数等\n### 注意:\n- 如果微博已被删除或设置为私密，可能无法获取\n\n# [English]\n### Purpose:\n- Get detailed information of specified post.\n### Parameters:\n- status_id: Post ID (required)\n### Return:\n- Post detailed data, including full text, images, videos, likes, comments, reposts count, etc.\n### Note:\n- May not be available if post has been deleted or set to private\n\n# [示例/Example]\nstatus_id = \"5016922058656962\"","operationId":"fetch_status_detail_api_v1_weibo_app_fetch_status_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"status_id","in":"query","required":true,"schema":{"type":"string","description":"微博ID","title":"Status Id"},"description":"微博ID","example":"5016922058656962"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_status_comments":{"get":{"tags":["Weibo-App-API"],"summary":"获取微博评论/Get post comments","description":"# [中文]\n### 用途:\n- 获取指定微博的一级评论列表（也适用于视频评论）。\n### 参数:\n- status_id: 微博ID或视频ID（必填）\n- max_id: 翻页游标，首次请求不传，后续请求使用返回的max_id值\n    - max_id json path: $.data.moreInfo.params.max_id\n- sort_type: 评论排序类型\n    - 0: 按热度排序（默认）\n    - 1: 按时间排序\n### 返回:\n- 评论列表数据，包含评论内容、评论者信息、点赞数等\n- 包含 max_id 字段用于翻页\n### 注意:\n- 每次返回约20条评论\n- 当没有更多评论时，max_id 为空或相同\n\n# [English]\n### Purpose:\n- Get the first-level comment list of specified post (also works for video comments).\n### Parameters:\n- status_id: Post ID or Video ID (required)\n- max_id: Pagination cursor, don't pass for first request, use returned max_id for subsequent requests\n    - max_id json path: $.data.moreInfo.params.max_id\n- sort_type: Comment sort type\n    - 0: Sort by popularity (default)\n    - 1: Sort by time\n### Return:\n- Comment list data, including comment content, commenter info, likes count, etc.\n- Contains max_id field for pagination\n### Note:\n- About 20 comments per page\n- When no more comments, max_id is empty or same\n\n# [示例/Example]\nstatus_id = \"5258708168476831\"\nmax_id = None  # First page\nsort_type = \"0\"  # Sort by popularity","operationId":"fetch_status_comments_api_v1_weibo_app_fetch_status_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"status_id","in":"query","required":true,"schema":{"type":"string","description":"微博ID","title":"Status Id"},"description":"微博ID","example":"5258708168476831"},{"name":"max_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页游标","title":"Max Id"},"description":"翻页游标"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序类型: 0=按热度排序, 1=按时间排序","default":"0","title":"Sort Type"},"description":"排序类型: 0=按热度排序, 1=按时间排序","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_status_reposts":{"get":{"tags":["Weibo-App-API"],"summary":"获取微博转发列表/Get post reposts","description":"# [中文]\n### 用途:\n- 获取指定微博的转发列表（也适用于视频转发）。\n### 参数:\n- status_id: 微博ID或视频ID（必填）\n- max_id: 翻页游标，首次请求不传，后续请求使用返回的max_id值\n### 返回:\n- 转发列表数据，包含转发内容、转发者信息等\n- 包含 max_id 字段用于翻页\n### 注意:\n- 每次返回约20条转发\n- 当没有更多转发时，max_id 为空或相同\n\n# [English]\n### Purpose:\n- Get the repost list of specified post (also works for video reposts).\n### Parameters:\n- status_id: Post ID or Video ID (required)\n- max_id: Pagination cursor, don't pass for first request, use returned max_id for subsequent requests\n### Return:\n- Repost list data, including repost content, reposter info, etc.\n- Contains max_id field for pagination\n### Note:\n- About 20 reposts per page\n- When no more reposts, max_id is empty or same\n\n# [示例/Example]\nstatus_id = \"5016922058656962\"\nmax_id = None  # First page","operationId":"fetch_status_reposts_api_v1_weibo_app_fetch_status_reposts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"status_id","in":"query","required":true,"schema":{"type":"string","description":"微博ID","title":"Status Id"},"description":"微博ID","example":"5016922058656962"},{"name":"max_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页游标","title":"Max Id"},"description":"翻页游标"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_status_likes":{"get":{"tags":["Weibo-App-API"],"summary":"获取微博点赞列表/Get post likes","description":"# [中文]\n### 用途:\n- 获取指定微博的点赞列表（也适用于视频点赞）。\n### 参数:\n- status_id: 微博ID或视频ID（必填）\n- attitude_type: 点赞类型筛选\n    - 0: 全部（默认）\n    - 1: 点赞\n    - 2: 开心\n    - 3: 惊讶\n    - 4: 伤心\n    - 5: 愤怒\n    - 6: 打赏\n    - 8: 抱抱\n### 返回:\n- 点赞列表数据，包含点赞者信息、点赞类型等\n### 注意:\n- 每次返回约50条点赞记录\n\n# [English]\n### Purpose:\n- Get the like list of specified post (also works for video likes).\n### Parameters:\n- status_id: Post ID or Video ID (required)\n- attitude_type: Like type filter\n    - 0: All (default)\n    - 1: Like\n    - 2: Happy\n    - 3: Surprise\n    - 4: Sad\n    - 5: Angry\n    - 6: Reward\n    - 8: Hug\n### Return:\n- Like list data, including liker info, like type, etc.\n### Note:\n- About 50 likes per page\n\n# [示例/Example]\nstatus_id = \"5016922058656962\"\nattitude_type = \"0\"  # All types","operationId":"fetch_status_likes_api_v1_weibo_app_fetch_status_likes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"status_id","in":"query","required":true,"schema":{"type":"string","description":"微博ID","title":"Status Id"},"description":"微博ID","example":"5016922058656962"},{"name":"attitude_type","in":"query","required":false,"schema":{"type":"string","description":"点赞类型: 0=全部, 1=点赞, 2=开心, 3=惊讶, 4=伤心, 5=愤怒, 6=打赏, 8=抱抱","default":"0","title":"Attitude Type"},"description":"点赞类型: 0=全部, 1=点赞, 2=开心, 3=惊讶, 4=伤心, 5=愤怒, 6=打赏, 8=抱抱","example":"0"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_video_detail":{"get":{"tags":["Weibo-App-API"],"summary":"获取视频详情/Get video detail","description":"# [中文]\n### 用途:\n- 获取单个视频的详细信息，包括视频播放地址。\n- **重要**: 从微博视频链接（如 https://weibo.com/tv/show/1034:5232127105761312）获取真实视频ID的必需步骤\n### 参数:\n- mid: 视频微博ID或链接中的ID（必填）\n### 返回:\n- 视频详细数据，包含视频播放地址、封面、时长、标题等\n- **items[0].data.idstr**: 真实的视频微博ID，可用于获取评论等操作\n### 注意:\n- 返回的视频地址可能有时效性\n- 支持获取高清视频地址\n- **获取评论前必须先调用此接口**: 链接中的ID不能直接用于获取评论，需要先通过此接口获取 items[0].data.idstr 中的真实ID\n\n# [English]\n### Purpose:\n- Get detailed information of single video, including video play URL.\n- **Important**: Required step to get real video ID from Weibo video link (e.g., https://weibo.com/tv/show/1034:5232127105761312)\n### Parameters:\n- mid: Video post ID or ID from link (required)\n### Return:\n- Video detailed data, including video play URL, cover, duration, title, etc.\n- **items[0].data.idstr**: Real video post ID, can be used for fetching comments\n### Note:\n- Returned video URL may have expiration time\n- Support getting HD video URL\n- **Must call this API before fetching comments**: ID from link cannot be used directly for comments, must get real ID from items[0].data.idstr first\n\n# [示例/Example]\nmid = \"5242977759006596\"","operationId":"fetch_video_detail_api_v1_weibo_app_fetch_video_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"mid","in":"query","required":true,"schema":{"type":"string","description":"视频微博ID","title":"Mid"},"description":"视频微博ID","example":"5242977759006596"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_video_featured_feed":{"get":{"tags":["Weibo-App-API"],"summary":"获取短视频精选Feed流/Get video featured feed","description":"# [中文]\n### 用途:\n- 获取微博短视频精选页的Feed流。\n### 参数:\n- page: 页码，首页不传或传空，第二页传\"2\"，依次递增\n### 返回:\n- 短视频精选Feed流数据，包含视频列表等\n### 注意:\n- 每页返回约20条视频\n\n# [English]\n### Purpose:\n- Get the featured video feed from Weibo video section.\n### Parameters:\n- page: Page number, don't pass for first page, pass \"2\" for second page, and so on\n### Return:\n- Featured video feed data, including video list, etc.\n### Note:\n- About 20 videos per page\n\n# [示例/Example]\npage = None  # First page\n# page = \"2\"  # Second page","operationId":"fetch_video_featured_feed_api_v1_weibo_app_fetch_video_featured_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"页码，首页不传，第二页传2","title":"Page"},"description":"页码，首页不传，第二页传2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_search_all":{"get":{"tags":["Weibo-App-API"],"summary":"综合搜索/Comprehensive search","description":"# [中文]\n### 用途:\n- 在微博中进行综合搜索，返回相关内容。支持多种搜索类型。\n### 参数:\n- query: 搜索关键词（必填）\n- page: 页码，从1开始（默认1）\n- search_type: 搜索类型\n    - 1: 综合（默认）\n    - 61: 实时\n    - 3: 用户\n    - 64: 视频\n    - 63: 图片\n    - 62: 关注\n    - 60: 热门\n    - 21: 全网\n    - 38: 话题\n    - 98: 超话\n    - 92: 地点\n    - 97: 商品\n### 返回:\n- 搜索结果列表，包含微博内容、作者信息、图片、视频等\n### 注意:\n- 搜索结果按相关度排序\n- 仅使用 page 参数进行翻页\n\n# [English]\n### Purpose:\n- Comprehensive search in Weibo, return related content. Supports multiple search types.\n### Parameters:\n- query: Search keyword (required)\n- page: Page number, starts from 1 (default 1)\n- search_type: Search type\n    - 1: General/All (default)\n    - 61: Realtime\n    - 3: Users\n    - 64: Videos\n    - 63: Images\n    - 62: Following\n    - 60: Hot\n    - 21: Whole network\n    - 38: Topics\n    - 98: Super topics\n    - 92: Places/Locations\n    - 97: Products/Goods\n### Return:\n- Search result list, including post content, author info, images, videos, etc.\n### Note:\n- Search results sorted by relevance\n- Only use page parameter for pagination\n\n# [示例/Example]\nquery = \"NVIDIA\"\npage = 1\nsearch_type = 1  # General search\n# search_type = 3  # Search users\n# search_type = 64  # Search videos","operationId":"fetch_search_all_api_v1_weibo_app_fetch_search_all_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词","title":"Query"},"description":"搜索关键词","example":"NVIDIA"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"页码","default":1,"title":"Page"},"description":"页码","example":1},{"name":"search_type","in":"query","required":false,"schema":{"type":"integer","description":"搜索类型: 1=综合, 61=实时, 3=用户, 64=视频, 63=图片, 62=关注, 60=热门, 21=全网, 38=话题, 98=超话, 92=地点, 97=商品","default":1,"title":"Search Type"},"description":"搜索类型: 1=综合, 61=实时, 3=用户, 64=视频, 63=图片, 62=关注, 60=热门, 21=全网, 38=话题, 98=超话, 92=地点, 97=商品","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_ai_smart_search":{"get":{"tags":["Weibo-App-API"],"summary":"AI智搜/AI Smart Search","description":"# [中文]\n### 用途:\n- 使用微博AI智搜功能进行搜索，返回AI增强的搜索结果。\n### 参数:\n- query: 搜索关键词（必填）\n- page: 页码，从1开始（默认1）\n### 返回:\n- AI智搜结果，包含AI增强的搜索内容\n### 注意:\n- 此接口为AI增强搜索，返回结果经过AI处理\n\n# [English]\n### Purpose:\n- Use Weibo AI Smart Search to search, return AI-enhanced search results.\n### Parameters:\n- query: Search keyword (required)\n- page: Page number, starts from 1 (default 1)\n### Return:\n- AI smart search results, including AI-enhanced search content\n### Note:\n- This is AI-enhanced search, results are processed by AI\n\n# [示例/Example]\nquery = \"人工智能\"\npage = 1","operationId":"fetch_ai_smart_search_api_v1_weibo_app_fetch_ai_smart_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词","title":"Query"},"description":"搜索关键词","example":"人工智能"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"页码","default":1,"title":"Page"},"description":"页码","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_home_recommend_feed":{"get":{"tags":["Weibo-App-API"],"summary":"获取首页推荐Feed流/Get home recommend feed","description":"# [中文]\n### 用途:\n- 获取微博首页推荐Feed流。\n### 参数:\n- page: 页码，首页不传或传空，第二页传\"2\"，依次递增\n- count: 每页数量，默认15，最大50\n### 返回:\n- 首页推荐Feed流数据\n### 注意:\n- 推荐内容基于热门话题和热点事件\n\n# [English]\n### Purpose:\n- Get the home recommend feed from Weibo.\n### Parameters:\n- page: Page number, don't pass for first page, pass \"2\" for second page, and so on\n- count: Items per page, default 15, max 50\n### Return:\n- Home recommend feed data\n### Note:\n- Recommended content based on hot topics and trending events\n\n# [示例/Example]\npage = None  # First page\ncount = 15","operationId":"fetch_home_recommend_feed_api_v1_weibo_app_fetch_home_recommend_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"页码，首页不传，第二页传2","title":"Page"},"description":"页码，首页不传，第二页传2"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"每页数量","default":15,"title":"Count"},"description":"每页数量","example":15}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_hot_search":{"get":{"tags":["Weibo-App-API"],"summary":"获取热搜榜/Get hot search","description":"# [中文]\n### 用途:\n- 获取微博热搜榜，支持多个分类。\n### 参数:\n- category: 热搜分类\n    - mineband: 我的热搜\n    - realtimehot: 实时热搜（默认）\n    - social: 社会热搜\n    - fun: 文娱热搜\n    - technologynav: 科技热搜\n    - lifenav: 生活热搜\n    - region: 同城热搜（需配合 region_name 指定城市）\n    - sportnav: 体育热搜\n    - gamenav: ACG热搜\n- page: 页码，从1开始（默认1）\n- count: 每页数量，默认20，最大50\n- region_name: 同城热搜城市名称，仅 category=region 时有效，默认北京\n### 返回:\n- 热搜榜数据，包含热搜词条、热度等\n### 注意:\n- 热搜榜实时更新\n\n# [English]\n### Purpose:\n- Get Weibo hot search ranking, supports multiple categories.\n### Parameters:\n- category: Hot search category\n    - mineband: My hot search\n    - realtimehot: Realtime hot search (default)\n    - social: Social hot search\n    - fun: Entertainment hot search\n    - technologynav: Technology hot search\n    - lifenav: Life hot search\n    - region: Local hot search (use region_name to specify city)\n    - sportnav: Sports hot search\n    - gamenav: ACG hot search\n- page: Page number, starts from 1 (default 1)\n- count: Items per page, default 20, max 50\n- region_name: City name for local hot search, only effective when category=region, default Beijing\n### Return:\n- Hot search ranking data, including search terms, popularity, etc.\n### Note:\n- Hot search ranking updates in real-time\n\n# [示例/Example]\ncategory = \"realtimehot\"\npage = 1\ncount = 20","operationId":"fetch_hot_search_api_v1_weibo_app_fetch_hot_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category","in":"query","required":false,"schema":{"type":"string","description":"热搜分类: mineband=我的, realtimehot=热搜, social=社会, fun=文娱, technologynav=科技, lifenav=生活, region=同城, sportnav=体育, gamenav=ACG","default":"realtimehot","title":"Category"},"description":"热搜分类: mineband=我的, realtimehot=热搜, social=社会, fun=文娱, technologynav=科技, lifenav=生活, region=同城, sportnav=体育, gamenav=ACG","example":"realtimehot"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"页码","default":1,"title":"Page"},"description":"页码","example":1},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"每页数量","default":20,"title":"Count"},"description":"每页数量","example":20},{"name":"region_name","in":"query","required":false,"schema":{"type":"string","description":"同城热搜城市名称，仅 category=region 时有效，支持: 北京/上海/广州/深圳/杭州/成都/重庆/武汉/南京/天津/西安/长沙/郑州/苏州/东莞/青岛/沈阳/合肥等，默认北京","title":"Region Name"},"description":"同城热搜城市名称，仅 category=region 时有效，支持: 北京/上海/广州/深圳/杭州/成都/重庆/武汉/南京/天津/西安/长沙/郑州/苏州/东莞/青岛/沈阳/合肥等，默认北京","example":"北京"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/weibo/app/fetch_hot_search_categories":{"get":{"tags":["Weibo-App-API"],"summary":"获取热搜分类列表/Get hot search categories","description":"# [中文]\n### 用途:\n- 获取微博热搜榜的所有可用分类列表。\n### 参数:\n- 无\n### 返回:\n- 热搜分类列表数据，包含各分类名称和标识\n### 注意:\n- 返回的分类可用于 fetch_hot_search 接口的 category 参数\n\n# [English]\n### Purpose:\n- Get all available hot search category list from Weibo.\n### Parameters:\n- None\n### Return:\n- Hot search category list data, including category names and identifiers\n### Note:\n- Returned categories can be used for category parameter in fetch_hot_search endpoint\n\n# [示例/Example]\n# No parameters required","operationId":"fetch_hot_search_categories_api_v1_weibo_app_fetch_hot_search_categories_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/wechat_mp/web/fetch_mp_article_detail_json":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号文章详情的JSON/Get Wechat MP Article Detail JSON","description":"# [中文]\n### 用途:\n- 获取微信公众号文章详情的JSON格式数据\n- 此接口收费便宜，如果你需要获取详细的HTML格式数据，请使用`/api/v1/wechat_mp/web/fetch_mp_article_detail_html`接口，但是此接口收费更贵。\n- 价格：0.001$/次\n### 参数:\n- url: 文章链接\n### 返回:\n- 文章详情的HTML\n\n# [English]\n### Purpose:\n- Get WeChat MP Article Detail in JSON format\n- This interface is cheaper, if you need detailed HTML format data, please use the `/api/v1/wechat_mp/web/fetch_mp_article_detail_html` interface, but this interface is more expensive.\n- Price: 0.001$/time\n### Parameters:\n- url: Article URL\n### Returns:\n- Article Detail HTML\n\n# [示例/Example]\nurl = \"https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw\"","operationId":"fetch_mp_article_detail_json_api_v1_wechat_mp_web_fetch_mp_article_detail_json_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"文章链接/Article URL","title":"Url"},"description":"文章链接/Article URL","example":"https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_mp/web/fetch_mp_article_detail_html":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号文章详情的HTML/Get Wechat MP Article Detail HTML","description":"# [中文]\n### 用途:\n- 获取微信公众号文章详情的HTML，如果你需要获取详细的JSON格式数据，请使用`/api/v1/wechat_mp/web/fetch_mp_article_detail_json`接口\n- 此接口收费贵，价格：0.01$/次\n### 参数:\n- url: 文章链接\n### 返回:\n- 文章详情的HTML\n\n# [English]\n### Purpose:\n- Get WeChat MP Article Detail, if you need detailed JSON format data, please use the `/api/v1/wechat_mp/web/fetch_mp_article_detail_json` interface\n- This interface is more expensive, price: 0.01$/time\n### Parameters:\n- url: Article URL\n### Returns:\n- Article Detail HTML\n\n# [示例/Example]\nurl = \"https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw\"","operationId":"fetch_mp_article_detail_html_api_v1_wechat_mp_web_fetch_mp_article_detail_html_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"文章链接/Article URL","title":"Url"},"description":"文章链接/Article URL","example":"https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_mp/web/fetch_mp_article_list":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号文章列表/Get Wechat MP Article List","description":"# [中文]\n### 用途:\n- 获取微信公众号文章列表\n### 参数:\n- ghid: 公众号ID\n- offset: 偏移量\n### 返回:\n- 文章列表\n\n# [English]\n### Purpose:\n- Get Wechat MP Article List\n### Parameters:\n- ghid: MP ID\n- offset: Offset\n### Returns:\n- Article List\n\n# [示例/Example]\nghid = \"gh_a3d35d4c9d3f\"\noffset = \"\"","operationId":"fetch_mp_article_list_api_v1_wechat_mp_web_fetch_mp_article_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ghid","in":"query","required":true,"schema":{"type":"string","description":"公众号ID/MP ID","title":"Ghid"},"description":"公众号ID/MP ID","example":"gh_a3d35d4c9d3f"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"","title":"Offset"},"description":"偏移量/Offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_mp/web/fetch_mp_article_read_count":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号文章阅读量/Get Wechat MP Article Read Count","description":"# [中文]\n### 用途:\n- 获取微信公众号文章阅读量\n### 参数:\n- url: 文章链接\n- comment_id: 评论ID\n### 返回:\n- 阅读量\n\n# [English]\n### Purpose:\n- Get Wechat MP Article Read Count\n### Parameters:\n- url: Article URL\n- comment_id: Comment ID\n### Returns:\n- Read Count\n\n# [示例/Example]\nurl = \"https://mp.weixin.qq.com/s/hrTDuwh0pWyJFYC93kKCrg\"\ncomment_id = \"3363399664632332289\"","operationId":"fetch_mp_article_read_count_api_v1_wechat_mp_web_fetch_mp_article_read_count_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"文章链接/Article URL","title":"Url"},"description":"文章链接/Article URL","example":"https://mp.weixin.qq.com/s/hrTDuwh0pWyJFYC93kKCrg"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论ID/Comment ID","title":"Comment Id"},"description":"评论ID/Comment ID","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_mp/web/fetch_mp_article_url":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号文章永久链接/Get Wechat MP Article URL","description":"# [中文]\n### 用途:\n- 获取微信公众号文章永久链接\n### 参数:\n- sogou_url: 搜狗链接\n### 返回:\n- 永久链接\n\n# [English]\n### Purpose:\n- Get Wechat MP Article URL\n### Parameters:\n- sogou_url: Sogou URL\n### Returns:\n- Article URL\n\n# [示例/Example]\nsogou_url = \"https://weixin.sogou.com/link?url=dn9a_-gY295K0Rci_xozVXfdMkSQTLW6cwJThYulHEtVjXrGTiVgS5mzcw64XRlRaPIdMgILsPEBI9djq3byAlqXa8Fplpd9bV3r44ewJj5IFttt-prmTSHShu8JtNlpDYR_z_1xvD2J_XrGTUriRYOOY2mt9pZSIUQEepUVTybxAOW4P5fEPd23R0CgK6W3KEODtIkcv1U5w5VkZ8a7_lyyAqreiCgr1YH9mz_7mzFDl6rX6ZnkVYNsUHV_OmaXBUCqpZ1Pa6YO8fIRwtipOg..&type=2&query=deepseek&token=C2E90D2050EB6EA5C2C4EDB1541D855FC322013E67C5DC5A&k=4&h=k\"","operationId":"fetch_mp_article_url_api_v1_wechat_mp_web_fetch_mp_article_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sogou_url","in":"query","required":true,"schema":{"type":"string","description":"搜狗链接/Sogou URL","title":"Sogou Url"},"description":"搜狗链接/Sogou URL","example":"https://weixin.sogou.com/link?url=dn9a_-gY295K0Rci_xozVXfdMkSQTLW6cwJThYulHEtVjXrGTiVgS5mzcw64XRlRaPIdMgILsPEBI9djq3byAlqXa8Fplpd9bV3r44ewJj5IFttt-prmTSHShu8JtNlpDYR_z_1xvD2J_XrGTUriRYOOY2mt9pZSIUQEepUVTybxAOW4P5fEPd23R0CgK6W3KEODtIkcv1U5w5VkZ8a7_lyyAqreiCgr1YH9mz_7mzFDl6rX6ZnkVYNsUHV_OmaXBUCqpZ1Pa6YO8fIRwtipOg..&type=2&query=deepseek&token=C2E90D2050EB6EA5C2C4EDB1541D855FC322013E67C5DC5A&k=4&h=k"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_mp/web/fetch_mp_article_comment_list":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号文章评论列表/Get Wechat MP Article Comment List","description":"# [中文]\n### 用途:\n- 获取微信公众号文章评论列表\n### 参数:\n- url: 文章链接\n- comment_id: 评论ID，可以不传获取评论用的id，默认传空字符串\n- buffer: 偏移量，第一次传空字符串，后续传上次返回的buffer值\n### 返回:\n- 评论列表\n\n# [English]\n### Purpose:\n- Get Wechat MP Article Comment List\n### Parameters:\n- url: Article URL\n- comment_id: Comment ID, can be empty to get the comment ID, default is an empty string\n- buffer: Offset, first time is an empty string, then pass the buffer value returned last time\n### Returns:\n- Comment List\n\n# [示例/Example]\nurl = \"https://mp.weixin.qq.com/s/Iv-xRzL7WzbL0dUUIgi3Nw\"\ncomment_id = \"\"\nbuffer = \"0\"","operationId":"fetch_mp_article_comment_list_api_v1_wechat_mp_web_fetch_mp_article_comment_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"文章链接/Article URL","title":"Url"},"description":"文章链接/Article URL","example":"https://mp.weixin.qq.com/s/Iv-xRzL7WzbL0dUUIgi3Nw"},{"name":"comment_id","in":"query","required":false,"schema":{"type":"string","description":"评论ID/Comment ID","default":"","title":"Comment Id"},"description":"评论ID/Comment ID"},{"name":"buffer","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"","title":"Buffer"},"description":"偏移量/Offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_mp/web/fetch_mp_article_comment_reply_list":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号文章评论回复列表/Get Wechat MP Article Comment Reply List","description":"# [中文]\n### 用途:\n- 获取微信公众号文章评论回复列表\n### 参数:\n- url: 文章链接\n- comment_id: 评论ID\n- content_id: 内容ID\n- offset: 偏移量\n### 返回:\n- 评论回复列表\n\n# [English]\n### Purpose:\n- Get Wechat MP Article Comment Reply List\n### Parameters:\n- url: Article URL\n- comment_id: Comment ID\n- content_id: Content ID\n- offset: Offset\n### Returns:\n- Comment Reply List\n\n# [示例/Example]\nurl = \"https://mp.weixin.qq.com/s/RCjkQlkRS4oKZ0GAT9slzA\"\ncomment_id = \"3601466901697855492\"\ncontent_id = \"6387234930341970671\"\noffset = \"0\"","operationId":"fetch_mp_article_comment_reply_list_api_v1_wechat_mp_web_fetch_mp_article_comment_reply_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":false,"schema":{"type":"string","description":"文章链接/Article URL","default":"https://mp.weixin.qq.com/s/Ko5V9jw9kwL8TO6Q7J3UqQ","title":"Url"},"description":"文章链接/Article URL"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论ID/Comment ID","title":"Comment Id"},"description":"评论ID/Comment ID","example":"3601466901697855492"},{"name":"content_id","in":"query","required":true,"schema":{"type":"string","description":"内容ID/Content ID","title":"Content Id"},"description":"内容ID/Content ID","example":"6387234930341970671"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"偏移量/Offset","default":"0","title":"Offset"},"description":"偏移量/Offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_mp/web/fetch_mp_article_ad":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号广告/Get Wechat MP Article Ad","description":"# [中文]\n### 用途:\n- 获取微信公众号广告\n### 参数:\n- url: 文章链接\n### 返回:\n- 广告\n\n# [English]\n### Purpose:\n- Get Wechat MP Article Ad\n### Parameters:\n- url: Article URL\n### Returns:\n- Ad\n\n# [示例/Example]\nurl = \"https://mp.weixin.qq.com/s/hrTDuwh0pWyJFYC93kKCrg\"","operationId":"fetch_mp_article_ad_api_v1_wechat_mp_web_fetch_mp_article_ad_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"文章链接/Article URL","title":"Url"},"description":"文章链接/Article URL","example":"https://mp.weixin.qq.com/s/hrTDuwh0pWyJFYC93kKCrg"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_mp/web/fetch_mp_article_url_conversion":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号长链接转短链接/Get Wechat MP Long URL to Short URL","description":"# [中文]\n### 用途:\n- 获取微信公众号长链接转短链接\n### 参数:\n- url: 文章链接\n### 返回:\n- 短链接\n\n# [English]\n### Purpose:\n- Get Wechat MP Long URL to Short URL\n### Parameters:\n- url: Article URL\n### Returns:\n- Short URL\n\n# [示例/Example]\nurl = \"http://mp.weixin.qq.com/s?__biz=MzIyMDQzMTM4Mg==&mid=2247504868&idx=1&sn=37ee48875df1be54cb766783177ce61d\"","operationId":"fetch_mp_article_url_conversion_api_v1_wechat_mp_web_fetch_mp_article_url_conversion_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"文章链接/Article URL","title":"Url"},"description":"文章链接/Article URL","example":"http://mp.weixin.qq.com/s?__biz=MzIyMDQzMTM4Mg==&mid=2247504868&idx=1&sn=37ee48875df1be54cb766783177ce61d"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_mp/web/fetch_mp_related_articles":{"get":{"tags":["WeChat-Media-Platform-Web-API"],"summary":"获取微信公众号关联文章/Get Wechat MP Related Articles","description":"# [中文]\n### 用途:\n- 获取微信公众号关联文章\n### 参数:\n- url: 文章链接\n### 返回:\n- 关联文章\n\n# [English]\n### Purpose:\n- Get Wechat MP Related Articles\n### Parameters:\n- url: Article URL\n### Returns:\n- Related Articles\n\n# [示例/Example]\nurl = \"https://mp.weixin.qq.com/s/Ko5V9jw9kwL8TO6Q7J3UqQ\"","operationId":"fetch_mp_related_articles_api_v1_wechat_mp_web_fetch_mp_related_articles_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"文章链接/Article URL","title":"Url"},"description":"文章链接/Article URL","example":"https://mp.weixin.qq.com/s/Ko5V9jw9kwL8TO6Q7J3UqQ"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_channels/fetch_default_search":{"post":{"tags":["WeChat-Channels-API"],"summary":"微信视频号默认搜索/WeChat Channels Default Search","description":"# [中文]\n### 用途:\n- 获取微信视频号默认搜索结果\n- 支持分页获取更多结果\n- 价格：0.01$/次\n### 参数:\n- keywords: 搜索关键词\n- session_buffer:\n    - 分页参数，首次请求可为空，后续使用响应中的 `last_buff` 进行分页请求\n    - JSON Path： `$.data.last_buff`\n### 返回:\n- 搜索结果列表，包含视频信息\n\n### 重要提示:\n- 如果你访问响应返回的 `url` 字段，可能会发现无法正确打开视频页面，这是因为微信对视频号页面做了防盗链处理。\n- 解决方法是将 `url` 字段和 `url_token` 字段拼接成一个完整的 URL，然后在浏览器中打开。（注明：可以打开的意思是HTTP响应代码200，不代表视频能正常播放，因为视频文件是加密的）\n- 使用上面拼接好的链接通过任意 HTTP 客户端下载视频文件，下载后如果发现 MP4 文件无法正常播放，说明该视频文件是加密的。 请使用接口返回的 `decode_key` 字段和加密视频文件，通过下面的工具进行解密。\n- ⚠️ **视频文件加密说明**: 如果下载的 MP4 文件无法正常播放，说明该视频文件是加密的。请使用接口返回的 `decode_key` 字段和加密视频文件，通过此工具进行解密：https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **重要**: 微信接口每次请求都会返回新的加密文件链接和 `decode_key`，即使是同一个视频。请确保使用的 `decode_key` 与下载的加密视频文件是同一次 API 响应中获取的，否则解密将会失败。\n- JSON Path 和相关说明:\n    - 获取翻页参数 `last_buff`: `$.data.last_buff`\n    - 获取视频列表: `$.data.media_list[*]`\n    - 获取视频 CDN 链接（不带Token）: `$.data.media_list[*].object_desc.media[0].url`\n    - 获取视频 CDN 链接的 Token: `$.data.media_list[*].object_desc.media[0].url_token`\n    - 拼接视频 CDN 的完整 URL 方式: `$.data.media_list[*].object_desc.media[0].url + $.data.media_list[*].object_desc.media[0].url_token`\n    - 获取视频解密密钥（每次请求都不一样）: `$.data.media_list[*].object_desc.media[0].decode_key`\n    - 在线解密工具: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - 可自行部署的解密 API（Docker一键部署）：https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption\n\n# [English]\n### Purpose:\n- Get WeChat Channels default search results\n- Support pagination for more results\n- Price: $0.01 per request\n### Parameters:\n- keywords: Search keywords\n- session_buffer: Pagination parameter, can be empty for first request\n    - For subsequent requests, use `last_buff` from the response for pagination\n    - JSON Path: `$.data.last_buff`\n\n### Return:\n- Search result list with video information\n### Important Note:\n- If you try to access the `url` field in the response, you may find that the video page cannot be opened correctly. This is because WeChat has implemented anti-hotlinking protection for video pages.\n- The solution is to concatenate the `url` field and the `url_token` field into a complete URL, and then open it in a browser. (Note: \"can be opened\" means HTTP response code 200, does not mean the video can be played normally, as the video file is encrypted)\n- Use the concatenated link above to download the video file through any HTTP client. If you find that the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using the tool below.\n- ⚠️ **Video Encryption Notice**: If the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using this tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **Important**: WeChat API returns a new encrypted file link and `decode_key` with each request, even for the same video. Please ensure that the `decode_key` used matches the encrypted video file obtained from the same API response, otherwise decryption will fail.\n- JSON Path and related instructions:\n    - To get the pagination parameter `last_buff`: `$.data.last_buff`\n    - To get the video list: `$.data.media_list[*]`\n    - To get the video CDN link (without Token): `$.data.media_list[*].object_desc.media[0].url`\n    - To get the Token for the video CDN link: `$.data.media_list[*].object_desc.media[0].url_token`\n    - How to concatenate the complete URL of the video CDN: `$.data.media_list[*].object_desc.media[0].url + $.data.media_list[*].object_desc.media[0].url_token`\n    - To get the video decryption key (different for each request): `$.data.media_list[*].object_desc.media[0].decode_key`\n    - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption","operationId":"fetch_default_search_api_v1_wechat_channels_fetch_default_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchDefaultSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/wechat_channels/fetch_search_latest":{"get":{"tags":["WeChat-Channels-API"],"summary":"微信视频号搜索最新视频/WeChat Channels Search Latest Videos","description":"# [中文]\n### 用途:\n- 获取微信视频号最新视频搜索结果\n- 按时间倒序排列\n- 价格：0.01$/次\n### 参数:\n- keywords: 搜索关键词\n### 返回:\n- 最新视频搜索结果列表\n\n### 重要提示:\n- 如果你访问响应返回的 `url` 字段，可能会发现无法正确打开视频页面，这是因为微信对视频号页面做了防盗链处理。\n- 解决方法是将 `url` 字段和 `url_token` 字段拼接成一个完整的 URL，然后在浏览器中打开。（注明：可以打开的意思是HTTP响应代码200，不代表视频能正常播放，因为视频文件是加密的）\n- 使用上面拼接好的链接通过任意 HTTP 客户端下载视频文件，下载后如果发现 MP4 文件无法正常播放，说明该视频文件是加密的。 请使用接口返回的 `decode_key` 字段和加密视频文件，通过下面的工具进行解密。\n- ⚠️ **视频文件加密说明**: 如果下载的 MP4 文件无法正常播放，说明该视频文件是加密的。请使用接口返回的 `decode_key` 字段和加密视频文件，通过此工具进行解密：https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **重要**: 微信接口每次请求都会返回新的加密文件链接和 `decode_key`，即使是同一个视频。请确保使用的 `decode_key` 与下载的加密视频文件是同一次 API 响应中获取的，否则解密将会失败。\n- JSON Path 和相关说明:\n    - 获取视频列表: `$.data.object_list[*]`\n    - 获取视频 CDN 链接（不带Token）: `$.data.object_list[*].object_desc.media[0].url`\n    - 获取视频 CDN 链接的 Token: `$.data.object_list[*].object_desc.media[0].url_token`\n    - 拼接视频 CDN 的完整 URL 方式: `$.data.object_list[*].object_desc.media[0].url + $.data.object_list[*].object_desc.media[0].url_token`\n    - 获取视频解密密钥（每次请求都不一样）: `$.data.object_list[*].object_desc.media[0].decode_key`\n    - 在线解密工具: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - 可自行部署的解密 API（Docker一键部署）：https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption\n\n# [English]\n### Purpose:\n- Get WeChat Channels latest video search results\n- Sorted by time in descending order\n- Price: $0.01 per request\n### Parameters:\n- keywords: Search keywords\n### Return:\n- Latest video search result list\n### Important Note:\n- If you try to access the `url` field in the response, you may find that the video page cannot be opened correctly. This is because WeChat has implemented anti-hotlinking protection for video pages.\n- The solution is to concatenate the `url` field and the `url_token` field into a complete URL, and then open it in a browser. (Note: \"can be opened\" means HTTP response code 200, does not mean the video can be played normally, as the video file is encrypted)\n- Use the concatenated link above to download the video file through any HTTP client. If you find that the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using the tool below.\n- ⚠️ **Video Encryption Notice**: If the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using this tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **Important**: WeChat API returns a new encrypted file link and `decode_key` with each request, even for the same video. Please ensure that the `decode_key` used matches the encrypted video file obtained from the same API response, otherwise decryption will fail.\n- JSON Path and related instructions:\n    - To get the video list: `$.data.object_list[*]`\n    - To get the video CDN link (without Token): `$.data.object_list[*].object_desc.media[0].url`\n    - To get the Token for the video CDN link: `$.data.object_list[*].object_desc.media[0].url_token`\n    - How to concatenate the complete URL of the video CDN: `$.data.object_list[*].object_desc.media[0].url + $.data.object_list[*].object_desc.media[0].url_token`\n    - To get the video decryption key (different for each request): `$.data.object_list[*].object_desc.media[0].decode_key`\n    - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption","operationId":"fetch_search_latest_api_v1_wechat_channels_fetch_search_latest_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keywords","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keywords","title":"Keywords"},"description":"搜索关键词/Search keywords","example":"美食"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_channels/fetch_search_ordinary":{"get":{"tags":["WeChat-Channels-API"],"summary":"微信视频号综合搜索/WeChat Channels Comprehensive Search","description":"# [中文]\n### 用途:\n- 获取微信视频号综合搜索结果\n- 按相关性排序\n- 价格：0.01$/次\n### 参数:\n- keywords: 搜索关键词\n### 返回:\n- 综合搜索结果列表\n\n### 重要提示:\n- 如果你访问响应返回的 `url` 字段，可能会发现无法正确打开视频页面，这是因为微信对视频号页面做了防盗链处理。\n- 解决方法是将 `url` 字段和 `url_token` 字段拼接成一个完整的 URL，然后在浏览器中打开。（注明：可以打开的意思是HTTP响应代码200，不代表视频能正常播放，因为视频文件是加密的）\n- 使用上面拼接好的链接通过任意 HTTP 客户端下载视频文件，下载后如果发现 MP4 文件无法正常播放，说明该视频文件是加密的。 请使用接口返回的 `decode_key` 字段和加密视频文件，通过下面的工具进行解密。\n- ⚠️ **视频文件加密说明**: 如果下载的 MP4 文件无法正常播放，说明该视频文件是加密的。请使用接口返回的 `decode_key` 字段和加密视频文件，通过此工具进行解密：https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **重要**: 微信接口每次请求都会返回新的加密文件链接和 `decode_key`，即使是同一个视频。请确保使用的 `decode_key` 与下载的加密视频文件是同一次 API 响应中获取的，否则解密将会失败。\n- JSON Path 和相关说明:\n    - 获取视频列表: `$.data.object_list[*]`\n    - 获取视频 CDN 链接（不带Token）: `$.data.object_list[*].object_desc.media[0].url`\n    - 获取视频 CDN 链接的 Token: `$.data.object_list[*].object_desc.media[0].url_token`\n    - 拼接视频 CDN 的完整 URL 方式: `$.data.object_list[*].object_desc.media[0].url + $.data.object_list[*].object_desc.media[0].url_token`\n    - 获取视频解密密钥（每次请求都不一样）: `$.data.object_list[*].object_desc.media[0].decode_key`\n    - 在线解密工具: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - 可自行部署的解密 API（Docker一键部署）：https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption\n\n# [English]\n### Purpose:\n- Get WeChat Channels comprehensive search results\n- Sorted by relevance\n- Price: $0.01 per request\n### Parameters:\n- keywords: Search keywords\n### Return:\n- Comprehensive search result list\n### Important Note:\n- If you try to access the `url` field in the response, you may find that the video page cannot be opened correctly. This is because WeChat has implemented anti-hotlinking protection for video pages.\n- The solution is to concatenate the `url` field and the `url_token` field into a complete URL, and then open it in a browser. (Note: \"can be opened\" means HTTP response code 200, does not mean the video can be played normally, as the video file is encrypted)\n- Use the concatenated link above to download the video file through any HTTP client. If you find that the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using the tool below.\n- ⚠️ **Video Encryption Notice**: If the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using this tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **Important**: WeChat API returns a new encrypted file link and `decode_key` with each request, even for the same video. Please ensure that the `decode_key` used matches the encrypted video file obtained from the same API response, otherwise decryption will fail.\n- JSON Path and related instructions:\n    - To get the video list: `$.data.object_list[*]`\n    - To get the video CDN link (without Token): `$.data.object_list[*].object_desc.media[0].url`\n    - To get the Token for the video CDN link: `$.data.object_list[*].object_desc.media[0].url_token`\n    - How to concatenate the complete URL of the video CDN: `$.data.object_list[*].object_desc.media[0].url + $.data.object_list[*].object_desc.media[0].url_token`\n    - To get the video decryption key (different for each request): `$.data.object_list[*].object_desc.media[0].decode_key`\n    - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption","operationId":"fetch_search_ordinary_api_v1_wechat_channels_fetch_search_ordinary_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keywords","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keywords","title":"Keywords"},"description":"搜索关键词/Search keywords","example":"美食"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_channels/fetch_user_search":{"get":{"tags":["WeChat-Channels-API"],"summary":"微信视频号用户搜索/WeChat Channels User Search","description":"# [中文]\n### 用途:\n- 搜索微信视频号用户\n- 按关键词查找相关用户\n- 价格：0.01$/次\n### 参数:\n- keywords: 搜索关键词\n- page: 页码，从1开始\n### 返回:\n- 用户搜索结果列表\n\n# [English]\n### Purpose:\n- Search WeChat Channels users\n- Find related users by keywords\n- Price: $0.01 per request\n### Parameters:\n- keywords: Search keywords\n- page: Page number, starting from 1\n### Return:\n- User search result list","operationId":"fetch_user_search_api_v1_wechat_channels_fetch_user_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keywords","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keywords","title":"Keywords"},"description":"搜索关键词/Search keywords","example":"美食博主"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_channels/fetch_user_search_v2":{"get":{"tags":["WeChat-Channels-API"],"summary":"微信视频号用户搜索V2/WeChat Channels User Search V2","description":"# [中文]\n### 用途:\n- 搜索微信视频号用户\n- 按关键词查找相关用户\n- 价格：0.01$/次\n### 参数:\n- keywords: 搜索关键词\n- page: 页码，默认为0\n### 返回:\n- 用户搜索结果列表\n\n# [English]\n### Purpose:\n- Search WeChat Channels users\n- Find related users by keywords\n- Price: $0.01 per request\n### Parameters:\n- keywords: Search keywords\n- page: page, default is 0\n### Return:\n- User search result list","operationId":"fetch_user_search_v2_api_v1_wechat_channels_fetch_user_search_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keywords","in":"query","required":false,"schema":{"type":"string","description":"搜索关键词/Search keywords","default":"","title":"Keywords"},"description":"搜索关键词/Search keywords","example":"美食博主"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":0,"title":"Page"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_channels/fetch_video_detail":{"get":{"tags":["WeChat-Channels-API"],"summary":"微信视频号视频详情/WeChat Channels Video Detail","description":"# [中文]\n### 用途:\n- 获取微信视频号视频详细信息\n- 可通过视频ID或导出ID获取\n- 价格：0.01$/次\n### 参数:\n- id: 视频ID（二选一）\n- exportId: 导出ID（会过期，二选一，使用时可不传id）\n### 返回:\n- 视频详细信息\n\n### 重要提示:\n- 如果你访问响应返回的 `url` 字段，可能会发现无法正确打开视频页面，这是因为微信对视频号页面做了防盗链处理。\n- 解决方法是将 `url` 字段和 `url_token` 字段拼接成一个完整的 URL，然后在浏览器中打开。（注明：可以打开的意思是HTTP响应代码200，不代表视频能正常播放，因为视频文件是加密的）\n- 使用上面拼接好的链接通过任意 HTTP 客户端下载视频文件，下载后如果发现 MP4 文件无法正常播放，说明该视频文件是加密的。 请使用接口返回的 `decode_key` 字段和加密视频文件，通过下面的工具进行解密。\n- ⚠️ **视频文件加密说明**: 如果下载的 MP4 文件无法正常播放，说明该视频文件是加密的。请使用接口返回的 `decode_key` 字段和加密视频文件，通过此工具进行解密：https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **重要**: 微信接口每次请求都会返回新的加密文件链接和 `decode_key`，即使是同一个视频。请确保使用的 `decode_key` 与下载的加密视频文件是同一次 API 响应中获取的，否则解密将会失败。\n- JSON Path 和相关说明:\n    - 获取视频 CDN 链接（不带Token）: `$.data.object_desc.media[0].url`\n    - 获取视频 CDN 链接的 Token: `$.data.object_desc.media[0].url_token`\n    - 拼接视频 CDN 的完整 URL 方式: `$.data.object_desc.media[0].url + $.data.object_desc.media[0].url_token`\n    - 获取视频解密密钥（每次请求都不一样）: `$.data.object_desc.media[0].decode_key`\n    - 在线解密工具: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - 可自行部署的解密 API（Docker一键部署）：https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption\n\n# [English]\n### Purpose:\n- Get WeChat Channels video detailed information\n- Can be obtained through video ID or export ID\n- Price: $0.01 per request\n### Parameters:\n- id: Video ID (choose one)\n- exportId: Export ID (may expire, choose one, can be used without id)\n### Return:\n- Video detailed information\n### Important Note:\n- If you try to access the `url` field in the response, you may find that the video page cannot be opened correctly. This is because WeChat has implemented anti-hotlinking protection for video pages.\n- The solution is to concatenate the `url` field and the `url_token` field into a complete URL, and then open it in a browser. (Note: \"can be opened\" means HTTP response code 200, does not mean the video can be played normally, as the video file is encrypted)\n- Use the concatenated link above to download the video file through any HTTP client. If you find that the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using the tool below.\n- ⚠️ **Video Encryption Notice**: If the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using this tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **Important**: WeChat API returns a new encrypted file link and `decode_key` with each request, even for the same video. Please ensure that the `decode_key` used matches the encrypted video file obtained from the same API response, otherwise decryption will fail.\n- JSON Path and related instructions:\n    - To get the video CDN link (without Token): `$.data.object_desc.media[0].url`\n    - To get the Token for the video CDN link: `$.data.object_desc.media[0].url_token`\n    - How to concatenate the complete URL of the video CDN: `$.data.object_desc.media[0].url + $.data.object_desc.media[0].url_token`\n    - To get the video decryption key (different for each request): `$.data.object_desc.media[0].decode_key`\n    - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption","operationId":"fetch_video_detail_api_v1_wechat_channels_fetch_video_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"string","description":"视频ID/Video ID","default":"","title":"Id"},"description":"视频ID/Video ID","example":"14396973035218999573"},{"name":"exportId","in":"query","required":false,"schema":{"type":"string","description":"导出ID会过期，优先用视频ID，使用时可不传id/Export ID may expire, prefer to use Video ID, can be used without id","default":"","title":"Exportid"},"description":"导出ID会过期，优先用视频ID，使用时可不传id/Export ID may expire, prefer to use Video ID, can be used without id","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_channels/fetch_home_page":{"post":{"tags":["WeChat-Channels-API"],"summary":"微信视频号主页/WeChat Channels Home Page","description":"# [中文]\n### 用途:\n- 获取微信视频号用户主页信息\n- 包含用户发布的视频列表\n- 支持分页获取更多视频\n- 价格：0.01$/次\n### 参数:\n- username: 用户名\n- last_buffer:\n    - 分页参数，首次请求可为空，后续使用 `object_list` 最后一个 item 的 `last_buffer` 进行分页请求\n    - JSON Path: `$.data.object_list[-1].last_buffer`\n### 返回:\n- 用户主页信息和视频列表\n\n### 重要提示:\n- 如果你访问响应返回的 `url` 字段，可能会发现无法正确打开视频页面，这是因为微信对视频号页面做了防盗链处理。\n- 解决方法是将 `url` 字段和 `url_token` 字段拼接成一个完整的 URL，然后在浏览器中打开。（注明：可以打开的意思是HTTP响应代码200，不代表视频能正常播放，因为视频文件是加密的）\n- 使用上面拼接好的链接通过任意 HTTP 客户端下载视频文件，下载后如果发现 MP4 文件无法正常播放，说明该视频文件是加密的。 请使用接口返回的 `decode_key` 字段和加密视频文件，通过下面的工具进行解密。\n- ⚠️ **视频文件加密说明**: 如果下载的 MP4 文件无法正常播放，说明该视频文件是加密的。请使用接口返回的 `decode_key` 字段和加密视频文件，通过此工具进行解密：https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **重要**: 微信接口每次请求都会返回新的加密文件链接和 `decode_key`，即使是同一个视频。请确保使用的 `decode_key` 与下载的加密视频文件是同一次 API 响应中获取的，否则解密将会失败。\n- JSON Path 和相关说明:\n    - 获取翻页参数 `last_buffer`: `$.data.object_list[-1].last_buffer`\n    - 获取视频列表: `$.data.object_list[*]`\n    - 获取视频 CDN 链接（不带Token）: `$.data.object_list[*].object_desc.media[0].url`\n    - 获取视频 CDN 链接的 Token: `$.data.object_list[*].object_desc.media[0].url_token`\n    - 拼接视频 CDN 的完整 URL 方式: `$.data.object_list[*].object_desc.media[0].url + $.data.object_list[*].object_desc.media[0].url_token`\n    - 获取视频解密密钥（每次请求都不一样）: `$.data.object_list[*].object_desc.media[0].decode_key`\n    - 在线解密工具: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - 可自行部署的解密 API（Docker一键部署）：https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption\n\n# [English]\n### Purpose:\n- Get WeChat Channels user homepage information\n- Including list of videos published by user\n- Support pagination for more videos\n- Price: $0.01 per request\n### Parameters:\n- username: Username\n- last_buffer:\n    - Pagination parameter, can be empty for first request\n    - For subsequent requests, use the `last_buffer` of the last item in `object_list`\n    - JSON Path: `$.data.object_list[-1].last_buffer`\n### Return:\n- User homepage information and video list\n### Important Note:\n- If you try to access the `url` field in the response, you may find that the video page cannot be opened correctly. This is because WeChat has implemented anti-hotlinking protection for video pages.\n- The solution is to concatenate the `url` field and the `url_token` field into a complete URL, and then open it in a browser. (Note: \"can be opened\" means HTTP response code 200, does not mean the video can be played normally, as the video file is encrypted)\n- Use the concatenated link above to download the video file through any HTTP client. If you find that the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using the tool below.\n- ⚠️ **Video Encryption Notice**: If the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using this tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **Important**: WeChat API returns a new encrypted file link and `decode_key` with each request, even for the same video. Please ensure that the `decode_key` used matches the encrypted video file obtained from the same API response, otherwise decryption will fail.\n- JSON Path and related instructions:\n    - To get the pagination parameter `last_buffer`: `$.data.object_list[-1].last_buffer`\n    - To get the video list: `$.data.object_list[*]`\n    - To get the video CDN link (without Token): `$.data.object_list[*].object_desc.media[0].url`\n    - To get the Token for the video CDN link: `$.data.object_list[*].object_desc.media[0].url_token`\n    - How to concatenate the complete URL of the video CDN: `$.data.object_list[*].object_desc.media[0].url + $.data.object_list[*].object_desc.media[0].url_token`\n    - To get the video decryption key (different for each request): `$.data.object_list[*].object_desc.media[0].decode_key`\n    - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption","operationId":"fetch_home_page_api_v1_wechat_channels_fetch_home_page_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchHomePageRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/wechat_channels/fetch_comments":{"post":{"tags":["WeChat-Channels-API"],"summary":"微信视频号评论/WeChat Channels Comments","description":"# [中文]\n### 用途:\n- 获取微信视频号视频评论\n- 支持分页获取更多评论\n- 价格：0.01$/次\n### 参数:\n- id: 视频ID\n- lastBuffer: 分页参数，首次请求可为空\n- comment_id: 评论ID，默认不传，传入则获取该评论下的子评论\n### 返回:\n- 视频评论列表\n\n# [English]\n### Purpose:\n- Get WeChat Channels video comments\n- Support pagination for more comments\n- Price: $0.01 per request\n### Parameters:\n- id: Video ID\n- lastBuffer: Pagination parameter, can be empty for first request\n- comment_id: Comment ID, if provided, fetches replies to that comment\n### Return:\n- Video comment list","operationId":"fetch_comments_api_v1_wechat_channels_fetch_comments_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchCommentsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/wechat_channels/fetch_live_history":{"get":{"tags":["WeChat-Channels-API"],"summary":"微信视频号直播回放/WeChat Channels Live History","description":"# [中文]\n### 用途:\n- 获取微信视频号用户的直播回放列表\n- 价格：0.01$/次\n### 参数:\n- username: 用户名\n### 返回:\n- 直播回放列表\n\n### 重要提示:\n- 如果你访问响应返回的 `url` 字段，可能会发现无法正确打开视频页面，这是因为微信对视频号页面做了防盗链处理。\n- 解决方法是将 `url` 字段和 `url_token` 字段拼接成一个完整的 URL，然后在浏览器中打开。（注明：可以打开的意思是HTTP响应代码200，不代表视频能正常播放，因为视频文件是加密的）\n- 使用上面拼接好的链接通过任意 HTTP 客户端下载视频文件，下载后如果发现 MP4 文件无法正常播放，说明该视频文件是加密的。 请使用接口返回的 `decode_key` 字段和加密视频文件，通过下面的工具进行解密。\n- ⚠️ **视频文件加密说明**: 如果下载的 MP4 文件无法正常播放，说明该视频文件是加密的。请使用接口返回的 `decode_key` 字段和加密视频文件，通过此工具进行解密：https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **重要**: 微信接口每次请求都会返回新的加密文件链接和 `decode_key`，即使是同一个视频。请确保使用的 `decode_key` 与下载的加密视频文件是同一次 API 响应中获取的，否则解密将会失败。\n- JSON Path 和相关说明:\n    - 获取直播回放列表: `$.data.live_list[*]`\n    - 获取视频 CDN 链接（不带Token）: `$.data.live_list[*].media.url`\n    - 获取视频 CDN 链接的 Token: `$.data.live_list[*].media.url_token`\n    - 拼接视频 CDN 的完整 URL 方式: `$.data.live_list[*].media.url + $.data.live_list[*].media.url_token`\n    - 获取视频解密密钥（每次请求都不一样）: `$.data.live_list[*].media.decode_key`\n    - 在线解密工具: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - 可自行部署的解密 API（Docker一键部署）：https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption\n\n# [English]\n### Purpose:\n- Get WeChat Channels user's live replay list\n- Price: $0.01 per request\n### Parameters:\n- username: Username\n### Return:\n- Live replay list\n### Important Note:\n- If you try to access the `url` field in the response, you may find that the video page cannot be opened correctly. This is because WeChat has implemented anti-hotlinking protection for video pages.\n- The solution is to concatenate the `url` field and the `url_token` field into a complete URL, and then open it in a browser. (Note: \"can be opened\" means HTTP response code 200, does not mean the video can be played normally, as the video file is encrypted)\n- Use the concatenated link above to download the video file through any HTTP client. If you find that the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using the tool below.\n- ⚠️ **Video Encryption Notice**: If the downloaded MP4 file cannot be played normally, it means the video file is encrypted. Please use the `decode_key` field returned by the API along with the encrypted video file, and decrypt it using this tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n- ⚠️ **Important**: WeChat API returns a new encrypted file link and `decode_key` with each request, even for the same video. Please ensure that the `decode_key` used matches the encrypted video file obtained from the same API response, otherwise decryption will fail.\n- JSON Path and related instructions:\n    - To get the live replay list: `$.data.live_list[*]`\n    - To get the video CDN link (without Token): `$.data.live_list[*].media.url`\n    - To get the Token for the video CDN link: `$.data.live_list[*].media.url_token`\n    - How to concatenate the complete URL of the video CDN: `$.data.live_list[*].media.url + $.data.live_list[*].media.url_token`\n    - To get the video decryption key (different for each request): `$.data.live_list[*].media.decode_key`\n    - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/\n    - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption","operationId":"fetch_live_history_api_v1_wechat_channels_fetch_live_history_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"v2_060000231003b20faec8c5eb811dc1d2cc0cee34b0779397527ceff87326eefb309aac785aa8@finder"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wechat_channels/fetch_hot_words":{"get":{"tags":["WeChat-Channels-API"],"summary":"微信视频号热门话题/WeChat Channels Hot Topics","description":"# [中文]\n### 用途:\n- 获取微信视频号当前热门话题\n- 可用于发现热门内容和趋势\n- 价格：0.01$/次\n### 参数:\n- 无需额外参数\n### 返回:\n- 热门话题列表\n\n# [English]\n### Purpose:\n- Get current hot topics in WeChat Channels\n- Can be used to discover popular content and trends\n- Price: $0.01 per request\n### Parameters:\n- No additional parameters required\n### Return:\n- Hot topic list","operationId":"fetch_hot_words_api_v1_wechat_channels_fetch_hot_words_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/instagram/v1/shortcode_to_media_id":{"get":{"tags":["Instagram-V1-API"],"summary":"Shortcode转Media ID/Convert shortcode to media ID","description":"# [中文]\n### 用途:\n- 将Instagram帖子的Shortcode转换为Media ID\n- Shortcode是帖子URL中的唯一标识，如 instagram.com/p/DRhvwVLAHAG/ 中的 DRhvwVLAHAG\n### 参数:\n- shortcode: 帖子的Shortcode\n### 返回:\n- `status`: 转换状态\n- `shortcode`: 原始Shortcode\n- `media_id`: 转换后的Media ID\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Convert Instagram post shortcode to media ID\n- Shortcode is the unique identifier in post URL, e.g., DRhvwVLAHAG in instagram.com/p/DRhvwVLAHAG/\n### Parameters:\n- shortcode: Post shortcode\n### Return:\n- `status`: Conversion status\n- `shortcode`: Original shortcode\n- `media_id`: Converted media ID\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nshortcode = \"DRhvwVLAHAG\"","operationId":"shortcode_to_media_id_api_v1_instagram_v1_shortcode_to_media_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"shortcode","in":"query","required":true,"schema":{"type":"string","description":"帖子Shortcode/Post shortcode","title":"Shortcode"},"description":"帖子Shortcode/Post shortcode","example":"DRhvwVLAHAG"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/media_id_to_shortcode":{"get":{"tags":["Instagram-V1-API"],"summary":"Media ID转Shortcode/Convert media ID to shortcode","description":"# [中文]\n### 用途:\n- 将Instagram帖子的Media ID转换为Shortcode\n- Shortcode可用于构建帖子URL：instagram.com/p/{shortcode}/\n### 参数:\n- media_id: 帖子的Media ID\n### 返回:\n- `status`: 转换状态\n- `media_id`: 原始Media ID\n- `shortcode`: 转换后的Shortcode\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Convert Instagram post media ID to shortcode\n- Shortcode can be used to construct post URL: instagram.com/p/{shortcode}/\n### Parameters:\n- media_id: Post media ID\n### Return:\n- `status`: Conversion status\n- `media_id`: Original media ID\n- `shortcode`: Converted shortcode\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nmedia_id = \"3774507992167247878\"","operationId":"media_id_to_shortcode_api_v1_instagram_v1_media_id_to_shortcode_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"media_id","in":"query","required":true,"schema":{"type":"string","description":"帖子Media ID/Post media ID","title":"Media Id"},"description":"帖子Media ID/Post media ID","example":"3774507992167247878"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/user_id_to_username":{"get":{"tags":["Instagram-V1-API"],"summary":"用户ID转用户信息/Get user info by user ID","description":"# [中文]\n### 用途:\n- 通过Instagram用户ID获取用户信息\n- 可用于将用户ID转换为用户名及获取完整用户资料\n### 参数:\n- user_id: 用户ID\n### 返回:\n- `pk`/`pk_id`: 用户ID\n- `username`: 用户名\n- `full_name`: 用户全名\n- `is_private`: 是否私密账户\n- `is_verified`: 是否已认证\n- `profile_pic_url`: 头像URL\n- `biography`: 个人简介\n- `follower_count`: 粉丝数\n- `following_count`: 关注数\n- `media_count`: 帖子数\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user info by Instagram user ID\n- Can be used to convert user ID to username and get full profile\n### Parameters:\n- user_id: User ID\n### Return:\n- `pk`/`pk_id`: User ID\n- `username`: Username\n- `full_name`: Full name\n- `is_private`: Whether account is private\n- `is_verified`: Whether account is verified\n- `profile_pic_url`: Profile picture URL\n- `biography`: Bio\n- `follower_count`: Followers count\n- `following_count`: Following count\n- `media_count`: Posts count\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"18527\"","operationId":"user_id_to_username_api_v1_instagram_v1_user_id_to_username_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_info_by_username":{"get":{"tags":["Instagram-V1-API"],"summary":"根据用户名获取用户数据/Get user data by username","description":"# [中文]\n### 用途:\n- 根据Instagram用户名获取用户数据\n### 参数:\n- username: Instagram用户名\n### 返回:\n- 用户信息对象，包含以下主要字段：\n  - `id`: 用户ID\n  - `username`: 用户名\n  - `full_name`: 用户全名\n  - `biography`: 个人简介\n  - `bio_links`: 个人简介链接列表\n  - `edge_followed_by`: 粉丝数 {count: xxx}\n  - `edge_follow`: 关注数 {count: xxx}\n  - `profile_pic_url`: 头像URL\n  - `profile_pic_url_hd`: 高清头像URL\n  - `is_private`: 是否私密账户\n  - `is_verified`: 是否已认证\n  - `external_url`: 外部链接\n  - `is_business_account`: 是否商业账户\n  - `is_professional_account`: 是否专业账户\n  - `highlight_reel_count`: 精选集数量\n  - `edge_owner_to_timeline_media`: 时间线媒体（包含最近帖子）\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user data by Instagram username\n### Parameters:\n- username: Instagram username\n### Return:\n- User information object with main fields:\n  - `id`: User ID\n  - `username`: Username\n  - `full_name`: Full name\n  - `biography`: Bio\n  - `bio_links`: Bio links list\n  - `edge_followed_by`: Followers count {count: xxx}\n  - `edge_follow`: Following count {count: xxx}\n  - `profile_pic_url`: Profile picture URL\n  - `profile_pic_url_hd`: HD profile picture URL\n  - `is_private`: Whether account is private\n  - `is_verified`: Whether account is verified\n  - `external_url`: External link\n  - `is_business_account`: Whether business account\n  - `is_professional_account`: Whether professional account\n  - `highlight_reel_count`: Highlights count\n  - `edge_owner_to_timeline_media`: Timeline media (contains recent posts)\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_info_by_username_api_v1_instagram_v1_fetch_user_info_by_username_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户名/Instagram username","title":"Username"},"description":"Instagram用户名/Instagram username","example":"instagram"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_info_by_username_v2":{"get":{"tags":["Instagram-V1-API"],"summary":"根据用户名获取用户数据V2/Get user data by username V2","description":"# [中文]\n### 用途:\n- 根据Instagram用户名获取用户数据\n### 参数:\n- username: Instagram用户名\n### 返回:\n- 用户信息对象，包含以下主要字段：\n  - `id`: 用户ID\n  - `username`: 用户名\n  - `full_name`: 用户全名\n  - `biography`: 个人简介\n  - `bio_links`: 个人简介链接列表\n  - `edge_followed_by`: 粉丝数 {count: xxx}\n  - `edge_follow`: 关注数 {count: xxx}\n  - `profile_pic_url`: 头像URL\n  - `profile_pic_url_hd`: 高清头像URL\n  - `is_private`: 是否私密账户\n  - `is_verified`: 是否已认证\n  - `external_url`: 外部链接\n  - `is_business_account`: 是否商业账户\n  - `is_professional_account`: 是否专业账户\n  - `highlight_reel_count`: 精选集数量\n  - `edge_owner_to_timeline_media`: 时间线媒体（包含最近12条帖子）\n  - `status`: 请求状态\n  - `attempts`: 尝试次数\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user data by Instagram username\n### Parameters:\n- username: Instagram username\n### Return:\n- User information object with main fields:\n  - `id`: User ID\n  - `username`: Username\n  - `full_name`: Full name\n  - `biography`: Bio\n  - `bio_links`: Bio links list\n  - `edge_followed_by`: Followers count {count: xxx}\n  - `edge_follow`: Following count {count: xxx}\n  - `profile_pic_url`: Profile picture URL\n  - `profile_pic_url_hd`: HD profile picture URL\n  - `is_private`: Whether account is private\n  - `is_verified`: Whether account is verified\n  - `external_url`: External link\n  - `is_business_account`: Whether business account\n  - `is_professional_account`: Whether professional account\n  - `highlight_reel_count`: Highlights count\n  - `edge_owner_to_timeline_media`: Timeline media (contains recent 12 posts)\n  - `status`: Request status\n  - `attempts`: Retry attempts\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_info_by_username_v2_api_v1_instagram_v1_fetch_user_info_by_username_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户名/Instagram username","title":"Username"},"description":"Instagram用户名/Instagram username","example":"instagram"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_info_by_username_v3":{"get":{"tags":["Instagram-V1-API"],"summary":"根据用户名获取用户数据V3/Get user data by username V3","description":"# [中文]\n### 用途:\n- 根据Instagram用户名获取用户数据，返回更详细的信息\n### 参数:\n- username: Instagram用户名\n### 返回:\n- 用户信息对象，包含以下主要字段：\n  - `pk/id`: 用户ID\n  - `username`: 用户名\n  - `full_name`: 用户全名\n  - `biography`: 个人简介\n  - `bio_links`: 个人简介链接列表\n  - `follower_count`: 粉丝数\n  - `following_count`: 关注数\n  - `media_count`: 媒体数量\n  - `profile_pic_url`: 头像URL\n  - `hd_profile_pic_url_info`: 高清头像URL信息\n  - `is_private`: 是否私密账户\n  - `is_verified`: 是否已认证\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user data by Instagram username with more details\n### Parameters:\n- username: Instagram username\n### Return:\n- User information object with main fields:\n  - `pk/id`: User ID\n  - `username`: Username\n  - `full_name`: Full name\n  - `biography`: Bio\n  - `bio_links`: Bio links list\n  - `follower_count`: Followers count\n  - `following_count`: Following count\n  - `media_count`: Media count\n  - `profile_pic_url`: Profile picture URL\n  - `hd_profile_pic_url_info`: HD profile picture URL info\n  - `is_private`: Whether account is private\n  - `is_verified`: Whether account is verified\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_info_by_username_v3_api_v1_instagram_v1_fetch_user_info_by_username_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户名/Instagram username","title":"Username"},"description":"Instagram用户名/Instagram username","example":"instagram"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_info_by_id":{"get":{"tags":["Instagram-V1-API"],"summary":"根据用户ID获取用户数据/Get user data by user ID","description":"# [中文]\n### 用途:\n- 根据Instagram用户ID获取用户数据\n### 参数:\n- user_id: Instagram用户ID\n### 返回:\n- 用户信息对象，包含时间线媒体、高清头像等完整数据\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user data by Instagram user ID\n### Parameters:\n- user_id: Instagram user ID\n### Return:\n- User information object with timeline media, HD avatar and complete data\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"25025320\"","operationId":"fetch_user_info_by_id_api_v1_instagram_v1_fetch_user_info_by_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户ID/Instagram user ID","title":"User Id"},"description":"Instagram用户ID/Instagram user ID","example":"25025320"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_info_by_id_v2":{"get":{"tags":["Instagram-V1-API"],"summary":"根据用户ID获取用户数据V2/Get user data by user ID V2","description":"# [中文]\n### 用途:\n- 根据Instagram用户ID获取用户数据，返回更详细的信息\n### 参数:\n- user_id: Instagram用户ID\n### 返回:\n- 用户信息对象，包含bio_links、hd_profile_pic_url_info等更多字段\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user data by Instagram user ID with more details\n### Parameters:\n- user_id: Instagram user ID\n### Return:\n- User information object with bio_links, hd_profile_pic_url_info and more\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"25025320\"","operationId":"fetch_user_info_by_id_v2_api_v1_instagram_v1_fetch_user_info_by_id_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户ID/Instagram user ID","title":"User Id"},"description":"Instagram用户ID/Instagram user ID","example":"25025320"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_about_info":{"get":{"tags":["Instagram-V1-API"],"summary":"获取用户的About信息/Get user about info","description":"# [中文]\n### 用途:\n- 获取用户的\"关于此账户\"（About This Account）信息\n- 包含账户创建日期、所在地区、认证状态等详细信息\n### 参数:\n- user_id: Instagram用户ID（数字格式）\n### 返回:\n- `status`: 请求状态\n- `user_id`: 用户ID\n- `username`: 用户名\n- `profile_pic_url`: 头像URL\n- `is_verified`: 是否认证\n- `date_joined`: 账户创建日期（如：\"June 2012\"）\n- `account_based_in`: 账户所在地区（如：\"United States\"）\n- `verified_date`: 认证日期（如：\"August 2017\"，未认证则为None）\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user's \"About This Account\" information\n- Contains account creation date, location, verification status and more\n### Parameters:\n- user_id: Instagram user ID (numeric format)\n### Return:\n- `status`: Request status\n- `user_id`: User ID\n- `username`: Username\n- `profile_pic_url`: Profile picture URL\n- `is_verified`: Whether verified\n- `date_joined`: Account creation date (e.g., \"June 2012\")\n- `account_based_in`: Account location (e.g., \"United States\")\n- `verified_date`: Verification date (e.g., \"August 2017\", None if not verified)\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"182988865\"","operationId":"fetch_user_about_info_api_v1_instagram_v1_fetch_user_about_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户ID/Instagram user ID","title":"User Id"},"description":"Instagram用户ID/Instagram user ID","example":"182988865"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_posts":{"get":{"tags":["Instagram-V1-API"],"summary":"获取用户帖子列表/Get user posts list","description":"# [中文]\n### 用途:\n- 获取用户帖子列表，支持分页\n### 参数:\n- user_id: Instagram用户ID\n- count: 每页数量，默认12\n- max_id: 分页游标，首次请求不传\n### 返回:\n- `items`: 帖子列表\n- `more_available`: 是否有更多数据\n- `next_max_id`: 下一页游标\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user posts list with pagination support\n### Parameters:\n- user_id: Instagram user ID\n- count: Count per page, default 12\n- max_id: Pagination cursor, omit for first request\n### Return:\n- `items`: Posts list\n- `more_available`: Whether more data available\n- `next_max_id`: Next page cursor\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"25025320\"","operationId":"fetch_user_posts_api_v1_instagram_v1_fetch_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户ID/Instagram user ID","title":"User Id"},"description":"Instagram用户ID/Instagram user ID","example":"25025320"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"每页数量/Count per page","default":12,"title":"Count"},"description":"每页数量/Count per page"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，用于获取下一页/Pagination cursor for next page","title":"Max Id"},"description":"分页游标，用于获取下一页/Pagination cursor for next page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_posts_v2":{"get":{"tags":["Instagram-V1-API"],"summary":"获取用户帖子列表V2/Get user posts list V2","description":"# [中文]\n### 用途:\n- 获取用户帖子列表，支持分页\n### 参数:\n- user_id: Instagram用户ID\n- count: 每页数量，默认12\n- end_cursor: 分页游标，首次请求不传\n### 返回:\n- GraphQL风格响应，包含`data.user.edge_owner_to_timeline_media`\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user posts list with pagination\n### Parameters:\n- user_id: Instagram user ID\n- count: Count per page, default 12\n- end_cursor: Pagination cursor, omit for first request\n### Return:\n- GraphQL style response with `data.user.edge_owner_to_timeline_media`\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"25025320\"","operationId":"fetch_user_posts_v2_api_v1_instagram_v1_fetch_user_posts_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户ID/Instagram user ID","title":"User Id"},"description":"Instagram用户ID/Instagram user ID","example":"25025320"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"每页数量/Count per page","default":12,"title":"Count"},"description":"每页数量/Count per page"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，用于获取下一页/Pagination cursor for next page","title":"End Cursor"},"description":"分页游标，用于获取下一页/Pagination cursor for next page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_reels":{"get":{"tags":["Instagram-V1-API"],"summary":"获取用户Reels列表/Get user Reels list","description":"# [中文]\n### 用途:\n- 获取用户Reels短视频列表，支持分页\n### 参数:\n- user_id: Instagram用户ID\n- count: 每页数量，默认12\n- max_id: 分页游标，首次请求不传\n### 返回:\n- `items`: Reels列表\n- `paging_info`: 分页信息\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user Reels list with pagination\n### Parameters:\n- user_id: Instagram user ID\n- count: Count per page, default 12\n- max_id: Pagination cursor, omit for first request\n### Return:\n- `items`: Reels list\n- `paging_info`: Pagination info\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"25025320\"","operationId":"fetch_user_reels_api_v1_instagram_v1_fetch_user_reels_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户ID/Instagram user ID","title":"User Id"},"description":"Instagram用户ID/Instagram user ID","example":"25025320"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"每页数量/Count per page","default":12,"title":"Count"},"description":"每页数量/Count per page"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，用于获取下一页/Pagination cursor for next page","title":"Max Id"},"description":"分页游标，用于获取下一页/Pagination cursor for next page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_reposts":{"get":{"tags":["Instagram-V1-API"],"summary":"获取用户转发列表/Get user reposts list","description":"# [中文]\n### 用途:\n- 获取用户转发/分享的帖子列表，支持分页\n### 参数:\n- user_id: Instagram用户ID\n- max_id: 分页游标，首次请求不传\n### 返回:\n- `items`: 转发帖子列表\n- `more_available`: 是否有更多数据\n- `next_max_id`: 下一页游标\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get user reposts/shares list with pagination\n### Parameters:\n- user_id: Instagram user ID\n- max_id: Pagination cursor, omit for first request\n### Return:\n- `items`: Reposts list\n- `more_available`: Whether more data available\n- `next_max_id`: Next page cursor\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"25025320\"","operationId":"fetch_user_reposts_api_v1_instagram_v1_fetch_user_reposts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户ID/Instagram user ID","title":"User Id"},"description":"Instagram用户ID/Instagram user ID","example":"25025320"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，用于获取下一页/Pagination cursor for next page","title":"Max Id"},"description":"分页游标，用于获取下一页/Pagination cursor for next page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_user_tagged_posts":{"get":{"tags":["Instagram-V1-API"],"summary":"获取用户被标记的帖子/Get user tagged posts","description":"# [中文]\n### 用途:\n- 获取其他用户帖子中标记了该用户的帖子列表\n### 参数:\n- user_id: Instagram用户ID\n- count: 每页数量，默认12\n- end_cursor: 分页游标，首次请求不传\n### 返回:\n- GraphQL风格响应，包含`data.user.edge_user_to_photos_of_you`\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get posts where this user is tagged by others\n### Parameters:\n- user_id: Instagram user ID\n- count: Count per page, default 12\n- end_cursor: Pagination cursor, omit for first request\n### Return:\n- GraphQL style response with `data.user.edge_user_to_photos_of_you`\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"25025320\"","operationId":"fetch_user_tagged_posts_api_v1_instagram_v1_fetch_user_tagged_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户ID/Instagram user ID","title":"User Id"},"description":"Instagram用户ID/Instagram user ID","example":"25025320"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"每页数量/Count per page","default":12,"title":"Count"},"description":"每页数量/Count per page"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，用于获取下一页/Pagination cursor for next page","title":"End Cursor"},"description":"分页游标，用于获取下一页/Pagination cursor for next page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_related_profiles":{"get":{"tags":["Instagram-V1-API"],"summary":"获取相关用户推荐/Get related profiles","description":"# [中文]\n### 用途:\n- 获取与指定用户相关/相似的用户推荐列表\n### 参数:\n- user_id: Instagram用户ID\n### 返回:\n- GraphQL风格响应，包含`data.user.edge_related_profiles`\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get related/similar user recommendations\n### Parameters:\n- user_id: Instagram user ID\n### Return:\n- GraphQL style response with `data.user.edge_related_profiles`\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nuser_id = \"25025320\"","operationId":"fetch_related_profiles_api_v1_instagram_v1_fetch_related_profiles_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"Instagram用户ID/Instagram user ID","title":"User Id"},"description":"Instagram用户ID/Instagram user ID","example":"25025320"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_search":{"get":{"tags":["Instagram-V1-API"],"summary":"搜索用户/话题/地点/Search users/hashtags/places","description":"# [中文]\n### 用途:\n- 根据关键词搜索Instagram上的用户、话题标签或地点\n### 参数:\n- query: 搜索关键词\n- select: 筛选类型（可选）\n  - `users`: 仅返回用户\n  - `hashtags`: 仅返回话题标签\n  - `places`: 仅返回地点\n  - 不传: 返回所有类型\n### 返回:\n- `users`: 用户列表\n- `hashtags`: 话题列表\n- `places`: 地点列表\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Search users, hashtags or places on Instagram\n### Parameters:\n- query: Search keyword\n- select: Filter type (optional)\n  - `users`: Only return users\n  - `hashtags`: Only return hashtags\n  - `places`: Only return places\n  - omit: Return all types\n### Return:\n- `users`: Users list\n- `hashtags`: Hashtags list\n- `places`: Places list\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nquery = \"taylorswift\"\nselect = \"users\"","operationId":"fetch_search_api_v1_instagram_v1_fetch_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"taylorswift"},{"name":"select","in":"query","required":false,"schema":{"type":"string","description":"筛选类型：users/hashtags/places，不传则返回全部/Filter type: users/hashtags/places, omit for all","title":"Select"},"description":"筛选类型：users/hashtags/places，不传则返回全部/Filter type: users/hashtags/places, omit for all"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_post_by_url":{"get":{"tags":["Instagram-V1-API"],"summary":"通过URL获取帖子详情/Get post by URL","description":"# [中文]\n### 用途:\n- 通过URL获取单个帖子的详细信息\n### 参数:\n- post_url: 帖子URL\n### 返回:\n- 帖子详情对象，包含媒体、点赞数、评论等\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get single post details by URL\n### Parameters:\n- post_url: Post URL\n### Return:\n- Post details object with media, likes, comments etc.\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\npost_url = \"https://www.instagram.com/p/DPwhVB-jo9k/\"","operationId":"fetch_post_by_url_api_v1_instagram_v1_fetch_post_by_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_url","in":"query","required":true,"schema":{"type":"string","description":"帖子URL/Post URL","title":"Post Url"},"description":"帖子URL/Post URL","example":"https://www.instagram.com/p/DPwhVB-jo9k/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_post_by_url_v2":{"get":{"tags":["Instagram-V1-API"],"summary":"通过URL获取帖子详情 V2/Get post by URL V2","description":"# [中文]\n### 用途:\n- 通过URL获取单个帖子的详细信息 V2 - 数据没有V1完整，但速度更快，用于下载大量帖子时推荐使用。\n### 参数:\n- post_url: 帖子URL\n### 返回:\n- 帖子详情对象，包含媒体、点赞数、评论等\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get single post details by URL V2 - Data is not as complete as V1, but faster. Recommended for downloading large number of posts.\n### Parameters:\n- post_url: Post URL\n### Return:\n- Post details object with media, likes, comments etc.\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\npost_url = \"https://www.instagram.com/p/DPwhVB-jo9k/\"","operationId":"fetch_post_by_url_v2_api_v1_instagram_v1_fetch_post_by_url_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_url","in":"query","required":true,"schema":{"type":"string","description":"帖子URL/Post URL","title":"Post Url"},"description":"帖子URL/Post URL","example":"https://www.instagram.com/p/DPwhVB-jo9k/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_post_by_id":{"get":{"tags":["Instagram-V1-API"],"summary":"通过ID获取帖子详情/Get post by ID","description":"# [中文]\n### 用途:\n- 通过ID获取单个帖子的详细信息\n### 参数:\n- post_id: 帖子ID\n### 返回:\n- 帖子详情对象，包含媒体、点赞数、评论等\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get single post details by ID\n### Parameters:\n- post_id: Post ID\n### Return:\n- Post details object with media, likes, comments etc.\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\npost_id = \"3742637871112032100\"","operationId":"fetch_post_by_id_api_v1_instagram_v1_fetch_post_by_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":true,"schema":{"type":"string","description":"帖子ID/Post ID","title":"Post Id"},"description":"帖子ID/Post ID","example":"3742637871112032100"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_post_comments_v2":{"get":{"tags":["Instagram-V1-API"],"summary":"获取帖子评论列表V2/Get post comments V2","description":"# [中文]\n### 用途:\n- 获取帖子评论列表，支持分页\n- 返回的评论数据更完整，包含子评论预览和更多元数据\n### 参数:\n- media_id: 帖子ID（媒体ID）\n- sort_order: 排序方式，popular(热门)/recent(最新)\n- min_id: 分页游标，首次请求不传，从上一次响应的`next_min_id`字段获取\n### 返回:\n- `comment_count`: 评论总数\n- `comments`: 评论列表，每个评论包含：\n  - `pk`: 评论ID\n  - `text`: 评论内容\n  - `created_at`/`created_at_utc`: 评论时间戳\n  - `user`: 评论者信息（pk, username, full_name, is_verified, profile_pic_url等）\n  - `comment_like_count`: 评论点赞数\n  - `child_comment_count`: 子评论数量\n  - `preview_child_comments`: 子评论预览列表\n  - `is_liked_by_media_owner`: 是否被帖子作者点赞\n  - `has_translation`: 是否有翻译\n- `next_min_id`: 下一页游标（JSON格式字符串）\n- `has_more_headload_comments`: 是否有更多评论\n- `caption`: 帖子描述信息\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get post comments list with pagination\n- Returns more complete comment data including child comment previews and more metadata\n### Parameters:\n- media_id: Post ID (Media ID)\n- sort_order: Sorting method, popular/recent\n- min_id: Pagination cursor, omit for first request, get from previous response's `next_min_id`\n### Return:\n- `comment_count`: Total comments count\n- `comments`: Comments list, each comment contains:\n  - `pk`: Comment ID\n  - `text`: Comment content\n  - `created_at`/`created_at_utc`: Comment timestamp\n  - `user`: Commenter info (pk, username, full_name, is_verified, profile_pic_url etc.)\n  - `comment_like_count`: Comment likes count\n  - `child_comment_count`: Child comments count\n  - `preview_child_comments`: Child comments preview list\n  - `is_liked_by_media_owner`: Whether liked by post author\n  - `has_translation`: Whether translation available\n- `next_min_id`: Next page cursor (JSON format string)\n- `has_more_headload_comments`: Whether more comments available\n- `caption`: Post caption info\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nmedia_id = \"3766120364183949816\"\nsort_order = \"recent\"","operationId":"fetch_post_comments_v2_api_v1_instagram_v1_fetch_post_comments_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"media_id","in":"query","required":true,"schema":{"type":"string","description":"帖子ID（媒体ID）/Post ID (Media ID)","title":"Media Id"},"description":"帖子ID（媒体ID）/Post ID (Media ID)","example":"3766120364183949816"},{"name":"sort_order","in":"query","required":false,"schema":{"type":"string","description":"排序方式：popular(热门)/recent(最新)/Sorting: popular/recent","default":"recent","title":"Sort Order"},"description":"排序方式：popular(热门)/recent(最新)/Sorting: popular/recent","example":"recent"},{"name":"min_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，从上一次响应的next_min_id获取/Pagination cursor from previous response's next_min_id","title":"Min Id"},"description":"分页游标，从上一次响应的next_min_id获取/Pagination cursor from previous response's next_min_id","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_comment_replies":{"get":{"tags":["Instagram-V1-API"],"summary":"获取评论的子评论列表/Get comment replies","description":"# [中文]\n### 用途:\n- 获取指定评论下的子评论（二级评论/回复），支持分页\n### 参数:\n- media_id: 帖子ID（媒体ID）\n- comment_id: 父评论ID（从fetch_post_comments_v2返回的评论pk字段获取）\n- min_id: 分页游标，首次请求不传，从上一次响应的`page_info.next_min_id`字段获取\n### 返回:\n- `child_comments`: 子评论列表，每个评论包含：\n  - `pk`: 评论ID\n  - `text`: 评论内容\n  - `created_at`/`created_at_utc`: 评论时间戳\n  - `user`: 评论者信息（pk, username, full_name, is_verified, profile_pic_url等）\n  - `comment_like_count`: 评论点赞数\n  - `parent_comment_id`: 父评论ID\n  - `has_translation`: 是否有翻译\n- `child_comment_count`: 子评论总数\n- `has_more_tail_child_comments`: 是否有更多子评论\n- `next_min_child_cursor`: 下一页游标\n- `page_info`: 分页信息汇总\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get child comments (replies) under a specific comment with pagination\n### Parameters:\n- media_id: Post ID (Media ID)\n- comment_id: Parent comment ID (get from pk field in fetch_post_comments_v2 response)\n- min_id: Pagination cursor, omit for first request, get from previous response's `page_info.next_min_id`\n### Return:\n- `child_comments`: Child comment list, each comment contains:\n  - `pk`: Comment ID\n  - `text`: Comment content\n  - `created_at`/`created_at_utc`: Comment timestamp\n  - `user`: Commenter info (pk, username, full_name, is_verified, profile_pic_url, etc.)\n  - `comment_like_count`: Comment like count\n  - `parent_comment_id`: Parent comment ID\n  - `has_translation`: Has translation\n- `child_comment_count`: Total child comment count\n- `has_more_tail_child_comments`: Has more child comments\n- `next_min_child_cursor`: Next page cursor\n- `page_info`: Pagination info summary\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nmedia_id = \"3766120364183949816\"\ncomment_id = \"17871667485468098\"\nmin_id = \"\"","operationId":"fetch_comment_replies_api_v1_instagram_v1_fetch_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"media_id","in":"query","required":true,"schema":{"type":"string","description":"帖子ID（媒体ID）/Post ID (Media ID)","title":"Media Id"},"description":"帖子ID（媒体ID）/Post ID (Media ID)","example":"3766120364183949816"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"父评论ID/Parent comment ID","title":"Comment Id"},"description":"父评论ID/Parent comment ID","example":"17871667485468098"},{"name":"min_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，从上一次响应的next_min_id获取/Pagination cursor from previous response's next_min_id","title":"Min Id"},"description":"分页游标，从上一次响应的next_min_id获取/Pagination cursor from previous response's next_min_id","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_music_posts":{"get":{"tags":["Instagram-V1-API"],"summary":"获取使用特定音乐的帖子/Get posts using specific music","description":"# [中文]\n### 用途:\n- 获取使用指定音乐/音频的Reels和帖子列表\n### 参数:\n- music_id: 音乐ID（与music_url二选一）\n- music_url: 音乐URL，会自动提取ID（与music_id二选一）\n- max_id: 分页游标，首次请求不传\n### 返回:\n- `items`: 帖子列表\n- `metadata`: 音乐元数据\n- `paging_info`: 分页信息\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get Reels and posts using specific music/audio\n### Parameters:\n- music_id: Music ID (alternative to music_url)\n- music_url: Music URL, ID will be extracted automatically (alternative to music_id)\n- max_id: Pagination cursor, omit for first request\n### Return:\n- `items`: Posts list\n- `metadata`: Music metadata\n- `paging_info`: Pagination info\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nmusic_id = \"564058920086577\"","operationId":"fetch_music_posts_api_v1_instagram_v1_fetch_music_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"music_id","in":"query","required":false,"schema":{"type":"string","description":"音乐ID/Music ID","title":"Music Id"},"description":"音乐ID/Music ID","example":"564058920086577"},{"name":"music_url","in":"query","required":false,"schema":{"type":"string","description":"音乐URL（与music_id二选一）/Music URL (alternative to music_id)","title":"Music Url"},"description":"音乐URL（与music_id二选一）/Music URL (alternative to music_id)","example":"https://www.instagram.com/reels/audio/564058920086577"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，用于获取下一页/Pagination cursor for next page","title":"Max Id"},"description":"分页游标，用于获取下一页/Pagination cursor for next page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_hashtag_posts":{"get":{"tags":["Instagram-V1-API"],"summary":"获取话题标签下的帖子/Get posts by hashtag","description":"# [中文]\n### 用途:\n- 获取指定话题标签下的帖子列表\n### 参数:\n- hashtag: 话题标签名称（不含#号）\n- end_cursor: 分页游标，首次请求不传\n### 返回:\n- GraphQL风格响应，包含`data.hashtag.edge_hashtag_to_media`\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get posts under specific hashtag\n### Parameters:\n- hashtag: Hashtag name (without #)\n- end_cursor: Pagination cursor, omit for first request\n### Return:\n- GraphQL style response with `data.hashtag.edge_hashtag_to_media`\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nhashtag = \"cat\"","operationId":"fetch_hashtag_posts_api_v1_instagram_v1_fetch_hashtag_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"hashtag","in":"query","required":true,"schema":{"type":"string","description":"话题标签名称（不含#号）/Hashtag name (without #)","title":"Hashtag"},"description":"话题标签名称（不含#号）/Hashtag name (without #)","example":"cat"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，用于获取下一页/Pagination cursor for next page","title":"End Cursor"},"description":"分页游标，用于获取下一页/Pagination cursor for next page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_location_info":{"get":{"tags":["Instagram-V1-API"],"summary":"获取地点信息/Get location info","description":"# [中文]\n### 用途:\n- 获取指定地点的详细信息\n### 参数:\n- location_id: 地点ID\n### 返回:\n- `location_info`: 地点信息，包含名称、地址、坐标等\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get detailed information of specified location\n### Parameters:\n- location_id: Location ID\n### Return:\n- `location_info`: Location info including name, address, coordinates etc.\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nlocation_id = \"703457703\"","operationId":"fetch_location_info_api_v1_instagram_v1_fetch_location_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"location_id","in":"query","required":true,"schema":{"type":"string","description":"地点ID/Location ID","title":"Location Id"},"description":"地点ID/Location ID","example":"703457703"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_location_posts":{"get":{"tags":["Instagram-V1-API"],"summary":"获取地点下的帖子/Get posts by location","description":"# [中文]\n### 用途:\n- 获取指定地点标记的帖子列表\n### 参数:\n- location_id: 地点ID\n- tab: 排序方式，ranked(热门)/recent(最新)\n- end_cursor: 分页游标，首次请求不传\n### 返回:\n- `edges`: 帖子列表\n- `page_info`: 分页信息\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get posts tagged at specified location\n### Parameters:\n- location_id: Location ID\n- tab: Sorting method, ranked(top)/recent(latest)\n- end_cursor: Pagination cursor, omit for first request\n### Return:\n- `edges`: Posts list\n- `page_info`: Pagination info\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nlocation_id = \"703457703\"","operationId":"fetch_location_posts_api_v1_instagram_v1_fetch_location_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"location_id","in":"query","required":true,"schema":{"type":"string","description":"地点ID/Location ID","title":"Location Id"},"description":"地点ID/Location ID","example":"703457703"},{"name":"tab","in":"query","required":false,"schema":{"type":"string","description":"排序方式：ranked(热门)/recent(最新)/Sorting: ranked(top)/recent(latest)","default":"ranked","title":"Tab"},"description":"排序方式：ranked(热门)/recent(最新)/Sorting: ranked(top)/recent(latest)"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标，用于获取下一页/Pagination cursor for next page","title":"End Cursor"},"description":"分页游标，用于获取下一页/Pagination cursor for next page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_cities":{"get":{"tags":["Instagram-V1-API"],"summary":"获取国家城市列表/Get cities by country","description":"# [中文]\n### 用途:\n- 获取指定国家的城市/地区列表\n### 参数:\n- country_code: 国家代码，如US、CN、JP\n- page: 页码，默认1\n### 返回:\n- `country_info`: 国家信息\n- `city_list`: 城市列表\n- `next_page`: 下一页页码\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get cities/regions list of specified country\n### Parameters:\n- country_code: Country code, e.g. US, CN, JP\n- page: Page number, default 1\n### Return:\n- `country_info`: Country info\n- `city_list`: Cities list\n- `next_page`: Next page number\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\ncountry_code = \"US\"","operationId":"fetch_cities_api_v1_instagram_v1_fetch_cities_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"country_code","in":"query","required":true,"schema":{"type":"string","description":"国家代码（如US、CN、JP）/Country code (e.g. US, CN, JP)","title":"Country Code"},"description":"国家代码（如US、CN、JP）/Country code (e.g. US, CN, JP)","example":"US"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_locations":{"get":{"tags":["Instagram-V1-API"],"summary":"获取城市地点列表/Get locations by city","description":"# [中文]\n### 用途:\n- 获取指定城市下的Instagram地点列表\n### 参数:\n- city_id: 城市ID（可从fetch_cities接口获取）\n- page: 页码，默认1\n### 返回:\n- `country_info`: 国家信息\n- `city_info`: 城市信息\n- `location_list`: 地点列表\n- `next_page`: 下一页页码\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram locations list of specified city\n### Parameters:\n- city_id: City ID (from fetch_cities API)\n- page: Page number, default 1\n### Return:\n- `country_info`: Country info\n- `city_info`: City info\n- `location_list`: Locations list\n- `next_page`: Next page number\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\ncity_id = \"c2791472\"","operationId":"fetch_locations_api_v1_instagram_v1_fetch_locations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"city_id","in":"query","required":true,"schema":{"type":"string","description":"城市ID（从fetch_cities获取）/City ID (from fetch_cities)","title":"City Id"},"description":"城市ID（从fetch_cities获取）/City ID (from fetch_cities)","example":"c2791472"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v1/fetch_explore_sections":{"get":{"tags":["Instagram-V1-API"],"summary":"获取探索页面分类/Get explore page sections","description":"# [中文]\n### 用途:\n- 获取Instagram探索页面的所有分类和子分类\n### 返回:\n- `sections`: 分类列表，包含分类名称、子分类和推荐内容\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get all sections and subsections of Instagram explore page\n### Return:\n- `sections`: Sections list with names, subsections and recommended content\n### Price:\n- 0.001 USD/request","operationId":"fetch_explore_sections_api_v1_instagram_v1_fetch_explore_sections_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/instagram/v1/fetch_section_posts":{"get":{"tags":["Instagram-V1-API"],"summary":"获取分类下的帖子/Get posts by section","description":"# [中文]\n### 用途:\n- 获取探索页面某个分类下的帖子列表\n### 参数:\n- section_id: 分类ID（可从fetch_explore_sections接口获取）\n- count: 每页数量，默认20\n- max_id: 分页游标，首次请求不传\n### 返回:\n- `section_name`: 分类名称\n- `items`: 帖子列表\n- `subsections`: 子分类列表\n- `max_id`: 下一页游标\n- `more_available`: 是否有更多数据\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Get posts under specific explore section\n### Parameters:\n- section_id: Section ID (from fetch_explore_sections API)\n- count: Count per page, default 20\n- max_id: Pagination cursor, omit for first request\n### Return:\n- `section_name`: Section name\n- `items`: Posts list\n- `subsections`: Subsections list\n- `max_id`: Next page cursor\n- `more_available`: Whether more data available\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nsection_id = \"10156104410190727\"","operationId":"fetch_section_posts_api_v1_instagram_v1_fetch_section_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"section_id","in":"query","required":true,"schema":{"type":"string","description":"分类ID（从fetch_explore_sections获取）/Section ID (from fetch_explore_sections)","title":"Section Id"},"description":"分类ID（从fetch_explore_sections获取）/Section ID (from fetch_explore_sections)","example":"10156104410190727"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"每页数量/Count per page","default":20,"title":"Count"},"description":"每页数量/Count per page"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，用于获取下一页/Pagination cursor for next page","title":"Max Id"},"description":"分页游标，用于获取下一页/Pagination cursor for next page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/shortcode_to_media_id":{"get":{"tags":["Instagram-V2-API"],"summary":"Shortcode转Media ID/Convert shortcode to media ID","description":"# [中文]\n### 用途:\n- 将Instagram帖子的Shortcode转换为Media ID\n- Shortcode是帖子URL中的唯一标识，如 instagram.com/p/DRhvwVLAHAG/ 中的 DRhvwVLAHAG\n### 参数:\n- shortcode: 帖子的Shortcode\n### 返回:\n- `status`: 转换状态\n- `shortcode`: 原始Shortcode\n- `media_id`: 转换后的Media ID\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Convert Instagram post shortcode to media ID\n- Shortcode is the unique identifier in post URL, e.g., DRhvwVLAHAG in instagram.com/p/DRhvwVLAHAG/\n### Parameters:\n- shortcode: Post shortcode\n### Return:\n- `status`: Conversion status\n- `shortcode`: Original shortcode\n- `media_id`: Converted media ID\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nshortcode = \"DRhvwVLAHAG\"","operationId":"shortcode_to_media_id_api_v1_instagram_v2_shortcode_to_media_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"shortcode","in":"query","required":true,"schema":{"type":"string","description":"帖子Shortcode/Post shortcode","title":"Shortcode"},"description":"帖子Shortcode/Post shortcode","example":"DRhvwVLAHAG"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/media_id_to_shortcode":{"get":{"tags":["Instagram-V2-API"],"summary":"Media ID转Shortcode/Convert media ID to shortcode","description":"# [中文]\n### 用途:\n- 将Instagram帖子的Media ID转换为Shortcode\n- Shortcode可用于构建帖子URL：instagram.com/p/{shortcode}/\n### 参数:\n- media_id: 帖子的Media ID\n### 返回:\n- `status`: 转换状态\n- `media_id`: 原始Media ID\n- `shortcode`: 转换后的Shortcode\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Convert Instagram post media ID to shortcode\n- Shortcode can be used to construct post URL: instagram.com/p/{shortcode}/\n### Parameters:\n- media_id: Post media ID\n### Return:\n- `status`: Conversion status\n- `media_id`: Original media ID\n- `shortcode`: Converted shortcode\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nmedia_id = \"3774507992167247878\"","operationId":"media_id_to_shortcode_api_v1_instagram_v2_media_id_to_shortcode_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"media_id","in":"query","required":true,"schema":{"type":"string","description":"帖子Media ID/Post media ID","title":"Media Id"},"description":"帖子Media ID/Post media ID","example":"3774507992167247878"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/user_id_to_username":{"get":{"tags":["Instagram-V2-API"],"summary":"用户ID转用户信息/Get user info by user ID","description":"# [中文]\n### 用途:\n- 通过Instagram用户ID获取用户信息\n- 可用于将用户ID转换为用户名及获取完整用户资料\n### 参数:\n- user_id: 用户ID\n### 返回:\n- `pk`/`pk_id`: 用户ID\n- `username`: 用户名\n- `full_name`: 用户全名\n- `is_private`: 是否私密账户\n- `is_verified`: 是否已认证\n- `profile_pic_url`: 头像URL\n- `biography`: 个人简介\n- `follower_count`: 粉丝数\n- `following_count`: 关注数\n- `media_count`: 帖子数\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get user info by Instagram user ID\n- Can be used to convert user ID to username and get full profile\n### Parameters:\n- user_id: User ID\n### Return:\n- `pk`/`pk_id`: User ID\n- `username`: Username\n- `full_name`: Full name\n- `is_private`: Whether account is private\n- `is_verified`: Whether account is verified\n- `profile_pic_url`: Profile picture URL\n- `biography`: Bio\n- `follower_count`: Followers count\n- `following_count`: Following count\n- `media_count`: Posts count\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nuser_id = \"18527\"","operationId":"user_id_to_username_api_v1_instagram_v2_user_id_to_username_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_user_info":{"get":{"tags":["Instagram-V2-API"],"summary":"获取用户信息/Get user info","description":"# [中文]\n### 用途:\n- 获取Instagram用户的详细信息\n- 支持通过用户名或用户ID查询\n### 参数:\n- username: 用户名（与user_id二选一）\n- user_id: 用户ID（与username二选一）\n### 返回:\n- `data`: 用户信息，包含用户名、头像、简介、粉丝数、关注数、帖子数等\n- 此接口会返回用户的关于信息，包括国家，加入时间，是否认证等信息。\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get detailed Instagram user information\n- Support query by username or user ID\n### Parameters:\n- username: Username (either username or user_id required)\n- user_id: User ID (either username or user_id required)\n### Return:\n- `data`: User info including username, avatar, bio, followers, following, posts count, etc.\n- This endpoint returns user's about info including country, join date, verification status, etc.\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_info_api_v1_instagram_v2_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"instagram"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_user_posts":{"get":{"tags":["Instagram-V2-API"],"summary":"获取用户帖子/Get user posts","description":"# [中文]\n### 用途:\n- 获取Instagram用户发布的帖子列表\n- 支持分页获取\n### 参数:\n- username: 用户名（与user_id二选一）\n- user_id: 用户ID（与username二选一）\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 帖子列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get list of posts published by Instagram user\n- Support pagination\n### Parameters:\n- username: Username (either username or user_id required)\n- user_id: User ID (either username or user_id required)\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of posts\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_posts_api_v1_instagram_v2_fetch_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"instagram"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_user_reels":{"get":{"tags":["Instagram-V2-API"],"summary":"获取用户Reels/Get user reels","description":"# [中文]\n### 用途:\n- 获取Instagram用户发布的Reels短视频列表\n- 支持分页获取\n### 参数:\n- username: 用户名（与user_id二选一）\n- user_id: 用户ID（与username二选一）\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: Reels列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get list of Reels published by Instagram user\n- Support pagination\n### Parameters:\n- username: Username (either username or user_id required)\n- user_id: User ID (either username or user_id required)\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of reels\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_reels_api_v1_instagram_v2_fetch_user_reels_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"instagram"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_user_followers":{"get":{"tags":["Instagram-V2-API"],"summary":"获取用户粉丝/Get user followers","description":"# [中文]\n### 用途:\n- 获取Instagram用户的粉丝列表\n- 支持分页获取\n### 参数:\n- username: 用户名（与user_id二选一）\n- user_id: 用户ID（与username二选一）\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 粉丝列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get list of followers of Instagram user\n- Support pagination\n### Parameters:\n- username: Username (either username or user_id required)\n- user_id: User ID (either username or user_id required)\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of followers\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_followers_api_v1_instagram_v2_fetch_user_followers_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"instagram"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_user_following":{"get":{"tags":["Instagram-V2-API"],"summary":"获取用户关注/Get user following","description":"# [中文]\n### 用途:\n- 获取Instagram用户关注的用户列表\n- 支持分页获取\n### 参数:\n- username: 用户名（与user_id二选一）\n- user_id: 用户ID（与username二选一）\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 关注列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get list of users that Instagram user is following\n- Support pagination\n### Parameters:\n- username: Username (either username or user_id required)\n- user_id: User ID (either username or user_id required)\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of following\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_following_api_v1_instagram_v2_fetch_user_following_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"instagram"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_user_stories":{"get":{"tags":["Instagram-V2-API"],"summary":"获取用户故事/Get user stories","description":"# [中文]\n### 用途:\n- 获取Instagram用户当前发布的故事（Stories）\n- 故事在24小时后过期\n### 参数:\n- username: 用户名（与user_id二选一）\n- user_id: 用户ID（与username二选一）\n### 返回:\n- `data.items`: 故事列表，包含图片/视频URL、发布时间等\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get current stories published by Instagram user\n- Stories expire after 24 hours\n### Parameters:\n- username: Username (either username or user_id required)\n- user_id: User ID (either username or user_id required)\n### Return:\n- `data.items`: List of stories with image/video URLs, publish time, etc.\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_stories_api_v1_instagram_v2_fetch_user_stories_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"instagram"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_user_highlights":{"get":{"tags":["Instagram-V2-API"],"summary":"获取用户精选/Get user highlights","description":"# [中文]\n### 用途:\n- 获取Instagram用户的精选故事（Highlights）列表\n- 精选是用户保存的故事合集\n### 参数:\n- username: 用户名（与user_id二选一）\n- user_id: 用户ID（与username二选一）\n### 返回:\n- `data.items`: 精选列表，包含精选ID、标题、封面等\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user's highlights list\n- Highlights are saved story collections\n### Parameters:\n- username: Username (either username or user_id required)\n- user_id: User ID (either username or user_id required)\n### Return:\n- `data.items`: List of highlights with ID, title, cover, etc.\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_highlights_api_v1_instagram_v2_fetch_user_highlights_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"instagram"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_highlight_stories":{"get":{"tags":["Instagram-V2-API"],"summary":"获取精选故事详情/Get highlight stories","description":"# [中文]\n### 用途:\n- 获取指定精选（Highlight）中的所有故事\n- 需要先通过fetch_user_highlights获取精选ID\n### 参数:\n- highlight_id: 精选ID（可带或不带\"highlight:\"前缀）\n### 返回:\n- `data.items`: 故事列表，包含图片/视频URL、发布时间等\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get all stories in a specific highlight\n- Need to get highlight ID from fetch_user_highlights first\n### Parameters:\n- highlight_id: Highlight ID (with or without \"highlight:\" prefix)\n### Return:\n- `data.items`: List of stories with image/video URLs, publish time, etc.\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nhighlight_id = \"17895069621772257\"","operationId":"fetch_highlight_stories_api_v1_instagram_v2_fetch_highlight_stories_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"highlight_id","in":"query","required":true,"schema":{"type":"string","description":"精选ID/Highlight ID","title":"Highlight Id"},"description":"精选ID/Highlight ID","example":"17895069621772257"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_user_tagged_posts":{"get":{"tags":["Instagram-V2-API"],"summary":"获取用户被标记的帖子/Get user tagged posts","description":"# [中文]\n### 用途:\n- 获取其他用户标记了该用户的帖子列表\n- 支持分页获取\n### 参数:\n- username: 用户名（与user_id二选一）\n- user_id: 用户ID（与username二选一）\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 帖子列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get posts where the user is tagged by others\n- Support pagination\n### Parameters:\n- username: Username (either username or user_id required)\n- user_id: User ID (either username or user_id required)\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of posts\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_user_tagged_posts_api_v1_instagram_v2_fetch_user_tagged_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"instagram"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_similar_users":{"get":{"tags":["Instagram-V2-API"],"summary":"获取相似用户/Get similar users","description":"# [中文]\n### 用途:\n- 获取与指定用户相似的用户推荐列表\n- 基于Instagram的推荐算法\n### 参数:\n- username: 用户名（与user_id二选一）\n- user_id: 用户ID（与username二选一）\n### 返回:\n- `data.items`: 相似用户列表\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get recommended similar users\n- Based on Instagram's recommendation algorithm\n### Parameters:\n- username: Username (either username or user_id required)\n- user_id: User ID (either username or user_id required)\n### Return:\n- `data.items`: List of similar users\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nusername = \"instagram\"","operationId":"fetch_similar_users_api_v1_instagram_v2_fetch_similar_users_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"instagram"},{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"18527"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/search_users":{"get":{"tags":["Instagram-V2-API"],"summary":"搜索用户/Search users","description":"# [中文]\n### 用途:\n- 根据关键词搜索Instagram用户\n### 参数:\n- keyword: 搜索关键词\n### 返回:\n- `data.items`: 用户列表\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Search Instagram users by keyword\n### Parameters:\n- keyword: Search keyword\n### Return:\n- `data.items`: List of users\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nkeyword = \"instagram\"","operationId":"search_users_api_v1_instagram_v2_search_users_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"instagram"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/general_search":{"get":{"tags":["Instagram-V2-API"],"summary":"综合搜索/General search","description":"# [中文]\n### 用途:\n- 根据关键词进行Instagram综合搜索\n- 支持分页获取\n### 参数:\n- keyword: 搜索关键词\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 综合搜索结果列表，包含用户、帖子、Reels等\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Perform general search on Instagram by keyword\n- Support pagination\n### Parameters:\n- keyword: Search keyword\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of general search results including users, posts, reels, etc.\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nkeyword = \"cat\"","operationId":"general_search_api_v1_instagram_v2_general_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"cat"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/search_reels":{"get":{"tags":["Instagram-V2-API"],"summary":"搜索Reels/Search reels","description":"# [中文]\n### 用途:\n- 根据关键词搜索Instagram Reels短视频\n- 支持分页获取\n### 参数:\n- keyword: 搜索关键词\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: Reels列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Search Instagram Reels by keyword\n- Support pagination\n### Parameters:\n- keyword: Search keyword\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of reels\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nkeyword = \"cat\"","operationId":"search_reels_api_v1_instagram_v2_search_reels_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"cat"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/search_music":{"get":{"tags":["Instagram-V2-API"],"summary":"搜索音乐/Search music","description":"# [中文]\n### 用途:\n- 根据关键词搜索Instagram上可用的音乐\n### 参数:\n- keyword: 搜索关键词\n### 返回:\n- `data.items`: 音乐列表，包含标题、艺术家、时长、音频ID等\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Search available music on Instagram by keyword\n### Parameters:\n- keyword: Search keyword\n### Return:\n- `data.items`: List of music with title, artist, duration, audio ID, etc.\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nkeyword = \"happy\"","operationId":"search_music_api_v1_instagram_v2_search_music_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"happy"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/search_hashtags":{"get":{"tags":["Instagram-V2-API"],"summary":"搜索话题标签/Search hashtags","description":"# [中文]\n### 用途:\n- 根据关键词搜索Instagram话题标签\n### 参数:\n- keyword: 搜索关键词\n### 返回:\n- `data.items`: 话题标签列表，包含名称、帖子数量等\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Search Instagram hashtags by keyword\n### Parameters:\n- keyword: Search keyword\n### Return:\n- `data.items`: List of hashtags with name, post count, etc.\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nkeyword = \"cat\"","operationId":"search_hashtags_api_v1_instagram_v2_search_hashtags_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"cat"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/search_locations":{"get":{"tags":["Instagram-V2-API"],"summary":"搜索地点/Search locations","description":"# [中文]\n### 用途:\n- 根据关键词搜索Instagram地点\n### 参数:\n- keyword: 搜索关键词（地点名称、城市等）\n### 返回:\n- `data.items`: 地点列表，包含名称、地址、坐标等\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Search Instagram locations by keyword\n### Parameters:\n- keyword: Search keyword (location name, city, etc.)\n### Return:\n- `data.items`: List of locations with name, address, coordinates, etc.\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nkeyword = \"paris\"","operationId":"search_locations_api_v1_instagram_v2_search_locations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"paris"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/search_by_coordinates":{"get":{"tags":["Instagram-V2-API"],"summary":"根据坐标搜索地点/Search locations by coordinates","description":"# [中文]\n### 用途:\n- 根据GPS坐标搜索附近的Instagram地点\n### 参数:\n- latitude: 纬度\n- longitude: 经度\n### 返回:\n- `data.items`: 附近地点列表，包含名称、地址、分类等\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Search nearby Instagram locations by GPS coordinates\n### Parameters:\n- latitude: Latitude\n- longitude: Longitude\n### Return:\n- `data.items`: List of nearby locations with name, address, category, etc.\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nlatitude = 40.7\nlongitude = -74","operationId":"search_by_coordinates_api_v1_instagram_v2_search_by_coordinates_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"latitude","in":"query","required":true,"schema":{"type":"number","description":"纬度/Latitude","title":"Latitude"},"description":"纬度/Latitude","example":40.7},{"name":"longitude","in":"query","required":true,"schema":{"type":"number","description":"经度/Longitude","title":"Longitude"},"description":"经度/Longitude","example":-74}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_post_info":{"get":{"tags":["Instagram-V2-API"],"summary":"获取帖子详情/Get post info","description":"# [中文]\n### 用途:\n- 获取Instagram帖子的详细信息\n- 支持Shortcode或完整URL\n### 参数:\n- code_or_url: 帖子Shortcode或完整URL\n### 返回:\n- `data`: 帖子详情，包含媒体资源、描述、点赞数、评论数等\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get detailed information of Instagram post\n- Support shortcode or full URL\n### Parameters:\n- code_or_url: Post shortcode or full URL\n### Return:\n- `data`: Post details including media, caption, likes, comments, etc.\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\ncode_or_url = \"DRhvwVLAHAG\"","operationId":"fetch_post_info_api_v1_instagram_v2_fetch_post_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code_or_url","in":"query","required":true,"schema":{"type":"string","description":"帖子Shortcode或URL/Post shortcode or URL","title":"Code Or Url"},"description":"帖子Shortcode或URL/Post shortcode or URL","example":"DRhvwVLAHAG"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_post_likes":{"get":{"tags":["Instagram-V2-API"],"summary":"获取帖子点赞列表/Get post likes","description":"# [中文]\n### 用途:\n- 获取帖子的点赞用户列表\n- 支持分页获取\n### 参数:\n- code_or_url: 帖子Shortcode或完整URL\n- end_cursor: 分页游标，从上一次响应获取\n### 返回:\n- `data.items`: 点赞用户列表\n- `end_cursor`: 下一页游标\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get list of users who liked the post\n- Support pagination\n### Parameters:\n- code_or_url: Post shortcode or full URL\n- end_cursor: Pagination cursor from previous response\n### Return:\n- `data.items`: List of users who liked\n- `end_cursor`: Next page cursor\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\ncode_or_url = \"DRhvwVLAHAG\"","operationId":"fetch_post_likes_api_v1_instagram_v2_fetch_post_likes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code_or_url","in":"query","required":true,"schema":{"type":"string","description":"帖子Shortcode或URL/Post shortcode or URL","title":"Code Or Url"},"description":"帖子Shortcode或URL/Post shortcode or URL","example":"DRhvwVLAHAG"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor","title":"End Cursor"},"description":"分页游标/Pagination cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_post_comments":{"get":{"tags":["Instagram-V2-API"],"summary":"获取帖子评论/Get post comments","description":"# [中文]\n### 用途:\n- 获取帖子的评论列表\n- 支持按最新或热门排序\n- 支持分页获取\n### 参数:\n- code_or_url: 帖子Shortcode或完整URL\n- sort_by: 排序方式，\"recent\"（最新）或\"popular\"（热门），默认recent\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 评论列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get list of comments on the post\n- Support sorting by recent or popular\n- Support pagination\n### Parameters:\n- code_or_url: Post shortcode or full URL\n- sort_by: Sort by \"recent\" or \"popular\", default recent\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of comments\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\ncode_or_url = \"DRhvwVLAHAG\"","operationId":"fetch_post_comments_api_v1_instagram_v2_fetch_post_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code_or_url","in":"query","required":true,"schema":{"type":"string","description":"帖子Shortcode或URL/Post shortcode or URL","title":"Code Or Url"},"description":"帖子Shortcode或URL/Post shortcode or URL","example":"DRhvwVLAHAG"},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","description":"排序方式: recent(最新) 或 popular(热门)/Sort by: recent or popular","default":"recent","title":"Sort By"},"description":"排序方式: recent(最新) 或 popular(热门)/Sort by: recent or popular","example":"recent"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","default":"","title":"Pagination Token"},"description":"分页token/Pagination token","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_comment_replies":{"get":{"tags":["Instagram-V2-API"],"summary":"获取评论回复/Get comment replies","description":"# [中文]\n### 用途:\n- 获取评论的回复列表\n- 需要先通过fetch_post_comments获取评论ID\n- 支持分页获取\n### 参数:\n- code_or_url: 帖子Shortcode或完整URL\n- comment_id: 评论ID\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 回复列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get list of replies to a comment\n- Need to get comment ID from fetch_post_comments first\n- Support pagination\n### Parameters:\n- code_or_url: Post shortcode or full URL\n- comment_id: Comment ID\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of replies\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\ncode_or_url = \"DRhvwVLAHAG\"\ncomment_id = \"18067775592012345\"","operationId":"fetch_comment_replies_api_v1_instagram_v2_fetch_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code_or_url","in":"query","required":true,"schema":{"type":"string","description":"帖子Shortcode或URL/Post shortcode or URL","title":"Code Or Url"},"description":"帖子Shortcode或URL/Post shortcode or URL","example":"DRhvwVLAHAG"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论ID/Comment ID","title":"Comment Id"},"description":"评论ID/Comment ID","example":"18067775592012345"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_music_posts":{"get":{"tags":["Instagram-V2-API"],"summary":"获取音乐帖子/Get music posts","description":"# [中文]\n### 用途:\n- 获取使用指定音乐的帖子列表\n- 音频ID可从帖子详情中获取\n- 支持分页获取\n### 参数:\n- audio_canonical_id: 音频ID\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 帖子列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get posts using specified music\n- Audio ID can be obtained from post details\n- Support pagination\n### Parameters:\n- audio_canonical_id: Audio ID\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of posts\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\naudio_canonical_id = \"564058920086577\"","operationId":"fetch_music_posts_api_v1_instagram_v2_fetch_music_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"audio_canonical_id","in":"query","required":true,"schema":{"type":"string","description":"音频ID/Audio ID","title":"Audio Canonical Id"},"description":"音频ID/Audio ID","example":"564058920086577"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_location_posts":{"get":{"tags":["Instagram-V2-API"],"summary":"获取地点帖子/Get location posts","description":"# [中文]\n### 用途:\n- 获取指定地点的帖子列表\n- 地点ID可通过search_locations获取\n- 支持分页获取\n### 参数:\n- location_id: 地点ID\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 帖子列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get posts at specified location\n- Location ID can be obtained from search_locations\n- Support pagination\n### Parameters:\n- location_id: Location ID\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of posts\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nlocation_id = \"331004901\"","operationId":"fetch_location_posts_api_v1_instagram_v2_fetch_location_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"location_id","in":"query","required":true,"schema":{"type":"string","description":"地点ID/Location ID","title":"Location Id"},"description":"地点ID/Location ID","example":"331004901"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v2/fetch_hashtag_posts":{"get":{"tags":["Instagram-V2-API"],"summary":"获取话题帖子/Get hashtag posts","description":"# [中文]\n### 用途:\n- 获取指定话题标签下的帖子列表\n- 支持按热门、最新或仅Reels筛选\n- 支持分页获取\n### 参数:\n- keyword: 话题关键词（不含#号）\n- feed_type: 帖子类型，\"top\"（热门）、\"recent\"（最新）或\"reels\"（仅Reels），默认top\n- pagination_token: 分页token，从上一次响应获取\n### 返回:\n- `data.items`: 帖子列表\n- `pagination_token`: 下一页token\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get posts under specified hashtag\n- Support filtering by top, recent, or reels only\n- Support pagination\n### Parameters:\n- keyword: Hashtag keyword (without #)\n- feed_type: Feed type \"top\", \"recent\", or \"reels\", default top\n- pagination_token: Pagination token from previous response\n### Return:\n- `data.items`: List of posts\n- `pagination_token`: Next page token\n### Price:\n- 0.002 USD/request\n\n# [示例/Example]\nkeyword = \"cat\"\nfeed_type = \"top\"","operationId":"fetch_hashtag_posts_api_v1_instagram_v2_fetch_hashtag_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"话题关键词（不含#号）/Hashtag keyword (without #)","title":"Keyword"},"description":"话题关键词（不含#号）/Hashtag keyword (without #)","example":"cat"},{"name":"feed_type","in":"query","required":false,"schema":{"type":"string","description":"帖子类型: top(热门), recent(最新), reels(仅Reels)/Feed type: top, recent, or reels","default":"top","title":"Feed Type"},"description":"帖子类型: top(热门), recent(最新), reels(仅Reels)/Feed type: top, recent, or reels"},{"name":"pagination_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Pagination Token"},"description":"分页token/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/search_users":{"get":{"tags":["Instagram-V3-API"],"summary":"搜索用户/Search users","description":"# [中文]\n### 用途:\n- Instagram用户搜索接口\n- 仅返回用户搜索结果\n### 参数:\n- query: 搜索关键词\n- rank_token: 上一次搜索返回的rank_token，用于翻页\n### 返回:\n- `data.users`: 用户搜索结果列表\n- `data.rank_token`: 排序token\n- `data.see_more`: 更多信息\n- `data.inform_module`: 提示模块\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Instagram user search API\n- Returns only user search results\n### Parameters:\n- query: Search keyword\n- rank_token: Rank token from previous search response for pagination\n### Return:\n- `data.users`: User search results\n- `data.rank_token`: Rank token\n- `data.see_more`: See more info\n- `data.inform_module`: Inform module\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nquery = \"justin\"","operationId":"search_users_api_v1_instagram_v3_search_users_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"justin"},{"name":"rank_token","in":"query","required":false,"schema":{"type":"string","description":"上一次搜索返回的rank_token，用于翻页/Rank token from previous search response for pagination","title":"Rank Token"},"description":"上一次搜索返回的rank_token，用于翻页/Rank token from previous search response for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/search_hashtags":{"get":{"tags":["Instagram-V3-API"],"summary":"搜索话题标签/Search hashtags","description":"# [中文]\n### 用途:\n- Instagram话题标签搜索接口\n- 仅返回话题标签搜索结果\n### 参数:\n- query: 搜索关键词\n- rank_token: 上一次搜索返回的rank_token，用于翻页\n### 返回:\n- `data.hashtags`: 话题标签搜索结果列表\n- `data.rank_token`: 排序token\n- `data.see_more`: 更多信息\n- `data.inform_module`: 提示模块\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Instagram hashtag search API\n- Returns only hashtag search results\n### Parameters:\n- query: Search keyword\n- rank_token: Rank token from previous search response for pagination\n### Return:\n- `data.hashtags`: Hashtag search results\n- `data.rank_token`: Rank token\n- `data.see_more`: See more info\n- `data.inform_module`: Inform module\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nquery = \"fashion\"","operationId":"search_hashtags_api_v1_instagram_v3_search_hashtags_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"fashion"},{"name":"rank_token","in":"query","required":false,"schema":{"type":"string","description":"上一次搜索返回的rank_token，用于翻页/Rank token from previous search response for pagination","title":"Rank Token"},"description":"上一次搜索返回的rank_token，用于翻页/Rank token from previous search response for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/search_places":{"get":{"tags":["Instagram-V3-API"],"summary":"搜索地点/Search places","description":"# [中文]\n### 用途:\n- Instagram地点搜索接口\n- 仅返回地点搜索结果\n### 参数:\n- query: 搜索关键词\n- rank_token: 上一次搜索返回的rank_token，用于翻页\n### 返回:\n- `data.places`: 地点搜索结果列表\n- `data.rank_token`: 排序token\n- `data.see_more`: 更多信息\n- `data.inform_module`: 提示模块\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Instagram place search API\n- Returns only place search results\n### Parameters:\n- query: Search keyword\n- rank_token: Rank token from previous search response for pagination\n### Return:\n- `data.places`: Place search results\n- `data.rank_token`: Rank token\n- `data.see_more`: See more info\n- `data.inform_module`: Inform module\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nquery = \"tokyo\"","operationId":"search_places_api_v1_instagram_v3_search_places_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"tokyo"},{"name":"rank_token","in":"query","required":false,"schema":{"type":"string","description":"上一次搜索返回的rank_token，用于翻页/Rank token from previous search response for pagination","title":"Rank Token"},"description":"上一次搜索返回的rank_token，用于翻页/Rank token from previous search response for pagination"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/general_search":{"get":{"tags":["Instagram-V3-API"],"summary":"综合搜索（支持分页）/General search (with pagination)","description":"# [中文]\n### 用途:\n- Instagram综合搜索接口（支持分页）\n- 支持通过 next_max_id 分页获取大量搜索结果\n- 返回用户、话题标签、地点等综合结果\n### 参数:\n- query: 搜索关键词\n- next_max_id: 分页ID，首次请求不传，从上一次响应的 `data.next_max_id` 获取\n- rank_token: 排序token，首次请求不传，从上一次响应的 `data.rank_token` 获取\n- enable_metadata: 是否启用元数据\n### 返回:\n- `data.num_results`: 结果数量\n- `data.users`: 用户搜索结果列表\n- `data.places`: 地点搜索结果列表\n- `data.hashtags`: 话题标签搜索结果列表\n- `data.next_max_id`: 下一页分页ID（传给下次请求的next_max_id参数）\n- `data.rank_token`: 排序token（传给下次请求的rank_token参数）\n- `data.has_more`: 是否有更多结果\n### 注意事项:\n- ⚠️ **已知问题**: 综合搜索结果可能存在重复数据，这是 Instagram API 的已知行为\n- 搜索话题标签时，query 需要带上 `#` 前缀，例如搜索 fashion 话题应传入 `#fashion`\n- `#` 符号在 URL 中需要进行 URL 编码为 `%23`，例如: `?query=%23fashion`\n- 如果使用 HTTP 客户端库（如 requests/httpx），直接传入 `#fashion` 即可，库会自动处理编码\n### 分页使用方法:\n1. 首次请求：只传 `query` 参数\n2. 获取响应中的 `next_max_id` 和 `rank_token`\n3. 下次请求：传入 `query`、`next_max_id` 和 `rank_token`\n4. 重复步骤 2-3 直到 `has_more` 为 false\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Instagram general search API (with pagination)\n- Support pagination via next_max_id to fetch more search results\n- Returns blended results of users, hashtags, places, etc.\n### Parameters:\n- query: Search keyword\n- next_max_id: Pagination ID, omit for first request, get from previous response `data.next_max_id`\n- rank_token: Rank token, omit for first request, get from previous response `data.rank_token`\n- enable_metadata: Enable metadata\n### Return:\n- `data.num_results`: Number of results\n- `data.users`: User search results\n- `data.places`: Place search results\n- `data.hashtags`: Hashtag search results\n- `data.next_max_id`: Next page pagination ID (use as next_max_id in next request)\n- `data.rank_token`: Rank token (use as rank_token in next request)\n- `data.has_more`: Whether has more results\n### Notes:\n- ⚠️ **Known Issue**: General search results may contain duplicate data, this is a known behavior of Instagram API\n- When searching for hashtags, `query` must include the `#` prefix, e.g., use `#fashion` to search for the fashion hashtag\n- The `#` character must be URL-encoded as `%23` in the URL, e.g., `?query=%23fashion`\n- If using an HTTP client library (e.g., requests/httpx), just pass `#fashion` directly and the library will handle encoding automatically\n### Pagination usage:\n1. First request: Only pass `query` parameter\n2. Get `next_max_id` and `rank_token` from response\n3. Next request: Pass `query`, `next_max_id` and `rank_token`\n4. Repeat steps 2-3 until `has_more` is false\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\n```\nquery = \"justin\"\n```","operationId":"general_search_api_v1_instagram_v3_general_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Query"},"description":"搜索关键词/Search keyword","example":"justin"},{"name":"next_max_id","in":"query","required":false,"schema":{"type":"string","description":"分页ID，首次请求不传，从上一次响应的next_max_id获取/Pagination ID, omit for first request, get from previous response next_max_id","title":"Next Max Id"},"description":"分页ID，首次请求不传，从上一次响应的next_max_id获取/Pagination ID, omit for first request, get from previous response next_max_id"},{"name":"rank_token","in":"query","required":false,"schema":{"type":"string","description":"排序token，首次请求不传，从上一次响应获取/Rank token, omit for first request, get from previous response","title":"Rank Token"},"description":"排序token，首次请求不传，从上一次响应获取/Rank token, omit for first request, get from previous response"},{"name":"enable_metadata","in":"query","required":false,"schema":{"type":"boolean","description":"是否启用元数据/Enable metadata","default":true,"title":"Enable Metadata"},"description":"是否启用元数据/Enable metadata"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_id_by_username":{"get":{"tags":["Instagram-V3-API"],"summary":"通过用户名获取用户ID/Get user ID by username","description":"# [中文]\n### 用途:\n- 通过Instagram用户名获取用户ID\n- 用户ID是Instagram内部使用的唯一标识符，通常为数字字符串\n### 参数:\n- username: Instagram用户名\n### 返回:\n- `data.user_id`: 用户ID\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user ID by username\n- User ID is the unique identifier used internally by Instagram, usually a numeric string\n### Parameters:\n- username: Instagram username\n### Return:\n- `data.user_id`: User ID\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nusername = \"liensue.talks\"","operationId":"get_user_id_by_username_api_v1_instagram_v3_get_user_id_by_username_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"liensue.talks"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_profile":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户信息/Get user profile","description":"# [中文]\n### 用途:\n- 获取Instagram用户的完整个人资料信息\n- 包含用户基本信息、统计数据、最近帖子等\n### 参数:\n- user_id: Instagram用户ID（数字，与username二选一）\n- username: Instagram用户名（与user_id二选一，传入后会自动转换为user_id）\n\n### 返回:\n- `data.user.id`: 用户ID\n- `data.user.username`: 用户名\n- `data.user.full_name`: 全名\n- `data.user.biography`: 个人简介\n- `data.user.external_url`: 外部链接\n- `data.user.profile_pic_url`: 头像URL（标准）\n- `data.user.profile_pic_url_hd`: 头像URL（高清）\n- `data.user.is_verified`: 是否认证\n- `data.user.is_private`: 是否私密账号\n- `data.user.edge_followed_by.count`: 粉丝数\n- `data.user.edge_follow.count`: 关注数\n- `data.user.edge_owner_to_timeline_media.count`: 帖子总数\n- `data.user.edge_felix_video_timeline.count`: Reels/视频数\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get complete Instagram user profile information\n- Including basic info, statistics, recent posts, etc.\n### Parameters:\n- user_id: Instagram user ID (numeric, either user_id or username is required)\n- username: Instagram username (alternative to user_id, will be automatically converted to user_id)\n\n### Return:\n- `data.user.id`: User ID\n- `data.user.username`: Username\n- `data.user.full_name`: Full name\n- `data.user.biography`: Biography\n- `data.user.external_url`: External URL\n- `data.user.profile_pic_url`: Profile picture URL (standard)\n- `data.user.profile_pic_url_hd`: Profile picture URL (HD)\n- `data.user.is_verified`: Whether verified\n- `data.user.is_private`: Whether private account\n- `data.user.edge_followed_by.count`: Followers count\n- `data.user.edge_follow.count`: Following count\n- `data.user.edge_owner_to_timeline_media.count`: Total posts count\n- `data.user.edge_felix_video_timeline.count`: Reels/videos count\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nuser_id = \"58208242181\"","operationId":"get_user_profile_api_v1_instagram_v3_get_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"58208242181"},{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名（与user_id二选一）/Username (alternative to user_id)","title":"Username"},"description":"用户名（与user_id二选一）/Username (alternative to user_id)","example":"instagram"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_brief":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户短详情/Get user brief info","description":"# [中文]\n### 用途:\n- 获取Instagram用户的短详情/悬浮卡片信息\n- 返回用户核心信息，响应速度比 get_user_profile 更快\n- 适用于批量获取用户摘要信息的场景\n### 参数:\n- user_id: Instagram用户ID（数字，必填）\n- username: Instagram用户名（必填）\n### 返回:\n- `data.id`: 用户ID\n- `data.username`: 用户名\n- `data.full_name`: 全名\n- `data.biography`: 个人简介\n- `data.profile_pic_url`: 头像URL\n- `data.is_verified`: 是否认证\n- `data.is_private`: 是否私密账号\n- `data.edge_followed_by.count`: 粉丝数\n- `data.edge_follow.count`: 关注数\n- `data.edge_owner_to_timeline_media`: 最近帖子预览\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user brief/hover card info\n- Returns core user info, faster response than get_user_profile\n- Suitable for batch fetching user summary info\n### Parameters:\n- user_id: Instagram user ID (numeric, required)\n- username: Instagram username (required)\n### Return:\n- `data.id`: User ID\n- `data.username`: Username\n- `data.full_name`: Full name\n- `data.biography`: Biography\n- `data.profile_pic_url`: Profile picture URL\n- `data.is_verified`: Whether verified\n- `data.is_private`: Whether private account\n- `data.edge_followed_by.count`: Followers count\n- `data.edge_follow.count`: Following count\n- `data.edge_owner_to_timeline_media`: Recent posts preview\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nuser_id = \"791258468\"\nusername = \"99brasil\"","operationId":"get_user_brief_api_v1_instagram_v3_get_user_brief_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"791258468"},{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"99brasil"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_posts":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户帖子列表/Get user posts","description":"# [中文]\n### 用途:\n- 分页获取用户发布的帖子列表，支持向前/向后翻页\n\n### 参数:\n- **username**: 用户名字符串（如 `99brasil`），**不是数字 user_id**\n- **first**: 向后翻页时每页数量（默认12，最大50）\n- **after**: 向后翻页游标，从上一次响应的 `page_info.end_cursor` 中获取\n- **before**: 向前翻页游标，从上一次响应的 `page_info.start_cursor` 中获取\n- **last**: 向前翻页时每页数量，配合 `before` 使用\n- **count**: 首次请求数量（默认12）\n\n### 翻页说明:\n- **向后翻页**: 使用 `first` + `after` 组合\n- **向前翻页**: 使用 `last` + `before` 组合\n- 首次请求不传 `after`/`before`，从响应中获取游标\n\n### 返回:\n- `data.edges`: 帖子列表\n- `data.page_info`: 分页信息\n    - `has_next_page`: 是否有下一页\n    - `end_cursor`: 下一页游标\n    - `start_cursor`: 上一页游标\n\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get user's post list with forward/backward pagination\n\n### Parameters:\n- **username**: Username string (e.g. `99brasil`), **NOT numeric user_id**\n- **first**: Posts per page for forward pagination (default 12, max 50)\n- **after**: Forward pagination cursor, from previous response `page_info.end_cursor`\n- **before**: Backward pagination cursor, from previous response `page_info.start_cursor`\n- **last**: Posts per page for backward pagination, use with `before`\n- **count**: Number of posts for first request (default 12)\n\n### Pagination:\n- **Forward**: Use `first` + `after`\n- **Backward**: Use `last` + `before`\n\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\n```\n# 第一页 / First page\nGET /get_user_posts?username=99brasil&first=12\n\n# 第二页 / Second page (forward)\nGET /get_user_posts?username=99brasil&first=12&after=QVFCcmN1YlF...\n```","operationId":"get_user_posts_api_v1_instagram_v3_get_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"Instagram 用户名（不含 @）/Instagram username (without @)","title":"Username"},"description":"Instagram 用户名（不含 @）/Instagram username (without @)","example":"99brasil"},{"name":"first","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"向后翻页时每页数量/Number of posts per page (forward)","default":12,"title":"First"},"description":"向后翻页时每页数量/Number of posts per page (forward)"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"向后翻页游标（end_cursor）/Forward pagination cursor (end_cursor)","title":"After"},"description":"向后翻页游标（end_cursor）/Forward pagination cursor (end_cursor)"},{"name":"before","in":"query","required":false,"schema":{"type":"string","description":"向前翻页游标（start_cursor）/Backward pagination cursor (start_cursor)","title":"Before"},"description":"向前翻页游标（start_cursor）/Backward pagination cursor (start_cursor)"},{"name":"last","in":"query","required":false,"schema":{"type":"integer","description":"向前翻页时每页数量/Number of posts per page (backward)","title":"Last"},"description":"向前翻页时每页数量/Number of posts per page (backward)"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"首次请求数量/Number of posts for first request","default":12,"title":"Count"},"description":"首次请求数量/Number of posts for first request"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_tagged_posts":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户被标记的帖子/Get user tagged posts","description":"# [中文]\n### 用途:\n- 获取Instagram用户被标记（tagged）的帖子列表\n- 即其他用户在帖子中标记了该用户的内容\n- 支持分页获取\n### 参数:\n- user_id: Instagram用户ID（数字，与username二选一）\n- username: Instagram用户名（与user_id二选一，传入后会自动转换为user_id）\n- first: 向后翻页时每页数量（默认12，最大50）\n- after: 向后翻页游标，从上一次响应的 `data.page_info.end_cursor` 获取\n- before: 向前翻页游标，从上一次响应的 `data.page_info.start_cursor` 获取\n- last: 向前翻页时每页数量，配合 `before` 使用\n- count: 首次请求数量（默认12）\n### 返回:\n- `data.edges`: 帖子列表\n    - `node.id`: 帖子ID\n    - `node.code`: 帖子短代码\n    - `node.display_url`: 展示图片URL\n    - `node.taken_at`: 发布时间戳\n    - `node.like_count`: 点赞数\n    - `node.comment_count`: 评论数\n    - `node.caption.text`: 帖子文本\n    - `node.user`: 发帖者信息\n- `data.page_info`: 分页信息\n    - `has_next_page`: 是否有下一页\n    - `end_cursor`: 下一页游标（传给下次请求的after参数）\n### 分页使用方法:\n1. 首次请求：只传 `user_id` 和 `first` 参数\n2. 获取响应中的 `data.page_info.end_cursor`\n3. 下次请求：传入 `user_id`、`first` 和 `after` (使用上次的end_cursor)\n4. 重复步骤 2-3 直到 `data.page_info.has_next_page` 为 false\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user's tagged posts list\n- Posts where other users tagged this user\n- Support pagination\n### Parameters:\n- user_id: Instagram user ID (numeric, either user_id or username is required)\n- username: Instagram username (alternative to user_id, will be automatically converted to user_id)\n- first: Posts per page for forward pagination (default 12, max 50)\n- after: Forward pagination cursor, from previous response `data.page_info.end_cursor`\n- before: Backward pagination cursor, from previous response `data.page_info.start_cursor`\n- last: Posts per page for backward pagination, use with `before`\n- count: Number of posts for first request (default 12)\n### Return:\n- `data.edges`: Post list\n    - `node.id`: Post ID\n    - `node.code`: Post shortcode\n    - `node.display_url`: Display image URL\n    - `node.taken_at`: Published timestamp\n    - `node.like_count`: Likes count\n    - `node.comment_count`: Comments count\n    - `node.caption.text`: Post caption text\n    - `node.user`: Post author info\n- `data.page_info`: Pagination info\n    - `has_next_page`: Whether has next page\n    - `end_cursor`: Next page cursor (use as after parameter in next request)\n### Pagination usage:\n1. First request: Only pass `user_id` and `first` parameters\n2. Get `data.page_info.end_cursor` from response\n3. Next request: Pass `user_id`, `first`, and `after` (use end_cursor from previous)\n4. Repeat steps 2-3 until `data.page_info.has_next_page` is false\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nuser_id = \"58208242181\"\nfirst = 12","operationId":"get_user_tagged_posts_api_v1_instagram_v3_get_user_tagged_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"58208242181"},{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名（与user_id二选一）/Username (alternative to user_id)","title":"Username"},"description":"用户名（与user_id二选一）/Username (alternative to user_id)","example":"instagram"},{"name":"first","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"向后翻页时每页数量/Number of posts per page (forward)","default":12,"title":"First"},"description":"向后翻页时每页数量/Number of posts per page (forward)"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"向后翻页游标（end_cursor）/Forward pagination cursor (end_cursor)","title":"After"},"description":"向后翻页游标（end_cursor）/Forward pagination cursor (end_cursor)"},{"name":"before","in":"query","required":false,"schema":{"type":"string","description":"向前翻页游标（start_cursor）/Backward pagination cursor (start_cursor)","title":"Before"},"description":"向前翻页游标（start_cursor）/Backward pagination cursor (start_cursor)"},{"name":"last","in":"query","required":false,"schema":{"type":"integer","description":"向前翻页时每页数量/Number of posts per page (backward)","title":"Last"},"description":"向前翻页时每页数量/Number of posts per page (backward)"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"首次请求数量/Number of posts for first request","default":12,"title":"Count"},"description":"首次请求数量/Number of posts for first request"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_reels":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户Reels列表/Get user reels","description":"# [中文]\n### 用途:\n- 获取Instagram用户的Reels列表\n- 支持分页获取用户发布的所有Reels\n### 参数:\n- user_id: Instagram用户ID（数字，与username二选一）\n- username: Instagram用户名（与user_id二选一，传入后会自动转换为user_id）\n- first: 向后翻页时每页数量（默认12，最大50）\n- after: 向后翻页游标，从上一次响应的 `data.page_info.end_cursor` 获取\n- before: 向前翻页游标，从上一次响应的 `data.page_info.start_cursor` 获取\n- last: 向前翻页时每页数量，配合 `before` 使用\n- page_size: 每页视频数量（默认12）\n### 返回:\n- `data.edges`: Reels列表\n    - `node.media`: Reels媒体信息\n        - `code`: 帖子短代码\n        - `pk`: 帖子ID\n        - `like_count`: 点赞数\n        - `comment_count`: 评论数\n        - `play_count`: 播放数\n        - `caption.text`: 描述文本\n        - `user`: 发布者信息\n        - `video_versions`: 视频版本列表\n        - `image_versions2`: 封面图版本列表\n- `data.page_info`: 分页信息\n    - `has_next_page`: 是否有下一页\n    - `end_cursor`: 下一页游标（传给下次请求的after参数）\n### 分页使用方法:\n1. 首次请求：只传 `user_id` 和 `first` 参数\n2. 获取响应中的 `data.page_info.end_cursor`\n3. 下次请求：传入 `user_id`、`first` 和 `after` (使用上次的end_cursor)\n4. 重复步骤 2-3 直到 `data.page_info.has_next_page` 为 false\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user's Reels list\n- Support pagination to fetch all user's Reels\n### Parameters:\n- user_id: Instagram user ID (numeric, either user_id or username is required)\n- username: Instagram username (alternative to user_id, will be automatically converted to user_id)\n- first: Reels per page for forward pagination (default 12, max 50)\n- after: Forward pagination cursor, from previous response `data.page_info.end_cursor`\n- before: Backward pagination cursor, from previous response `data.page_info.start_cursor`\n- last: Reels per page for backward pagination, use with `before`\n- page_size: Videos per page (default 12)\n### Return:\n- `data.edges`: Reels list\n    - `node.media`: Reels media info\n        - `code`: Post shortcode\n        - `pk`: Post ID\n        - `like_count`: Likes count\n        - `comment_count`: Comments count\n        - `play_count`: Play count\n        - `caption.text`: Description text\n        - `user`: Publisher info\n        - `video_versions`: Video version list\n        - `image_versions2`: Cover image version list\n- `data.page_info`: Pagination info\n    - `has_next_page`: Whether has next page\n    - `end_cursor`: Next page cursor (use as after parameter in next request)\n### Pagination usage:\n1. First request: Only pass `user_id` and `first` parameters\n2. Get `data.page_info.end_cursor` from response\n3. Next request: Pass `user_id`, `first`, and `after` (use end_cursor from previous)\n4. Repeat steps 2-3 until `data.page_info.has_next_page` is false\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nuser_id = \"58208242181\"\nfirst = 12","operationId":"get_user_reels_api_v1_instagram_v3_get_user_reels_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"58208242181"},{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名（与user_id二选一）/Username (alternative to user_id)","title":"Username"},"description":"用户名（与user_id二选一）/Username (alternative to user_id)","example":"instagram"},{"name":"first","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"向后翻页时每页数量/Number of reels per page (forward)","default":12,"title":"First"},"description":"向后翻页时每页数量/Number of reels per page (forward)"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"向后翻页游标（end_cursor）/Forward pagination cursor (end_cursor)","title":"After"},"description":"向后翻页游标（end_cursor）/Forward pagination cursor (end_cursor)"},{"name":"before","in":"query","required":false,"schema":{"type":"string","description":"向前翻页游标（start_cursor）/Backward pagination cursor (start_cursor)","title":"Before"},"description":"向前翻页游标（start_cursor）/Backward pagination cursor (start_cursor)"},{"name":"last","in":"query","required":false,"schema":{"type":"integer","description":"向前翻页时每页数量/Number of reels per page (backward)","title":"Last"},"description":"向前翻页时每页数量/Number of reels per page (backward)"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","description":"每页视频数量/Videos per page","default":12,"title":"Page Size"},"description":"每页视频数量/Videos per page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_highlights":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户精选Highlights列表/Get user highlights","description":"# [中文]\n### 用途:\n- 获取Instagram用户的精选Highlights列表\n- 返回用户创建的所有精选集合\n- 支持分页获取\n### 参数:\n- user_id: Instagram用户ID（数字，与username二选一）\n- username: Instagram用户名（与user_id二选一，传入后会自动转换为user_id）\n- first: 每页精选数量（默认10，最大50）\n- after: 向后翻页游标，从上一次响应的 `data.page_info.end_cursor` 获取\n- before: 向前翻页游标，从上一次响应的 `data.page_info.start_cursor` 获取\n- last: 向前翻页时每页数量，配合 `before` 使用\n### 返回:\n- `data.edges`: 精选列表\n    - `node.id`: 精选ID（格式: highlight:xxx）\n    - `node.title`: 精选标题\n    - `node.cover_media`: 封面媒体信息\n    - `node.cover_media_cropped_thumbnail`: 裁剪后的封面缩略图\n    - `node.media_count`: 精选中的故事数量\n- `data.page_info`: 分页信息\n    - `has_next_page`: 是否有下一页\n    - `end_cursor`: 下一页游标（传给下次请求的after参数）\n### 分页使用方法:\n1. 首次请求：只传 `user_id` 和 `first` 参数\n2. 获取响应中的 `data.page_info.end_cursor`\n3. 下次请求：传入 `user_id`、`first` 和 `after` (使用上次的end_cursor)\n4. 重复步骤 2-3 直到 `data.page_info.has_next_page` 为 false\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user's Highlights list\n- Returns all highlight collections created by the user\n- Support pagination\n### Parameters:\n- user_id: Instagram user ID (numeric, either user_id or username is required)\n- username: Instagram username (alternative to user_id, will be automatically converted to user_id)\n- first: Number of highlights per page (default 10, max 50)\n- after: Forward pagination cursor, from previous response `data.page_info.end_cursor`\n- before: Backward pagination cursor, from previous response `data.page_info.start_cursor`\n- last: Highlights per page for backward pagination, use with `before`\n### Return:\n- `data.edges`: Highlights list\n    - `node.id`: Highlight ID (format: highlight:xxx)\n    - `node.title`: Highlight title\n    - `node.cover_media`: Cover media info\n    - `node.cover_media_cropped_thumbnail`: Cropped cover thumbnail\n    - `node.media_count`: Number of stories in highlight\n- `data.page_info`: Pagination info\n    - `has_next_page`: Whether has next page\n    - `end_cursor`: Next page cursor (use as after parameter in next request)\n### Pagination usage:\n1. First request: Only pass `user_id` and `first` parameters\n2. Get `data.page_info.end_cursor` from response\n3. Next request: Pass `user_id`, `first`, and `after` (use end_cursor from previous)\n4. Repeat steps 2-3 until `data.page_info.has_next_page` is false\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nuser_id = \"58208242181\"\nfirst = 10","operationId":"get_user_highlights_api_v1_instagram_v3_get_user_highlights_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"58208242181"},{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名（与user_id二选一）/Username (alternative to user_id)","title":"Username"},"description":"用户名（与user_id二选一）/Username (alternative to user_id)","example":"instagram"},{"name":"first","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"每页数量/Number of highlights per page","default":10,"title":"First"},"description":"每页数量/Number of highlights per page"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"向后翻页游标/Forward pagination cursor","title":"After"},"description":"向后翻页游标/Forward pagination cursor"},{"name":"before","in":"query","required":false,"schema":{"type":"string","description":"向前翻页游标/Backward pagination cursor","title":"Before"},"description":"向前翻页游标/Backward pagination cursor"},{"name":"last","in":"query","required":false,"schema":{"type":"integer","description":"向前翻页时每页数量/Number of highlights per page (backward)","title":"Last"},"description":"向前翻页时每页数量/Number of highlights per page (backward)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_highlight_stories":{"get":{"tags":["Instagram-V3-API"],"summary":"获取Highlight精选详情/Get highlight stories","description":"# [中文]\n### 用途:\n- 获取Instagram Highlight精选的详细故事/帖子内容\n- 返回精选集合中的所有Stories媒体\n### 参数:\n- highlight_id: 精选ID，格式为 `highlight:xxx`（从 get_user_highlights 接口获取）\n- reel_ids: 精选ID列表，逗号分隔（可选，如不提供则仅查询highlight_id指定的精选）\n    - 例如: `highlight:18064916456320419,highlight:18155682898389765`\n    - 可同时查询多个精选的内容\n- first: 每页数量（默认3）\n- last: 获取最后N条（默认2）\n### 返回:\n- `data.story_highlight_tray`: 精选故事集合\n    - `id`: 精选ID\n    - `title`: 精选标题\n    - `items`: 故事列表\n        - `id`: 故事ID\n        - `pk`: 故事PK\n        - `taken_at`: 发布时间戳\n        - `media_type`: 媒体类型（1=图片, 2=视频）\n        - `image_versions2`: 图片版本列表\n        - `video_versions`: 视频版本列表（视频时存在）\n        - `user`: 发布者信息\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram Highlight's detailed story/post content\n- Returns all Stories media in the highlight collection\n### Parameters:\n- highlight_id: Highlight ID, format `highlight:xxx` (get from get_user_highlights API)\n- reel_ids: Highlight ID list, comma separated (optional, if not provided only queries the highlight_id)\n    - Example: `highlight:18064916456320419,highlight:18155682898389765`\n    - Can query multiple highlights at once\n- first: Items per page (default 3)\n- last: Get last N items (default 2)\n### Return:\n- `data.story_highlight_tray`: Highlight story collection\n    - `id`: Highlight ID\n    - `title`: Highlight title\n    - `items`: Story list\n        - `id`: Story ID\n        - `pk`: Story PK\n        - `taken_at`: Published timestamp\n        - `media_type`: Media type (1=image, 2=video)\n        - `image_versions2`: Image version list\n        - `video_versions`: Video version list (exists for videos)\n        - `user`: Publisher info\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\n```\nhighlight_id = \"highlight:18064916456320419\"\n# reel_ids = \"highlight:18064916456320419,highlight:18155682898389765\"\n```","operationId":"get_highlight_stories_api_v1_instagram_v3_get_highlight_stories_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"highlight_id","in":"query","required":true,"schema":{"type":"string","description":"精选ID/Highlight ID (格式/format: highlight:xxx)","title":"Highlight Id"},"description":"精选ID/Highlight ID (格式/format: highlight:xxx)","example":"highlight:18064916456320419"},{"name":"reel_ids","in":"query","required":false,"schema":{"type":"string","description":"精选ID列表，逗号分隔，如不提供则仅查询highlight_id/Highlight ID list, comma separated, if not provided only query highlight_id","title":"Reel Ids"},"description":"精选ID列表，逗号分隔，如不提供则仅查询highlight_id/Highlight ID list, comma separated, if not provided only query highlight_id"},{"name":"first","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Items per page","default":3,"title":"First"},"description":"每页数量/Items per page"},{"name":"last","in":"query","required":false,"schema":{"type":"integer","description":"获取最后N条/Get last N items","default":2,"title":"Last"},"description":"获取最后N条/Get last N items"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_about":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户账户简介/Get user about info","description":"# [中文]\n### 用途:\n- 获取Instagram用户的账户简介信息（About This Account）\n- 包含账户创建日期、所在地区、曾用名等信息\n### 参数:\n- user_id: Instagram用户ID（数字，与username二选一）\n- username: Instagram用户名（与user_id二选一，传入后会自动转换为user_id）\n### 返回:\n- 账户创建日期\n- 账户所在地区/国家\n- 曾用名历史\n- 其他账户相关信息\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user's About This Account information\n- Including account creation date, location, former usernames, etc.\n### Parameters:\n- user_id: Instagram user ID (numeric, either user_id or username is required)\n- username: Instagram username (alternative to user_id, will be automatically converted to user_id)\n### Return:\n- Account creation date\n- Account location/country\n- Former username history\n- Other account related info\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nuser_id = \"791258468\"","operationId":"get_user_about_api_v1_instagram_v3_get_user_about_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"791258468"},{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名（与user_id二选一）/Username (alternative to user_id)","title":"Username"},"description":"用户名（与user_id二选一）/Username (alternative to user_id)","example":"instagram"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_former_usernames":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户曾用用户名/Get user former usernames","description":"# [中文]\n### 用途:\n- 获取Instagram用户的曾用用户名历史\n### 参数:\n- user_id: Instagram用户ID（数字，与username二选一）\n- username: Instagram用户名（与user_id二选一，传入后会自动转换为user_id）\n### 返回:\n- 曾用用户名列表及更改时间\n### 价格:\n- 0.002 USD/请求\n### 注意:\n- 如果用户没有曾用名，也会正常返回空数据并扣费\n\n# [English]\n### Purpose:\n- Get Instagram user's former username history\n### Parameters:\n- user_id: Instagram user ID (numeric, either user_id or username is required)\n- username: Instagram username (alternative to user_id, will be automatically converted to user_id)\n### Return:\n- List of former usernames with change dates\n### Price:\n- 0.002 USD/request\n### Note:\n- If the user has no former usernames, an empty result will be returned and the request will still be charged\n\n### 示例/Example\nuser_id = \"17841403122371231\"","operationId":"get_user_former_usernames_api_v1_instagram_v3_get_user_former_usernames_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"17841403122371231"},{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名（与user_id二选一）/Username (alternative to user_id)","title":"Username"},"description":"用户名（与user_id二选一）/Username (alternative to user_id)","example":"instagram"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_stories":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户Stories（快拍）/Get user stories","description":"# [中文]\n### 用途:\n- 获取Instagram用户的Stories（快拍）列表\n- 即点击用户头像后展示的24小时内发布的快拍内容\n### 参数:\n- user_id: Instagram用户ID（数字，与username二选一）\n- username: Instagram用户名（与user_id二选一，传入后会自动转换为user_id）\n### 返回:\n- `data.reels_media`: Stories列表（按用户分组）\n    - `id`: 用户ID\n    - `user`: 用户信息\n        - `username`: 用户名\n        - `full_name`: 全名\n        - `profile_pic_url`: 头像URL\n    - `items`: Stories条目列表\n        - `id`: Story ID\n        - `pk`: Story PK\n        - `taken_at`: 发布时间戳\n        - `media_type`: 媒体类型（1=图片, 2=视频）\n        - `image_versions2`: 图片版本列表\n        - `video_versions`: 视频版本列表（视频时存在）\n        - `story_cta`: Story链接（如果有）\n- `data.reels`: Stories详细信息\n### 注意:\n- Stories有24小时有效期，过期后无法获取\n- 私密账号的Stories需要关注后才能查看\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user's Stories list\n- Stories displayed when clicking on user's profile picture (published within 24 hours)\n### Parameters:\n- user_id: Instagram user ID (numeric, either user_id or username is required)\n- username: Instagram username (alternative to user_id, will be automatically converted to user_id)\n### Return:\n- `data.reels_media`: Stories list (grouped by user)\n    - `id`: User ID\n    - `user`: User info\n        - `username`: Username\n        - `full_name`: Full name\n        - `profile_pic_url`: Profile picture URL\n    - `items`: Stories item list\n        - `id`: Story ID\n        - `pk`: Story PK\n        - `taken_at`: Published timestamp\n        - `media_type`: Media type (1=image, 2=video)\n        - `image_versions2`: Image version list\n        - `video_versions`: Video version list (exists for videos)\n        - `story_cta`: Story link (if any)\n- `data.reels`: Stories detailed info\n### Note:\n- Stories have a 24-hour expiration, cannot be fetched after expiration\n- Private account's Stories require following to view\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\n```\nuser_id = \"58208242181\"\n```","operationId":"get_user_stories_api_v1_instagram_v3_get_user_stories_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"58208242181"},{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名（与user_id二选一）/Username (alternative to user_id)","title":"Username"},"description":"用户名（与user_id二选一）/Username (alternative to user_id)","example":"instagram"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_recommended_reels":{"get":{"tags":["Instagram-V3-API"],"summary":"获取Reels推荐列表/Get recommended Reels feed","description":"# [中文]\n### 用途:\n- 获取Instagram Reels推荐列表\n- 支持分页获取更多Reels\n### 参数:\n- first: 每次获取的Reels数量（默认12，最大50）\n- after: 分页游标，首次请求不传，从上一次响应的 `data.page_info.end_cursor` 获取\n### 返回:\n- `data.edges`: Reels列表\n    - `node.media`: Reels媒体信息\n        - `code`: 帖子短代码\n        - `pk`: 帖子ID\n        - `like_count`: 点赞数\n        - `comment_count`: 评论数\n        - `play_count`: 播放数\n        - `caption.text`: 描述文本\n        - `user`: 发布者信息\n        - `video_versions`: 视频版本列表\n        - `image_versions2`: 封面图版本列表\n- `data.page_info`: 分页信息\n    - `has_next_page`: 是否有下一页\n    - `end_cursor`: 下一页游标（传给下次请求的after参数）\n### 分页使用方法:\n1. 首次请求：只传 `first` 参数\n2. 获取响应中的 `data.page_info.end_cursor`\n3. 下次请求：传入 `first` 和 `after` (使用上次的end_cursor)\n4. 重复步骤 2-3 直到 `data.page_info.has_next_page` 为 false\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram Reels recommendation feed\n- Support pagination to fetch more Reels\n### Parameters:\n- first: Number of Reels to fetch per request (default 12, max 50)\n- after: Pagination cursor, omit for first request, get from previous response `data.page_info.end_cursor`\n### Return:\n- `data.edges`: Reels list\n    - `node.media`: Reels media info\n        - `code`: Post shortcode\n        - `pk`: Post ID\n        - `like_count`: Likes count\n        - `comment_count`: Comments count\n        - `play_count`: Play count\n        - `caption.text`: Description text\n        - `user`: Publisher info\n        - `video_versions`: Video version list\n        - `image_versions2`: Cover image version list\n- `data.page_info`: Pagination info\n    - `has_next_page`: Whether has next page\n    - `end_cursor`: Next page cursor (use as after parameter in next request)\n### Pagination usage:\n1. First request: Only pass `first` parameter\n2. Get `data.page_info.end_cursor` from response\n3. Next request: Pass `first` and `after` (use end_cursor from previous)\n4. Repeat steps 2-3 until `data.page_info.has_next_page` is false\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nfirst = 12","operationId":"get_recommended_reels_api_v1_instagram_v3_get_recommended_reels_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"first","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"获取数量/Number of reels to fetch","default":12,"title":"First"},"description":"获取数量/Number of reels to fetch"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求不传，从上一次响应的 page_info.end_cursor 获取/Pagination cursor, omit for first request, get from previous response page_info.end_cursor","title":"After"},"description":"分页游标，首次请求不传，从上一次响应的 page_info.end_cursor 获取/Pagination cursor, omit for first request, get from previous response page_info.end_cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_post_info":{"get":{"tags":["Instagram-V3-API"],"summary":"获取帖子详情/Get post info (media_id or URL)","description":"# [中文]\n### 用途:\n- 通过媒体ID获取帖子详情\n- 返回帖子的完整信息，包括图片/视频、点赞数、评论数、发布者信息等\n### 参数:\n- media_id: 帖子的媒体ID（数字ID，必填），可通过 `/shortcode_to_media_id` 接口从短码转换获得\n### 返回:\n- `data.items`: 帖子信息列表（通常只有一个元素）\n    - `id`: 帖子ID\n    - `code`: 帖子短代码\n    - `media_type`: 媒体类型（1=图片, 2=视频, 8=合集）\n    - `like_count`: 点赞数\n    - `comment_count`: 评论数\n    - `caption.text`: 帖子文本\n    - `user`: 发布者信息\n    - `image_versions2`: 图片版本列表\n    - `video_versions`: 视频版本列表（视频时存在）\n    - `carousel_media`: 合集媒体列表（合集时存在）\n    - `taken_at`: 发布时间戳\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get post details by media ID\n- Returns complete post info including images/videos, likes, comments, author info, etc.\n### Parameters:\n- media_id: Post media ID (numeric ID, required), can be obtained via `/shortcode_to_media_id` endpoint\n### Return:\n- `data.items`: Post info list (usually only one element)\n    - `id`: Post ID\n    - `code`: Post shortcode\n    - `media_type`: Media type (1=image, 2=video, 8=carousel)\n    - `like_count`: Likes count\n    - `comment_count`: Comments count\n    - `caption.text`: Post caption text\n    - `user`: Publisher info\n    - `image_versions2`: Image version list\n    - `video_versions`: Video version list (exists for videos)\n    - `carousel_media`: Carousel media list (exists for carousels)\n    - `taken_at`: Published timestamp\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\n```\nmedia_id = \"3850699893338385742\"\n```","operationId":"get_post_info_api_v1_instagram_v3_get_post_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"media_id","in":"query","required":true,"schema":{"type":"string","description":"帖子媒体ID/Post media ID","title":"Media Id"},"description":"帖子媒体ID/Post media ID","example":"3850699893338385742"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_post_info_by_code":{"get":{"tags":["Instagram-V3-API"],"summary":"获取帖子详情(code)/Get post info by shortcode","description":"# [中文]\n### 用途:\n- 通过帖子的短代码（code/shortcode）获取帖子详情\n- 短代码即帖子URL中的标识符，如 `https://www.instagram.com/p/DUajw4YkorV/` 中的 `DUajw4YkorV`\n- 返回帖子的完整信息\n### 参数:\n- code: 帖子短代码（如 DUajw4YkorV，必填）\n### 返回:\n- `data.items`: 帖子信息列表\n    - `id`: 帖子ID\n    - `code`: 帖子短代码\n    - `media_type`: 媒体类型（1=图片, 2=视频, 8=合集）\n    - `like_count`: 点赞数\n    - `comment_count`: 评论数\n    - `caption.text`: 帖子文本\n    - `user`: 发布者信息\n    - `image_versions2`: 图片版本列表\n    - `video_versions`: 视频版本列表（视频时存在）\n    - `carousel_media`: 合集媒体列表（合集时存在）\n    - `taken_at`: 发布时间戳\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get post details by shortcode\n- Shortcode is the identifier in the post URL, e.g., `DUajw4YkorV` from `https://www.instagram.com/p/DUajw4YkorV/`\n- Returns complete post info\n### Parameters:\n- code: Post shortcode (e.g., DUajw4YkorV, required)\n### Return:\n- `data.items`: Post info list\n    - `id`: Post ID\n    - `code`: Post shortcode\n    - `media_type`: Media type (1=image, 2=video, 8=carousel)\n    - `like_count`: Likes count\n    - `comment_count`: Comments count\n    - `caption.text`: Post caption text\n    - `user`: Publisher info\n    - `image_versions2`: Image version list\n    - `video_versions`: Video version list (exists for videos)\n    - `carousel_media`: Carousel media list (exists for carousels)\n    - `taken_at`: Published timestamp\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\ncode = \"DUajw4YkorV\"","operationId":"get_post_info_by_code_api_v1_instagram_v3_get_post_info_by_code_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"query","required":true,"schema":{"type":"string","description":"帖子短代码/Post shortcode","title":"Code"},"description":"帖子短代码/Post shortcode","example":"DUajw4YkorV"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_post_comments":{"get":{"tags":["Instagram-V3-API"],"summary":"获取帖子评论/Get post comments","description":"# [中文]\n### 用途:\n- 获取Instagram帖子的评论列表\n- 支持分页获取所有评论\n- 支持按热门或最新排序\n### 参数:\n- code: 帖子短代码（如 DUajw4YkorV，必填）\n- min_id: 分页游标，首次请求不传，从上一次响应的 `data.next_min_id` 获取\n- sort_order: 排序方式\n    - `popular`: 按热门排序（默认）\n    - `newest`: 按最新排序\n### 返回:\n- `data.comments`: 评论列表\n    - `user`: 评论者信息\n    - `text`: 评论文本\n    - `created_at`: 评论时间戳\n    - `comment_like_count`: 评论点赞数\n    - `child_comment_count`: 子评论数\n- `data.next_min_id`: 下一页分页游标（传给下次请求的min_id参数）\n- `data.has_more_comments`: 是否有更多评论\n- `data.comment_count`: 评论总数\n### 分页使用方法:\n1. 首次请求：传 `code` 参数\n2. 获取响应中的 `data.next_min_id`\n3. 下次请求：将 `next_min_id` 原样传入 `min_id` 参数（无需预处理，接口会自动反转义）\n4. 重复步骤 2-3 直到 `data.has_more_comments` 为 false\n\n### 注意:\n- `min_id` 是接口返回的转义 JSON 字符串（如 `\"{\"cached_comments_cursor\":\"xxx\",\"bifilter_token\":\"xxx\"}\"`），直接原样传入即可，接口内部会自动反转义处理\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram post comment list\n- Support pagination to fetch all comments\n- Support sorting by popular or newest\n### Parameters:\n- code: Post shortcode (e.g., DUajw4YkorV, required)\n- min_id: Pagination cursor, omit for first request, get from previous response `data.next_min_id`\n- sort_order: Sort order\n    - `popular`: Sort by popular (default)\n    - `newest`: Sort by newest\n### Return:\n- `data.comments`: Comment list\n    - `user`: Commenter info\n    - `text`: Comment text\n    - `created_at`: Comment timestamp\n    - `comment_like_count`: Comment likes count\n    - `child_comment_count`: Child comments count\n- `data.next_min_id`: Next page cursor (use as min_id in next request)\n- `data.has_more_comments`: Whether has more comments\n- `data.comment_count`: Total comment count\n### Pagination usage:\n1. First request: Pass `code` parameter\n2. Get `data.next_min_id` from response\n3. Next request: Pass `next_min_id` as-is to `min_id` parameter (no pre-processing needed, the API handles unescaping automatically)\n4. Repeat steps 2-3 until `data.has_more_comments` is false\n\n### Note:\n- `min_id` is an escaped JSON string returned by the API (e.g., `\"{\"cached_comments_cursor\":\"xxx\",\"bifilter_token\":\"xxx\"}\"`), just pass it as-is, the API handles unescaping internally\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\ncode = \"DUajw4YkorV\"","operationId":"get_post_comments_api_v1_instagram_v3_get_post_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"query","required":true,"schema":{"type":"string","description":"帖子短代码/Post shortcode (e.g., DUajw4YkorV)","title":"Code"},"description":"帖子短代码/Post shortcode (e.g., DUajw4YkorV)","example":"DUajw4YkorV"},{"name":"min_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求不传，从上一次响应的 next_min_id 获取/Pagination cursor, omit for first request, get from previous response next_min_id","title":"Min Id"},"description":"分页游标，首次请求不传，从上一次响应的 next_min_id 获取/Pagination cursor, omit for first request, get from previous response next_min_id"},{"name":"sort_order","in":"query","required":false,"schema":{"enum":["popular","newest"],"type":"string","description":"排序方式/Sort order. 可选值/Options: popular(热门), newest(最新). Example: popular","default":"popular","title":"Sort Order"},"description":"排序方式/Sort order. 可选值/Options: popular(热门), newest(最新). Example: popular"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_comment_replies":{"get":{"tags":["Instagram-V3-API"],"summary":"获取评论的子评论/回复/Get comment replies","description":"# [中文]\n### 用途:\n- 获取Instagram评论的子评论（回复）列表\n- 支持分页获取所有回复\n- 父评论的 comment_id 可从 get_post_comments 接口的评论列表中获取\n### 参数:\n- media_id: 帖子的媒体ID（数字ID，必填），可通过 `/shortcode_to_media_id` 接口从短码转换获得\n- comment_id: 父评论ID（必填，从 get_post_comments 返回的评论中获取 `pk` 字段）\n- min_id: 分页游标，首次请求不传，从上一次响应的 `data.next_min_child_cursor` 获取\n### 返回:\n- `data.child_comments`: 子评论列表\n    - `user`: 评论者信息\n    - `text`: 评论文本\n    - `created_at`: 评论时间戳\n    - `comment_like_count`: 评论点赞数\n    - `pk`: 评论ID\n- `data.next_min_child_cursor`: 下一页分页游标（传给下次请求的min_id参数）\n- `data.has_more_tail_child_comments`: 是否有更多子评论\n- `data.num_tail_child_comments`: 剩余子评论数\n### 分页使用方法:\n1. 首次请求：传 `media_id` 和 `comment_id` 参数\n2. 获取响应中的 `data.next_min_child_cursor`\n3. 下次请求：将 `next_min_child_cursor` 原样传入 `min_id` 参数（无需预处理，接口会自动反转义）\n4. 重复步骤 2-3 直到 `data.has_more_tail_child_comments` 为 false\n\n### 注意:\n- `min_id` 可能是转义 JSON 字符串（如 `{\"key\":\"val\"}`），直接原样传入即可，接口内部会自动反转义处理\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram comment's child comments (replies) list\n- Support pagination to fetch all replies\n- Parent comment's comment_id can be obtained from get_post_comments API\n### Parameters:\n- media_id: Post media ID (numeric ID, required), can be obtained via `/shortcode_to_media_id` endpoint\n- comment_id: Parent comment ID (required, get `pk` field from get_post_comments response)\n- min_id: Pagination cursor, omit for first request, get from previous response `data.next_min_child_cursor`\n### Return:\n- `data.child_comments`: Child comments list\n    - `user`: Commenter info\n    - `text`: Comment text\n    - `created_at`: Comment timestamp\n    - `comment_like_count`: Comment likes count\n    - `pk`: Comment ID\n- `data.next_min_child_cursor`: Next page cursor (use as min_id in next request)\n- `data.has_more_tail_child_comments`: Whether has more child comments\n- `data.num_tail_child_comments`: Remaining child comments count\n### Pagination usage:\n1. First request: Pass `media_id` and `comment_id` parameters\n2. Get `data.next_min_child_cursor` from response\n3. Next request: Pass `next_min_child_cursor` as-is to `min_id` parameter (no pre-processing needed, the API handles unescaping automatically)\n4. Repeat steps 2-3 until `data.has_more_tail_child_comments` is false\n\n### Note:\n- `min_id` may be an escaped JSON string (e.g. `{\"key\":\"val\"}`), just pass it as-is, the API handles unescaping internally\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nmedia_id = \"3829530490739515971\"\ncomment_id = \"18065937092249736\"","operationId":"get_comment_replies_api_v1_instagram_v3_get_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"media_id","in":"query","required":true,"schema":{"type":"string","description":"帖子媒体ID/Post media ID","title":"Media Id"},"description":"帖子媒体ID/Post media ID","example":"3829530490739515971"},{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"父评论ID/Parent comment ID","title":"Comment Id"},"description":"父评论ID/Parent comment ID","example":"18065937092249736"},{"name":"min_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求不传，从上一次响应的 next_min_child_cursor 获取/Pagination cursor, omit for first request, get from previous response next_min_child_cursor","title":"Min Id"},"description":"分页游标，首次请求不传，从上一次响应的 next_min_child_cursor 获取/Pagination cursor, omit for first request, get from previous response next_min_child_cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_post_oembed":{"get":{"tags":["Instagram-V3-API"],"summary":"获取帖子oEmbed内嵌信息/Get post oEmbed info","description":"# [中文]\n### 用途:\n- 获取Instagram帖子的oEmbed内嵌信息\n- 返回可直接嵌入网页的HTML代码和帖子元信息\n- 适用于需要在第三方网站嵌入Instagram帖子的场景\n### 参数:\n- url: Instagram帖子的完整URL（如 `https://www.instagram.com/p/xxx/` 或 `https://www.instagram.com/reel/xxx/`）\n- hidecaption: 是否隐藏帖子文本（默认false）\n- maxwidth: 嵌入的最大宽度（像素，默认540）\n### 返回:\n- `data.version`: oEmbed版本\n- `data.title`: 帖子标题\n- `data.author_name`: 作者名称\n- `data.author_url`: 作者主页URL\n- `data.author_id`: 作者ID\n- `data.media_id`: 媒体ID\n- `data.provider_name`: 提供者名称（Instagram）\n- `data.provider_url`: 提供者URL\n- `data.type`: 类型（rich）\n- `data.width`: 宽度\n- `data.html`: HTML嵌入代码\n- `data.thumbnail_url`: 缩略图URL\n- `data.thumbnail_width`: 缩略图宽度\n- `data.thumbnail_height`: 缩略图高度\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram post oEmbed embed info\n- Returns HTML code for embedding and post metadata\n- Suitable for embedding Instagram posts on third-party websites\n### Parameters:\n- url: Full Instagram post URL (e.g., `https://www.instagram.com/p/xxx/` or `https://www.instagram.com/reel/xxx/`)\n- hidecaption: Whether to hide caption (default false)\n- maxwidth: Max embed width in pixels (default 540)\n### Return:\n- `data.version`: oEmbed version\n- `data.title`: Post title\n- `data.author_name`: Author name\n- `data.author_url`: Author profile URL\n- `data.author_id`: Author ID\n- `data.media_id`: Media ID\n- `data.provider_name`: Provider name (Instagram)\n- `data.provider_url`: Provider URL\n- `data.type`: Type (rich)\n- `data.width`: Width\n- `data.html`: HTML embed code\n- `data.thumbnail_url`: Thumbnail URL\n- `data.thumbnail_width`: Thumbnail width\n- `data.thumbnail_height`: Thumbnail height\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nurl = \"https://www.instagram.com/reel/DUlObENDmJD\"","operationId":"get_post_oembed_api_v1_instagram_v3_get_post_oembed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"Instagram帖子的完整URL/Full URL of Instagram post","title":"Url"},"description":"Instagram帖子的完整URL/Full URL of Instagram post","example":"https://www.instagram.com/reel/DUlObENDmJD"},{"name":"hidecaption","in":"query","required":false,"schema":{"type":"boolean","description":"是否隐藏帖子文本/Whether to hide caption","default":false,"title":"Hidecaption"},"description":"是否隐藏帖子文本/Whether to hide caption"},{"name":"maxwidth","in":"query","required":false,"schema":{"type":"integer","description":"最大宽度（像素）/Max width in pixels","default":540,"title":"Maxwidth"},"description":"最大宽度（像素）/Max width in pixels"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/translate_comment":{"get":{"tags":["Instagram-V3-API"],"summary":"翻译评论/帖子文本/Translate comment or caption","description":"# [中文]\n### 用途:\n- 翻译Instagram帖子文本（caption）\n- 内部强制 is_caption=True，专门用于翻译帖子的文字说明\n### 参数:\n- comment_id: 帖子媒体ID\n### 返回:\n- `data.translation`: 翻译后的文本\n- `data.source_language`: 原文语言\n### 注意:\n- 翻译目标语言取决于请求所使用的 Cookie 对应账号的语言设置（通常为英语）\n- 无法指定翻译目标语言，由 Instagram 服务端根据账号设置自动决定\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Translate Instagram post caption\n- Internally forces is_caption=True, specifically for translating post captions\n### Parameters:\n- comment_id: Post media ID\n### Return:\n- `data.translation`: Translated text\n- `data.source_language`: Source language\n### Note:\n- The target translation language depends on the language setting of the account associated with the cookie used (usually English)\n- Cannot specify the target language, it is automatically determined by Instagram based on the account settings\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\ncomment_id = \"18191961100350646\"","operationId":"translate_comment_api_v1_instagram_v3_translate_comment_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"评论ID或帖子caption的media_id/Comment ID or caption media ID","title":"Comment Id"},"description":"评论ID或帖子caption的media_id/Comment ID or caption media ID","example":"18191961100350646"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/bulk_translate_comments":{"get":{"tags":["Instagram-V3-API"],"summary":"批量翻译评论/Bulk translate comments","description":"# [中文]\n### 用途:\n- 批量翻译Instagram评论\n- 支持同时翻译多条评论，效率更高\n- 评论ID可从 get_post_comments 接口获取\n### 参数:\n- comment_ids: 评论ID列表，多个ID用逗号分隔，**最多10条**\n    - 例如: `18099342953509681` （单个）\n    - 例如: `18099342953509681,18099342953509682,18099342953509683` （多个）\n### 注意:\n- 单次请求最多支持10条评论ID，超过会返回错误\n### 返回:\n- `data.comment_translations`: 翻译结果映射\n    - key: 评论ID\n    - value: 翻译后的文本\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Bulk translate Instagram comments\n- Support translating multiple comments at once for better efficiency\n- Comment IDs can be obtained from get_post_comments API\n### Parameters:\n- comment_ids: Comment ID list, separated by commas, **max 10 IDs**\n    - Example: `18099342953509681` (single)\n    - Example: `18099342953509681,18099342953509682,18099342953509683` (multiple)\n### Note:\n- Maximum 10 comment IDs per request, exceeding will return an error\n### Return:\n- `data.comment_translations`: Translation result mapping\n    - key: Comment ID\n    - value: Translated text\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\n```\ncomment_ids = \"18099342953509681\"\n# comment_ids = \"18099342953509681,18099342953509682\"\n```","operationId":"bulk_translate_comments_api_v1_instagram_v3_bulk_translate_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"comment_ids","in":"query","required":true,"schema":{"type":"string","description":"评论ID列表，逗号分隔/Comment ID list, comma separated","title":"Comment Ids"},"description":"评论ID列表，逗号分隔/Comment ID list, comma separated","example":"18099342953509681"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_explore":{"get":{"tags":["Instagram-V3-API"],"summary":"获取探索页推荐帖子/Get explore feed","description":"# [中文]\n### 用途:\n- 获取Instagram探索/发现页的推荐帖子\n- 返回个性化推荐的帖子列表\n- 支持分页获取更多推荐内容\n### 参数:\n- max_id: 分页游标，首次请求不传，从上一次响应的 `data.next_max_id` 获取\n### 返回:\n- `data.sectional_items`: 推荐内容分区列表\n    - `layout_content.medias`: 媒体列表\n        - `media.id`: 帖子ID\n        - `media.code`: 帖子短代码\n        - `media.media_type`: 媒体类型（1=图片, 2=视频, 8=合集）\n        - `media.like_count`: 点赞数\n        - `media.comment_count`: 评论数\n        - `media.caption.text`: 帖子文本\n        - `media.user`: 发布者信息\n        - `media.image_versions2`: 图片版本列表\n        - `media.video_versions`: 视频版本列表（视频时存在）\n- `data.next_max_id`: 下一页分页游标（传给下次请求的max_id参数）\n- `data.more_available`: 是否有更多内容\n### 分页使用方法:\n1. 首次请求：不传任何参数\n2. 获取响应中的 `data.next_max_id`\n3. 下次请求：传入 `max_id` (使用上次的next_max_id)\n4. 重复步骤 2-3 直到 `data.more_available` 为 false\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram Explore/Discover page recommended posts\n- Returns personalized recommended post list\n- Support pagination to fetch more recommendations\n### Parameters:\n- max_id: Pagination cursor, omit for first request, get from previous response `data.next_max_id`\n### Return:\n- `data.sectional_items`: Recommended content section list\n    - `layout_content.medias`: Media list\n        - `media.id`: Post ID\n        - `media.code`: Post shortcode\n        - `media.media_type`: Media type (1=image, 2=video, 8=carousel)\n        - `media.like_count`: Likes count\n        - `media.comment_count`: Comments count\n        - `media.caption.text`: Post caption text\n        - `media.user`: Publisher info\n        - `media.image_versions2`: Image version list\n        - `media.video_versions`: Video version list (exists for videos)\n- `data.next_max_id`: Next page cursor (use as max_id in next request)\n- `data.more_available`: Whether has more content\n### Pagination usage:\n1. First request: No parameters needed\n2. Get `data.next_max_id` from response\n3. Next request: Pass `max_id` (use next_max_id from previous)\n4. Repeat steps 2-3 until `data.more_available` is false\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\n```\n# 第一页 / First page (不传参数 / no parameters)\n# 第二页 / Second page\n# max_id = \"...\"  # 从第一页响应中获取 / Get from first page response\n```","operationId":"get_explore_api_v1_instagram_v3_get_explore_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求不传，从上一次响应的 next_max_id 获取/Pagination cursor, omit for first request, get from previous response next_max_id","title":"Max Id"},"description":"分页游标，首次请求不传，从上一次响应的 next_max_id 获取/Pagination cursor, omit for first request, get from previous response next_max_id"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_following":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户关注列表/Get user following list","description":"# [中文]\n### 用途:\n- 获取Instagram用户的关注列表\n- 返回用户关注的所有账号信息\n- 支持分页获取\n### 参数:\n- user_id: Instagram用户ID（数字，与username二选一）\n- username: Instagram用户名（与user_id二选一，传入后会自动转换为user_id）\n- count: 每次获取数量（默认12，最大100）\n- max_id: 分页游标，首次请求不传，从上一次响应的 `data.next_max_id` 获取\n### 返回:\n- `data.users`: 关注用户列表\n    - `pk`: 用户ID\n    - `username`: 用户名\n    - `full_name`: 全名\n    - `is_private`: 是否私密账号\n    - `is_verified`: 是否认证\n    - `profile_pic_url`: 头像URL\n- `data.next_max_id`: 下一页分页游标（传给下次请求的max_id参数）\n- `data.big_list`: 是否有更多数据\n- `data.page_size`: 每页数量\n- `data.status`: 状态\n### 分页使用方法:\n1. 首次请求：只传 `user_id` 和 `count` 参数\n2. 获取响应中的 `data.next_max_id`\n3. 下次请求：传入 `user_id`、`count` 和 `max_id` (使用上次的next_max_id)\n4. 重复步骤 2-3 直到响应中没有 `next_max_id` 字段\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user's following list\n- Returns all accounts the user follows\n- Support pagination\n### Parameters:\n- user_id: Instagram user ID (numeric, either user_id or username is required)\n- username: Instagram username (alternative to user_id, will be automatically converted to user_id)\n- count: Number of users to fetch per request (default 12, max 100)\n- max_id: Pagination cursor, omit for first request, get from previous response `data.next_max_id`\n### Return:\n- `data.users`: Following user list\n    - `pk`: User ID\n    - `username`: Username\n    - `full_name`: Full name\n    - `is_private`: Whether private account\n    - `is_verified`: Whether verified\n    - `profile_pic_url`: Profile picture URL\n- `data.next_max_id`: Next page cursor (use as max_id in next request)\n- `data.big_list`: Whether has more data\n- `data.page_size`: Page size\n- `data.status`: Status\n### Pagination usage:\n1. First request: Only pass `user_id` and `count` parameters\n2. Get `data.next_max_id` from response\n3. Next request: Pass `user_id`, `count`, and `max_id` (use next_max_id from previous)\n4. Repeat steps 2-3 until response has no `next_max_id` field\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nuser_id = \"58208242181\"\ncount = 12","operationId":"get_user_following_api_v1_instagram_v3_get_user_following_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"58208242181"},{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名（与user_id二选一）/Username (alternative to user_id)","title":"Username"},"description":"用户名（与user_id二选一）/Username (alternative to user_id)","example":"instagram"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"每次获取数量/Number of users to fetch per request","default":12,"title":"Count"},"description":"每次获取数量/Number of users to fetch per request"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求不传，从上一次响应的 next_max_id 获取/Pagination cursor, omit for first request, get from previous response next_max_id","title":"Max Id"},"description":"分页游标，首次请求不传，从上一次响应的 next_max_id 获取/Pagination cursor, omit for first request, get from previous response next_max_id"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_user_followers":{"get":{"tags":["Instagram-V3-API"],"summary":"获取用户粉丝列表/Get user followers list","description":"# [中文]\n### 用途:\n- 获取Instagram用户的粉丝列表\n- 返回关注该用户的所有账号信息\n- 支持分页获取\n### 参数:\n- user_id: Instagram用户ID（数字，与username二选一）\n- username: Instagram用户名（与user_id二选一，传入后会自动转换为user_id）\n- count: 每次获取数量（默认12，最大100）\n- max_id: 分页游标，首次请求不传，从上一次响应的 `data.next_max_id` 获取\n### 返回:\n- `data.users`: 粉丝用户列表\n    - `pk`: 用户ID\n    - `username`: 用户名\n    - `full_name`: 全名\n    - `is_private`: 是否私密账号\n    - `is_verified`: 是否认证\n    - `profile_pic_url`: 头像URL\n- `data.next_max_id`: 下一页分页游标（传给下次请求的max_id参数）\n- `data.big_list`: 是否有更多数据\n- `data.page_size`: 每页数量\n- `data.status`: 状态\n### 分页使用方法:\n1. 首次请求：只传 `user_id` 和 `count` 参数\n2. 获取响应中的 `data.next_max_id`\n3. 下次请求：传入 `user_id`、`count` 和 `max_id` (使用上次的next_max_id)\n4. 重复步骤 2-3 直到响应中没有 `next_max_id` 字段\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram user's followers list\n- Returns all accounts that follow this user\n- Support pagination\n### Parameters:\n- user_id: Instagram user ID (numeric, either user_id or username is required)\n- username: Instagram username (alternative to user_id, will be automatically converted to user_id)\n- count: Number of users to fetch per request (default 12, max 100)\n- max_id: Pagination cursor, omit for first request, get from previous response `data.next_max_id`\n### Return:\n- `data.users`: Followers user list\n    - `pk`: User ID\n    - `username`: Username\n    - `full_name`: Full name\n    - `is_private`: Whether private account\n    - `is_verified`: Whether verified\n    - `profile_pic_url`: Profile picture URL\n- `data.next_max_id`: Next page cursor (use as max_id in next request)\n- `data.big_list`: Whether has more data\n- `data.page_size`: Page size\n- `data.status`: Status\n### Pagination usage:\n1. First request: Only pass `user_id` and `count` parameters\n2. Get `data.next_max_id` from response\n3. Next request: Pass `user_id`, `count`, and `max_id` (use next_max_id from previous)\n4. Repeat steps 2-3 until response has no `next_max_id` field\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nuser_id = \"58208242181\"\ncount = 12","operationId":"get_user_followers_api_v1_instagram_v3_get_user_followers_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"58208242181"},{"name":"username","in":"query","required":false,"schema":{"type":"string","description":"用户名（与user_id二选一）/Username (alternative to user_id)","title":"Username"},"description":"用户名（与user_id二选一）/Username (alternative to user_id)","example":"instagram"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"每次获取数量/Number of users to fetch per request","default":12,"title":"Count"},"description":"每次获取数量/Number of users to fetch per request"},{"name":"max_id","in":"query","required":false,"schema":{"type":"string","description":"分页游标，首次请求不传，从上一次响应的 next_max_id 获取/Pagination cursor, omit for first request, get from previous response next_max_id","title":"Max Id"},"description":"分页游标，首次请求不传，从上一次响应的 next_max_id 获取/Pagination cursor, omit for first request, get from previous response next_max_id"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_location_info":{"get":{"tags":["Instagram-V3-API"],"summary":"获取地点详情/Get location info","description":"# [中文]\n### 用途:\n- 获取Instagram地点的详细信息\n- 包含地点名称、地址、坐标、附近地点等\n- 地点ID可从搜索接口（search_places）或帖子详情中获取\n### 参数:\n- location_id: 地点ID（数字）\n- show_nearby: 是否显示附近地点（默认true）\n### 返回:\n- `data.native_location_data`: 地点基本信息\n    - `name`: 地点名称\n    - `address`: 地址\n    - `city`: 城市\n    - `lat`: 纬度\n    - `lng`: 经度\n    - `website`: 网站\n    - `phone`: 电话\n    - `category`: 分类\n    - `media_count`: 关联帖子数\n- `data.ranked`: 热门帖子信息\n- `data.recent`: 最新帖子信息\n- `data.nearby_locations`: 附近地点列表（show_nearby=true时）\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram location/place detail info\n- Including name, address, coordinates, nearby places, etc.\n- Location ID can be obtained from search API (search_places) or post details\n### Parameters:\n- location_id: Location ID (numeric)\n- show_nearby: Whether to show nearby places (default true)\n### Return:\n- `data.native_location_data`: Location basic info\n    - `name`: Location name\n    - `address`: Address\n    - `city`: City\n    - `lat`: Latitude\n    - `lng`: Longitude\n    - `website`: Website\n    - `phone`: Phone\n    - `category`: Category\n    - `media_count`: Associated posts count\n- `data.ranked`: Top posts info\n- `data.recent`: Recent posts info\n- `data.nearby_locations`: Nearby locations list (when show_nearby=true)\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nlocation_id = \"1016248898\"","operationId":"get_location_info_api_v1_instagram_v3_get_location_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"location_id","in":"query","required":true,"schema":{"type":"string","description":"地点ID/Location ID","title":"Location Id"},"description":"地点ID/Location ID","example":"1016248898"},{"name":"show_nearby","in":"query","required":false,"schema":{"type":"boolean","description":"是否显示附近地点/Whether to show nearby places","default":true,"title":"Show Nearby"},"description":"是否显示附近地点/Whether to show nearby places"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_location_posts":{"get":{"tags":["Instagram-V3-API"],"summary":"获取地点相关帖子/Get location posts","description":"# [中文]\n### 用途:\n- 获取Instagram地点相关的帖子列表\n- 支持按热门或最新排序\n- 地点ID可从搜索接口（search_places）或帖子详情中获取\n### 参数:\n- location_id: 地点ID（数字）\n- tab: 帖子排序方式\n    - `ranked`: 热门帖子（默认）\n    - `recent`: 最新帖子\n- first: 翻页时每页数量（默认12，最大50）\n- after: 翻页游标，从上一次响应的 `page_info.end_cursor` 获取\n- page_size_override: 每页帖子数量（默认12）\n### 返回:\n- `data.sections`: 帖子分区列表\n    - `layout_content.medias`: 媒体列表\n        - `media.id`: 帖子ID\n        - `media.code`: 帖子短代码\n        - `media.media_type`: 媒体类型（1=图片, 2=视频, 8=合集）\n        - `media.like_count`: 点赞数\n        - `media.comment_count`: 评论数\n        - `media.caption.text`: 帖子文本\n        - `media.user`: 发布者信息\n- `data.next_max_id`: 下一页分页游标\n- `data.next_page`: 下一页信息\n- `data.more_available`: 是否有更多内容\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get Instagram location-related posts\n- Support sorting by top or latest\n- Location ID can be obtained from search API (search_places) or post details\n### Parameters:\n- location_id: Location ID (numeric)\n- tab: Post sort order\n    - `ranked`: Top posts (default)\n    - `recent`: Latest posts\n- first: Posts per page (default 12, max 50)\n- after: Pagination cursor from previous response `page_info.end_cursor`\n- page_size_override: Posts per page (default 12)\n### Return:\n- `data.sections`: Post section list\n    - `layout_content.medias`: Media list\n        - `media.id`: Post ID\n        - `media.code`: Post shortcode\n        - `media.media_type`: Media type (1=image, 2=video, 8=carousel)\n        - `media.like_count`: Likes count\n        - `media.comment_count`: Comments count\n        - `media.caption.text`: Post caption text\n        - `media.user`: Publisher info\n- `data.next_max_id`: Next page cursor\n- `data.next_page`: Next page info\n- `data.more_available`: Whether has more content\n### Price:\n- 0.002 USD/request\n\n### 示例/Example\nlocation_id = \"1016248898\"\ntab = \"ranked\"","operationId":"get_location_posts_api_v1_instagram_v3_get_location_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"location_id","in":"query","required":true,"schema":{"type":"string","description":"地点ID/Location ID","title":"Location Id"},"description":"地点ID/Location ID","example":"1016248898"},{"name":"tab","in":"query","required":false,"schema":{"enum":["ranked","recent"],"type":"string","description":"帖子类型/Post type. 可选值/Options: ranked(热门/top), recent(最新/latest). Example: ranked","default":"ranked","title":"Tab"},"description":"帖子类型/Post type. 可选值/Options: ranked(热门/top), recent(最新/latest). Example: ranked"},{"name":"first","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"翻页时每页数量/Posts per page","default":12,"title":"First"},"description":"翻页时每页数量/Posts per page"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"翻页游标，从上一次响应的end_cursor获取/Pagination cursor from previous response end_cursor","title":"After"},"description":"翻页游标，从上一次响应的end_cursor获取/Pagination cursor from previous response end_cursor"},{"name":"page_size_override","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Page size","default":12,"title":"Page Size Override"},"description":"每页数量/Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/get_location_nearby":{"get":{"tags":["Instagram-V3-API"],"summary":"获取地点附近内容/Get nearby location content","description":"# [中文]\n### 用途:\n- 获取指定地点附近的本地内容聚合，包括附近地点、热门帖子等\n- 适合用于发现某个地理区域内的相关内容\n### 参数:\n- location_id: 地点ID，可从帖子数据的 `location.id` 获取，或通过 `/search_places` 搜索获得\n### 价格:\n- 0.002 USD/请求\n\n# [English]\n### Purpose:\n- Get nearby local content aggregation for a location, including nearby places and popular posts\n- Useful for discovering related content in a geographic area\n### Parameters:\n- location_id: Location ID, from post data `location.id` or via `/search_places`\n### Price:\n- 0.002 USD/request","operationId":"get_location_nearby_api_v1_instagram_v3_get_location_nearby_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"location_id","in":"query","required":true,"schema":{"type":"string","description":"地点ID（数字）/Location ID (numeric)","title":"Location Id"},"description":"地点ID（数字）/Location ID (numeric)","example":"213385402"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/shortcode_to_media_id":{"get":{"tags":["Instagram-V3-API"],"summary":"短码转媒体ID/Convert shortcode to media ID","description":"# [中文]\n### 用途:\n- 将帖子短码（shortcode）转换为数字媒体ID（media_id）\n- 短码是帖子URL中的标识符，如 `https://www.instagram.com/p/ABC123xyz/` 中的 `ABC123xyz`\n\n# [English]\n### Purpose:\n- Convert post shortcode to numeric media_id","operationId":"shortcode_to_media_id_api_v1_instagram_v3_shortcode_to_media_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"shortcode","in":"query","required":true,"schema":{"type":"string","description":"帖子短码/Post shortcode","title":"Shortcode"},"description":"帖子短码/Post shortcode","example":"CrgVBtHrFHm"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/media_id_to_shortcode":{"get":{"tags":["Instagram-V3-API"],"summary":"媒体ID转短码/Convert media ID to shortcode","description":"# [中文]\n### 用途:\n- 将数字媒体ID（media_id）转换为帖子短码（shortcode）\n- 短码可用于构建帖子URL：instagram.com/p/{shortcode}/\n### 参数:\n- media_id: 帖子的媒体ID（数字ID）\n### 返回:\n- `data.media_id`: 原始媒体ID\n- `data.shortcode`: 转换后的短码\n### 价格:\n- 0.001 USD/请求\n\n# [English]\n### Purpose:\n- Convert numeric media_id to post shortcode\n- Shortcode can be used to construct post URL: instagram.com/p/{shortcode}/\n### Parameters:\n- media_id: Post media ID (numeric ID)\n### Return:\n- `data.media_id`: Original media ID\n- `data.shortcode`: Converted shortcode\n### Price:\n- 0.001 USD/request\n\n# [示例/Example]\nmedia_id = \"3850699893338385742\"","operationId":"media_id_to_shortcode_api_v1_instagram_v3_media_id_to_shortcode_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"media_id","in":"query","required":true,"schema":{"type":"string","description":"帖子媒体ID/Post media ID","title":"Media Id"},"description":"帖子媒体ID/Post media ID","example":"3850699893338385742"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/instagram/v3/extract_shortcode":{"get":{"tags":["Instagram-V3-API"],"summary":"从URL提取短码/Extract shortcode from URL","description":"# [中文]\n### 用途:\n- 从完整的Instagram帖子URL中提取短码\n- 支持 /p/、/reel/、/reels/、/tv/ 格式的URL\n\n# [English]\n### Purpose:\n- Extract shortcode from full Instagram post URL\n- Supports /p/, /reel/, /reels/, /tv/ URL formats","operationId":"extract_shortcode_api_v1_instagram_v3_extract_shortcode_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"Instagram帖子完整URL/Full Instagram post URL","title":"Url"},"description":"Instagram帖子完整URL/Full Instagram post URL","example":"https://www.instagram.com/p/CrgVBtHrFHm/"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_video_info":{"get":{"tags":["YouTube-Web-API"],"summary":"获取视频信息 V1/Get video information V1","description":"# [中文]\n### 用途:\n- 获取视频元数据及下载信息\n- 此接口收费: 0.002$/次\n- 如果需要节省成本，可以使用V2版本，V2版本是0.001$/次，但不保证稳定性。\n### 详细参数:\n- url_access:\n    - normal: 包含音视频直链\n    - blocked: 不包含直链\n- videos/audios:\n    - auto: 根据url_access自动选择（normal→true，blocked→false）\n    - true: 返回简化格式信息\n    - raw: 返回原始格式信息\n    - false: 不包含该类型数据\n### 返回:\n- 视频元数据 + 请求参数对应的资源信息\n\n# [English]\n### Purpose:\n- Get video metadata and download information\n- This endpoint is charged: 0.002$/request\n- To save cost, you can use V2 version, which is 0.001$/request, but stability is not guaranteed.\n### Parameters Detail:\n- url_access:\n    - normal: Include direct URLs\n    - blocked: Exclude direct URLs\n- videos/audios:\n    - auto: Auto-select based on url_access (normal→true，blocked→false)\n    - true: Simplified format\n    - raw: Original format\n    - false: Exclude this type\n### Returns:\n- Video metadata + requested resource information\n\n# [示例/Example]\nvideo_id = \"LuIL5JATZsc\"\nurl_access = \"blocked\"\nlang = \"zh-CN\"\n\nvideo_id = \"LuIL5JATZsc\"\nurl_access = \"normal\"\nlang = \"en-US\"\nvideos = \"auto\"\naudios = \"auto\"\nsubtitles = True","operationId":"get_video_info_api_v1_youtube_web_get_video_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":true,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"LuIL5JATZsc"},{"name":"url_access","in":"query","required":false,"schema":{"$ref":"#/components/schemas/UrlAccessMode","description":"URL访问模式：normal（包含音视频URL）| blocked（不包含音视频URL） / URL access mode","default":"normal"},"description":"URL访问模式：normal（包含音视频URL）| blocked（不包含音视频URL） / URL access mode"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","description":"语言代码（IETF标签），默认en-US / Language code","default":"en-US","title":"Lang"},"description":"语言代码（IETF标签），默认en-US / Language code","example":"zh-CN"},{"name":"videos","in":"query","required":false,"schema":{"$ref":"#/components/schemas/VideosAudiosMode","description":"视频格式：auto（自动）| true（简化格式）| raw（原始格式）| false（不获取） / Video format selection","default":"auto"},"description":"视频格式：auto（自动）| true（简化格式）| raw（原始格式）| false（不获取） / Video format selection"},{"name":"audios","in":"query","required":false,"schema":{"$ref":"#/components/schemas/VideosAudiosMode","description":"音频格式：auto（自动）| true（简化格式）| raw（原始格式）| false（不获取） / Audio format selection","default":"auto"},"description":"音频格式：auto（自动）| true（简化格式）| raw（原始格式）| false（不获取） / Audio format selection"},{"name":"subtitles","in":"query","required":false,"schema":{"type":"boolean","description":"是否获取字幕 / Include subtitles","default":true,"title":"Subtitles"},"description":"是否获取字幕 / Include subtitles"},{"name":"related","in":"query","required":false,"schema":{"type":"boolean","description":"是否获取相关视频 / Include related content","default":true,"title":"Related"},"description":"是否获取相关视频 / Include related content"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_video_info_v2":{"get":{"tags":["YouTube-Web-API"],"summary":"获取视频信息 V2/Get video information V2","description":"# [中文]\n### 用途:\n- 获取视频元数据及下载信息\n- 此接口收费: 0.001$/次\n### 参数:\n- video_id: 视频ID，从URL中获取，例如：https://www.youtube.com/watch?v=LuIL5JATZsc，这里的video_id就是LuIL5JATZsc。\n### 返回:\n- 视频元数据 + 请求参数对应的资源信息\n\n# [English]\n### Purpose:\n- Get video metadata and download information\n- This endpoint is charged: 0.001$/request\n### Parameters Detail:\n- video_id: Video ID, get it from the URL, for example: https://www.youtube.com/watch?v=LuIL5JATZsc, the id is LuIL5JATZsc.\n### Returns:\n- Video metadata + requested resource information\n\n# [示例/Example]\nvideo_id = \"LuIL5JATZsc\"","operationId":"get_video_info_v2_api_v1_youtube_web_get_video_info_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":true,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"LuIL5JATZsc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_video_info_v3":{"get":{"tags":["YouTube-Web-API"],"summary":"获取视频详情 V3/Get video information V3","description":"# [中文]\n### 用途:\n- 获取YouTube视频详情信息\n- 返回原始完整数据（包含 playerResponse 和 initialData）\n\n### 参数详解:\n\n#### 📌 必选参数:\n**video_id** (string)\n- **作用**: 视频ID\n- **获取方式**: 从视频URL中提取，例如 `https://www.youtube.com/watch?v=oaSNBz4qMQY`，video_id 就是 `oaSNBz4qMQY`\n- **示例**: `\"oaSNBz4qMQY\"`\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n### 返回数据结构:\n```json\n{\n  \"playerResponse\": {\n    \"videoDetails\": {},\n    \"streamingData\": {\n      \"formats\": [],\n      \"adaptiveFormats\": []\n    },\n    \"microformat\": {},\n    ...\n  },\n  \"initialData\": {\n    \"contents\": {\n      \"twoColumnWatchNextResults\": {\n        \"results\": {\n          \"results\": {\n            \"contents\": [\n              {\n                \"videoPrimaryInfoRenderer\": {...},\n                \"videoSecondaryInfoRenderer\": {...}\n              }\n            ]\n          }\n        }\n      }\n    },\n    ...\n  }\n}\n```\n\n### 主要字段说明:\n- `playerResponse`: YouTube 播放器响应数据\n  - `videoDetails`: 视频基本信息（可能为空，取决于YouTube的返回）\n  - `streamingData`: 视频流数据（包含 formats 和 adaptiveFormats，包含 googlevideo.com 的URL）\n  - `microformat`: 元数据信息\n- `initialData`: YouTube 页面初始化数据\n  - `videoPrimaryInfoRenderer`: 主要信息（标题、观看次数、点赞数等）\n  - `videoSecondaryInfoRenderer`: 次要信息（频道信息、描述等）\n\n# [English]\n### Purpose:\n- Get YouTube video details\n- Returns raw complete data (includes playerResponse and initialData)\n\n### Parameters:\n\n#### 📌 Required:\n**video_id** (string)\n- **Purpose**: Video ID\n- **How to get**: Extract from video URL, e.g., `https://www.youtube.com/watch?v=oaSNBz4qMQY`, video_id is `oaSNBz4qMQY`\n- **Example**: `\"oaSNBz4qMQY\"`\n\n#### ⚙️ Optional:\n**language_code** (string, optional)\n- **Purpose**: Set language preference\n- **Default**: `\"zh-CN\"`\n- **Values**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"`, etc.\n\n### Response Structure:\n```json\n{\n  \"playerResponse\": {\n    \"videoDetails\": {},\n    \"streamingData\": {\n      \"formats\": [],\n      \"adaptiveFormats\": []\n    },\n    \"microformat\": {},\n    ...\n  },\n  \"initialData\": {\n    \"contents\": {\n      \"twoColumnWatchNextResults\": {\n        \"results\": {\n          \"results\": {\n            \"contents\": [\n              {\n                \"videoPrimaryInfoRenderer\": {...},\n                \"videoSecondaryInfoRenderer\": {...}\n              }\n            ]\n          }\n        }\n      }\n    },\n    ...\n  }\n}\n```\n\n### Key Fields:\n- `playerResponse`: YouTube player response data\n  - `videoDetails`: Basic video info (may be empty depending on YouTube's response)\n  - `streamingData`: Video stream data (includes formats and adaptiveFormats with googlevideo.com URLs)\n  - `microformat`: Metadata information\n- `initialData`: YouTube page initialization data\n  - `videoPrimaryInfoRenderer`: Primary info (title, view count, like count, etc.)\n  - `videoSecondaryInfoRenderer`: Secondary info (channel info, description, etc.)\n\n# [示例/Examples]\n## 获取视频详情数据 / Get video details\nGET /youtube_web/get_video_info_v3?video_id=oaSNBz4qMQY\n\n## 指定语言 / Specify language\nGET /youtube_web/get_video_info_v3?video_id=oaSNBz4qMQY&language_code=en-US","operationId":"get_video_info_v3_api_v1_youtube_web_get_video_info_v3_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":true,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"oaSNBz4qMQY"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_video_subtitles":{"get":{"tags":["YouTube-Web-API"],"summary":"获取视频字幕/Get video subtitles","description":"# [中文]\n### 用途:\n- 获取视频字幕内容\n### 使用流程:\n1. 先调用获取视频详情接口，从字幕数据中获取subtitleUrl\n2. 使用该URL作为本接口参数\n### 参数说明:\n- fix_overlap: 特别适用于自动生成的字幕，会自动分割重叠的时间段\n\n# [English]\n### Purpose:\n- Get video subtitle content\n### Workflow:\n1. First call get_video_info to obtain subtitleUrl\n2. Use that URL as parameter here\n### Parameter Notes:\n- fix_overlap: Especially useful for auto-generated subtitles, will split overlapping time ranges\n\n# [示例/Example]\nsubtitle_url = \"https://www.youtube.com/api/timedtext?v=G33j5Qi4rE8...\"\ntarget_lang = \"zh-CN\"","operationId":"api_get_video_subtitles_api_v1_youtube_web_get_video_subtitles_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subtitle_url","in":"query","required":true,"schema":{"type":"string","description":"字幕URL（需先调用获取视频详情接口） / Subtitle URL from video details","title":"Subtitle Url"},"description":"字幕URL（需先调用获取视频详情接口） / Subtitle URL from video details","example":"https://www.youtube.com/api/timedtext?v=..."},{"name":"format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SubtitleFormat","description":"字幕格式：srt/xml/vtt/txt / Subtitle format","default":"srt"},"description":"字幕格式：srt/xml/vtt/txt / Subtitle format"},{"name":"fix_overlap","in":"query","required":false,"schema":{"type":"boolean","description":"修复重叠字幕（默认开启） / Fix overlapping subtitles","default":true,"title":"Fix Overlap"},"description":"修复重叠字幕（默认开启） / Fix overlapping subtitles"},{"name":"target_lang","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"目标语言代码（留空保持原语言） / Target language code","title":"Target Lang"},"description":"目标语言代码（留空保持原语言） / Target language code","example":"zh-CN"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_video_comments":{"get":{"tags":["YouTube-Web-API"],"summary":"获取视频评论/Get video comments","description":"# [中文]\n### 用途:\n- 获取YouTube视频的一级评论\n\n### 参数详解:\n\n#### 📌 必选参数:\n**video_id** (string)\n- **作用**: 视频ID\n- **格式**: YouTube视频ID字符串\n- **示例**: `\"oaSNBz4qMQY\"`\n- **获取方式**: 从URL `https://www.youtube.com/watch?v=oaSNBz4qMQY` 中提取\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置评论显示的语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n**country_code** (string, 可选)\n- **作用**: 设置地区代码\n- **默认值**: `\"US\"`\n- **可用值**: `\"US\"`, `\"JP\"`, `\"GB\"` 等\n\n**sort_by** (string, 可选)\n- **作用**: 评论排序方式\n- **默认值**: `\"top\"`\n- **可用值**:\n  - `\"top\"` - 热门评论（按点赞数排序）\n  - `\"newest\"` - 最新评论（按时间排序）\n\n**continuation_token** (string, 可选)\n- **作用**: 翻页令牌，用于获取下一页评论\n- **默认值**: `null`\n- **获取方式**: 从上一次请求的响应中提取\n\n**need_format** (boolean, 可选)\n- **作用**: 是否返回清洗后的精简数据\n- **默认值**: `false`\n- **可用值**:\n  - `false` - 返回原始完整数据\n  - `true` - 返回清洗后的精简数据（推荐）\n\n### 返回数据结构 (need_format=true):\n```json\n{\n  \"comments\": [\n    {\n      \"comment_id\": \"UgzRDoUJAvDNn5_8i8p4AaABAg\",\n      \"content\": \"评论内容文本\",\n      \"published_time\": \"1天前\",\n      \"reply_level\": 0,\n      \"like_count\": \"2\",\n      \"like_count_a11y\": \"2 次赞\",\n      \"reply_count\": \"0\",\n      \"reply_count_a11y\": \"0 条回复\",\n      \"reply_count_text\": \"1 条回复\",\n      \"reply_continuation_token\": \"...\",\n      \"author\": {\n        \"channel_id\": \"UCzRzHrLFuH0lHZYnrI84I8Q\",\n        \"display_name\": \"@username\",\n        \"channel_url\": \"https://www.youtube.com/@username\",\n        \"avatar_url\": \"https://yt3.ggpht.com/...\",\n        \"avatar_thumbnails\": [\n          {\"url\": \"...\", \"width\": 88, \"height\": 88}\n        ],\n        \"is_verified\": false,\n        \"is_creator\": false,\n        \"is_artist\": false\n      },\n      \"creator_thumbnail_url\": \"https://yt3.ggpht.com/...\"\n    }\n  ],\n  \"continuation_token\": \"下一页token\"\n}\n```\n\n### 字段说明:\n- `comment_id`: 评论唯一ID\n- `content`: 评论文本内容\n- `published_time`: 发布时间（相对时间，如\"1天前\"）\n- `reply_level`: 回复层级（0表示一级评论）\n- `like_count`: 点赞数\n- `reply_count`: 回复数\n- `reply_count_text`: 回复数文本（如\"1 条回复\"）\n- `reply_continuation_token`: 获取该评论回复的token\n- `author`: 评论作者信息\n  - `channel_id`: 作者频道ID\n  - `display_name`: 显示名称\n  - `channel_url`: 频道URL\n  - `avatar_url`: 头像URL\n  - `is_verified`: 是否已认证\n  - `is_creator`: 是否为视频创作者\n  - `is_artist`: 是否为音乐人\n- `creator_thumbnail_url`: 视频创作者头像URL\n\n# [English]\n### Purpose:\n- Get YouTube video first-level comments\n\n### Parameters:\n\n#### 📌 Required:\n**video_id** (string)\n- **Purpose**: Video ID\n- **Format**: YouTube video ID string\n- **Example**: `\"oaSNBz4qMQY\"`\n- **How to get**: Extract from URL `https://www.youtube.com/watch?v=oaSNBz4qMQY`\n\n#### ⚙️ Optional:\n**language_code** (string, optional)\n- **Purpose**: Set language preference for comments\n- **Default**: `\"zh-CN\"`\n- **Values**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"`, etc.\n\n**country_code** (string, optional)\n- **Purpose**: Set region code\n- **Default**: `\"US\"`\n- **Values**: `\"US\"`, `\"JP\"`, `\"GB\"`, etc.\n\n**sort_by** (string, optional)\n- **Purpose**: Comment sorting method\n- **Default**: `\"top\"`\n- **Values**:\n  - `\"top\"` - Top comments (sorted by likes)\n  - `\"newest\"` - Newest comments (sorted by time)\n\n**continuation_token** (string, optional)\n- **Purpose**: Pagination token for next page\n- **Default**: `null`\n- **How to get**: Extract from previous response\n\n**need_format** (boolean, optional)\n- **Purpose**: Whether to return cleaned simplified data\n- **Default**: `false`\n- **Values**:\n  - `false` - Return raw complete data\n  - `true` - Return cleaned simplified data (recommended)\n\n### Response Structure (need_format=true):\n```json\n{\n  \"comments\": [\n    {\n      \"comment_id\": \"UgzRDoUJAvDNn5_8i8p4AaABAg\",\n      \"content\": \"Comment text content\",\n      \"published_time\": \"1 day ago\",\n      \"reply_level\": 0,\n      \"like_count\": \"2\",\n      \"like_count_a11y\": \"2 likes\",\n      \"reply_count\": \"0\",\n      \"reply_count_a11y\": \"0 replies\",\n      \"reply_count_text\": \"1 reply\",\n      \"reply_continuation_token\": \"...\",\n      \"author\": {\n        \"channel_id\": \"UCzRzHrLFuH0lHZYnrI84I8Q\",\n        \"display_name\": \"@username\",\n        \"channel_url\": \"https://www.youtube.com/@username\",\n        \"avatar_url\": \"https://yt3.ggpht.com/...\",\n        \"avatar_thumbnails\": [\n          {\"url\": \"...\", \"width\": 88, \"height\": 88}\n        ],\n        \"is_verified\": false,\n        \"is_creator\": false,\n        \"is_artist\": false\n      },\n      \"creator_thumbnail_url\": \"https://yt3.ggpht.com/...\"\n    }\n  ],\n  \"continuation_token\": \"next page token\"\n}\n```\n\n### Field Descriptions:\n- `comment_id`: Unique comment ID\n- `content`: Comment text content\n- `published_time`: Published time (relative, e.g., \"1 day ago\")\n- `reply_level`: Reply level (0 for first-level comments)\n- `like_count`: Number of likes\n- `reply_count`: Number of replies\n- `reply_count_text`: Reply count text (e.g., \"1 reply\")\n- `reply_continuation_token`: Token to get replies for this comment\n- `author`: Comment author info\n  - `channel_id`: Author's channel ID\n  - `display_name`: Display name\n  - `channel_url`: Channel URL\n  - `avatar_url`: Avatar URL\n  - `is_verified`: Whether verified\n  - `is_creator`: Whether video creator\n  - `is_artist`: Whether artist\n- `creator_thumbnail_url`: Video creator's avatar URL\n\n# [示例/Examples]\n## 获取热门评论\nGET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&sort_by=top\n\n## 获取最新评论\nGET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&sort_by=newest\n\n## 获取清洗后的评论数据（推荐）\nGET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&need_format=true\n\n## 翻页获取更多评论\nGET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&continuation_token=xxx&need_format=true","operationId":"get_video_comments_api_v1_youtube_web_get_video_comments_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":true,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"LuIL5JATZsc"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, JP等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, JP等）/Country code","example":"US"},{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CommentSortByAPI","description":"排序方式 | Sort by","examples":{"top":{"summary":"热门评论","value":"top"},"newest":{"summary":"最新评论","value":"newest"}},"default":"top"},"description":"排序方式 | Sort by"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_video_comment_replies":{"get":{"tags":["YouTube-Web-API"],"summary":"获取视频二级评论/Get video sub comments","description":"# [中文]\n### 用途:\n- 获取视频二级评论\n\n### 参数详解:\n\n#### 📌 必选参数:\n**continuation_token** (string)\n- **作用**: 回复的continuation token\n- **获取方式**: 从一级评论的响应数据中获取 `reply_continuation_token` 字段\n- **示例**: `\"Eg0SC29hU05CejRxTVFZGAYygwEaUBIaVWd3WmhjUXVGUmJZTlhkUV85VjRBYUFCQWciAggAKhhVQ0pIQko3Ri1uQUlsTUdvbG0wSHU0dmcyC29hU05CejRxTVFZQAFICoIBAggBQi9jb21tZW50LXJlcGxpZXMtaXRlbS1VZ3daaGNRdUZSYllOWGRRXzlWNEFhQUJBZw%3D%3D\"`\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置回复显示的语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n**country_code** (string, 可选)\n- **作用**: 设置地区代码\n- **默认值**: `\"US\"`\n- **可用值**: `\"US\"`, `\"JP\"`, `\"GB\"` 等\n\n**need_format** (boolean, 可选)\n- **作用**: 是否返回清洗后的精简数据\n- **默认值**: `false`\n- **可用值**:\n  - `false` - 返回原始完整数据\n  - `true` - 返回清洗后的精简数据（推荐）\n\n### 使用流程:\n1. 先调用 `/get_video_comments` 接口获取一级评论\n2. 从一级评论的响应中找到 `reply_continuation_token` 字段\n3. 使用该 token 调用本接口获取该评论的所有回复\n\n### 返回数据结构 (need_format=true):\n```json\n{\n  \"comments\": [\n    {\n      \"comment_id\": \"UgwZhcQuFRbYNXdQ_9V4AaABAg.A2B3C4D5E6F7G8H9I0J1\",\n      \"content\": \"回复内容文本\",\n      \"published_time\": \"2天前\",\n      \"reply_level\": 1,\n      \"like_count\": \"5\",\n      \"like_count_a11y\": \"5 次赞\",\n      \"reply_count\": \"0\",\n      \"author\": {\n        \"channel_id\": \"UCxxxxxx\",\n        \"display_name\": \"@username\",\n        \"channel_url\": \"https://www.youtube.com/@username\",\n        \"avatar_url\": \"https://yt3.ggpht.com/...\",\n        \"is_verified\": false,\n        \"is_creator\": true,\n        \"is_artist\": false\n      }\n    }\n  ],\n  \"continuation_token\": \"下一页token（如果有更多回复）\"\n}\n```\n\n### 字段说明:\n- `reply_level`: 回复层级（1表示二级评论/回复）\n- `is_creator`: 是否为视频创作者（如果是创作者回复会标记为true）\n- 其他字段与一级评论相同\n\n# [English]\n### Purpose:\n- Get video second-level comments\n\n### Parameters:\n- id: Video ID, get it from the URL, for example: https://www.youtube.com/watch?v=LuIL5JATZsc, the id is LuIL5JATZsc.\n- continuation_token: Token to continue fetching comments. Default is None.\n### Returns:\n- Video comments.\n\n# [示例/Example]\nid = \"LuIL5JATZsc\"","operationId":"get_video_comment_replies_api_v1_youtube_web_get_video_comment_replies_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"continuation_token","in":"query","required":true,"schema":{"type":"string","description":"回复的continuation token（从一级评论的reply_continuation_token字段获取）/Reply continuation token from first-level comment","title":"Continuation Token"},"description":"回复的continuation token（从一级评论的reply_continuation_token字段获取）/Reply continuation token from first-level comment"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, JP等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, JP等）/Country code","example":"US"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_channel_description":{"get":{"tags":["YouTube-Web-API"],"summary":"获取频道描述信息/Get channel description","description":"# [中文]\n### 用途:\n- 获取YouTube频道的介绍信息（订阅数、视频数、观看次数、注册时间、社交链接等）\n\n### 重要提示 - 需要两次请求获取完整数据:\n- **第一次请求**（使用channel_id）: 返回基本信息（频道名称、描述、订阅数、视频数、头像、横幅等）\n- **第二次请求**（使用continuation_token）: 返回高级信息（**注册时间、社交媒体链接、国家、观看次数**等）\n\n### 如何获取channel_id:\n- 如果你只有频道URL（如 `https://www.youtube.com/@CozyCraftYT`），请先调用 **get_channel_id_v2** 接口获取channel_id\n- 该接口会返回类似 `UCeu6U67OzJhV1KwBansH3Dg` 的频道ID\n\n### 参数详解:\n\n#### 📌 必选参数（二选一）:\n**channel_id** (string)\n- **作用**: 频道ID，用于第一次请求获取频道基本信息\n- **格式**: 通常以 `UC` 开头的24位字符串\n- **示例**: `\"UCeu6U67OzJhV1KwBansH3Dg\"`\n- **获取方式**: 调用 **get_channel_id_v2** 接口，传入频道URL即可获取\n\n**continuation_token** (string)\n- **作用**: 翻页标志，用于第二次请求获取频道的高级信息\n- **获取方式**: 从第一次请求的响应中获取 `continuation_token` 字段\n- **注意**: `channel_id` 和 `continuation_token` 必须提供其中一个\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置显示语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n**country_code** (string, 可选)\n- **作用**: 设置地区代码\n- **默认值**: `\"US\"`\n- **可用值**: `\"US\"`, `\"JP\"`, `\"GB\"` 等\n\n**need_format** (boolean, 可选)\n- **作用**: 是否返回清洗后的精简数据\n- **默认值**: `false`\n- **可用值**:\n  - `false` - 返回原始完整数据\n  - `true` - 返回清洗后的精简数据（推荐）\n\n### 使用流程（三步获取完整数据）:\n1. **获取channel_id**: 如果只有频道URL，先调用 `get_channel_id_v2?channel_url=https://www.youtube.com/@CozyCraftYT`\n2. **第一次请求**: 使用 `channel_id` 参数获取频道基本信息，同时获取 `continuation_token`\n3. **第二次请求**: 使用 `continuation_token` 获取高级信息（注册时间、社交链接等）\n\n### 返回数据结构 (need_format=true):\n\n#### 第一次请求返回（使用channel_id）:\n```json\n{\n  \"channel_id\": \"UCeu6U67OzJhV1KwBansH3Dg\",\n  \"title\": \"CozyCraft\",\n  \"handle\": \"CozyCraftYT\",\n  \"description\": \"频道介绍...\",\n  \"subscriber_count\": \"9.84万位订阅者\",\n  \"video_count\": \"181 个视频\",\n  \"view_count\": null,\n  \"country\": null,\n  \"creation_date\": null,\n  \"links\": [],\n  \"avatar\": [{\"url\": \"...\", \"width\": 900, \"height\": 900}],\n  \"banner\": [{\"url\": \"...\", \"width\": 2560, \"height\": 424}],\n  \"keywords\": \"Minecraft Ambience...\",\n  \"channel_url\": \"https://www.youtube.com/channel/UCeu6U67OzJhV1KwBansH3Dg\",\n  \"vanity_url\": \"http://www.youtube.com/@CozyCraftYT\",\n  \"rss_url\": \"https://www.youtube.com/feeds/videos.xml?channel_id=UCeu6U67OzJhV1KwBansH3Dg\",\n  \"is_family_safe\": true,\n  \"verified\": false,\n  \"has_business_email\": false,\n  \"has_membership\": true,\n  \"continuation_token\": \"4qmFsgJg...\"\n}\n```\n\n#### 第二次请求返回（使用continuation_token）:\n```json\n{\n  \"channel_id\": \"UCeu6U67OzJhV1KwBansH3Dg\",\n  \"title\": null,\n  \"handle\": \"CozyCraftYT\",\n  \"description\": \"完整频道介绍...\",\n  \"subscriber_count\": \"98.4K subscribers\",\n  \"video_count\": \"181 videos\",\n  \"view_count\": \"53,218,926 views\",\n  \"country\": \"United States\",\n  \"creation_date\": \"Oct 28, 2022\",\n  \"links\": [\n    {\"name\": \"Discord\", \"url\": \"https://discord.gg/tvuxxcsgSS\"},\n    {\"name\": \"Twitter\", \"url\": \"https://twitter.com/...\"}\n  ],\n  \"avatar\": [],\n  \"banner\": [],\n  \"verified\": false,\n  \"has_business_email\": true,\n  \"continuation_token\": null\n}\n```\n\n### 注意事项:\n- **必须进行两次请求才能获取完整的频道信息**\n- 第一次请求: 获取基本信息（title、avatar、banner、keywords、rss_url等）和 continuation_token\n- 第二次请求: 获取高级信息（creation_date、links、view_count、country等）\n- 建议两次请求都设置 `need_format=true` 获取清洗后的数据\n- 可以合并两次请求的结果来获得完整的频道信息\n\n# [English]\n### Purpose:\n- Get YouTube channel description information (subscribers, videos, views, creation date, social links, etc.)\n\n### Important - Two requests required for complete data:\n- **First request** (with channel_id): Returns basic info (title, description, subscribers, videos, avatar, banner, etc.)\n- **Second request** (with continuation_token): Returns advanced info (**creation date, social media links, country, view count**, etc.)\n\n### How to get channel_id:\n- If you only have channel URL (e.g., `https://www.youtube.com/@CozyCraftYT`), call **get_channel_id_v2** endpoint first\n- It will return channel_id like `UCeu6U67OzJhV1KwBansH3Dg`\n\n### Parameters:\n\n#### 📌 Required (choose one):\n**channel_id** (string)\n- **Purpose**: Channel ID for first request to get basic channel info\n- **Format**: Usually starts with `UC`, 24 characters\n- **Example**: `\"UCeu6U67OzJhV1KwBansH3Dg\"`\n- **How to get**: Call **get_channel_id_v2** endpoint with channel URL\n\n**continuation_token** (string)\n- **Purpose**: Pagination token for second request to get advanced info\n- **How to get**: Get `continuation_token` field from first request response\n- **Note**: Must provide either `channel_id` or `continuation_token`\n\n#### ⚙️ Optional:\n**language_code** (string, optional)\n- **Purpose**: Set language preference\n- **Default**: `\"zh-CN\"`\n- **Values**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"`, etc.\n\n**country_code** (string, optional)\n- **Purpose**: Set region code\n- **Default**: `\"US\"`\n- **Values**: `\"US\"`, `\"JP\"`, `\"GB\"`, etc.\n\n**need_format** (boolean, optional)\n- **Purpose**: Whether to return cleaned simplified data\n- **Default**: `false`\n- **Values**:\n  - `false` - Return raw complete data\n  - `true` - Return cleaned simplified data (recommended)\n\n### Usage Flow (3 steps for complete data):\n1. **Get channel_id**: If you only have URL, call `get_channel_id_v2?channel_url=https://www.youtube.com/@CozyCraftYT`\n2. **First request**: Use `channel_id` parameter to get basic info and `continuation_token`\n3. **Second request**: Use `continuation_token` to get advanced info (creation date, social links, etc.)\n\n### Response Structure (need_format=true):\n\n#### First request response (with channel_id):\n```json\n{\n  \"channel_id\": \"UCeu6U67OzJhV1KwBansH3Dg\",\n  \"title\": \"CozyCraft\",\n  \"handle\": \"CozyCraftYT\",\n  \"description\": \"Channel description...\",\n  \"subscriber_count\": \"98.4K subscribers\",\n  \"video_count\": \"181 videos\",\n  \"view_count\": null,\n  \"country\": null,\n  \"creation_date\": null,\n  \"links\": [],\n  \"avatar\": [{\"url\": \"...\", \"width\": 900, \"height\": 900}],\n  \"banner\": [{\"url\": \"...\", \"width\": 2560, \"height\": 424}],\n  \"keywords\": \"Minecraft Ambience...\",\n  \"channel_url\": \"https://www.youtube.com/channel/UCeu6U67OzJhV1KwBansH3Dg\",\n  \"vanity_url\": \"http://www.youtube.com/@CozyCraftYT\",\n  \"rss_url\": \"https://www.youtube.com/feeds/videos.xml?channel_id=UCeu6U67OzJhV1KwBansH3Dg\",\n  \"is_family_safe\": true,\n  \"verified\": false,\n  \"has_business_email\": false,\n  \"has_membership\": true,\n  \"continuation_token\": \"4qmFsgJg...\"\n}\n```\n\n#### Second request response (with continuation_token):\n```json\n{\n  \"channel_id\": \"UCeu6U67OzJhV1KwBansH3Dg\",\n  \"title\": null,\n  \"handle\": \"CozyCraftYT\",\n  \"description\": \"Full channel description...\",\n  \"subscriber_count\": \"98.4K subscribers\",\n  \"video_count\": \"181 videos\",\n  \"view_count\": \"53,218,926 views\",\n  \"country\": \"United States\",\n  \"creation_date\": \"Oct 28, 2022\",\n  \"links\": [\n    {\"name\": \"Discord\", \"url\": \"https://discord.gg/tvuxxcsgSS\"},\n    {\"name\": \"Twitter\", \"url\": \"https://twitter.com/...\"}\n  ],\n  \"avatar\": [],\n  \"banner\": [],\n  \"verified\": false,\n  \"has_business_email\": true,\n  \"continuation_token\": null\n}\n```\n\n### Notes:\n- **Two requests are required to get complete channel information**\n- First request: Get basic info (title, avatar, banner, keywords, rss_url, etc.) and continuation_token\n- Second request: Get advanced info (creation_date, links, view_count, country, etc.)\n- Recommend setting `need_format=true` for both requests\n- You can merge results from both requests for complete channel info\n\n# [示例/Examples]\n## 步骤1 - 获取channel_id（如果只有URL）\nGET /youtube_web/get_channel_id_v2?channel_url=https://www.youtube.com/@CozyCraftYT\n\n## 步骤2 - 第一次请求获取基本信息和continuation_token\nGET /youtube_web/get_channel_description?channel_id=UCeu6U67OzJhV1KwBansH3Dg&need_format=true\n\n## 步骤3 - 第二次请求获取高级信息（使用返回的continuation_token）\nGET /youtube_web/get_channel_description?continuation_token=xxx&need_format=true","operationId":"get_channel_description_api_v1_youtube_web_get_channel_description_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":false,"schema":{"type":"string","description":"频道ID（格式如：UCeu6U67OzJhV1KwBansH3Dg），可通过get_channel_id_v2接口从频道URL获取/Channel ID, can be obtained from channel URL via get_channel_id_v2 endpoint","title":"Channel Id"},"description":"频道ID（格式如：UCeu6U67OzJhV1KwBansH3Dg），可通过get_channel_id_v2接口从频道URL获取/Channel ID, can be obtained from channel URL via get_channel_id_v2 endpoint","example":"UCeu6U67OzJhV1KwBansH3Dg"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"翻页标志（用于获取频道注册时间等高级信息）/Continuation token for getting advanced info like channel creation date","title":"Continuation Token"},"description":"翻页标志（用于获取频道注册时间等高级信息）/Continuation token for getting advanced info like channel creation date"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, JP等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, JP等）/Country code","example":"US"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_relate_video":{"get":{"tags":["YouTube-Web-API"],"summary":"获取推荐视频/Get related videos","description":"# [中文]\n### 用途:\n- 根据视频ID获取推荐视频数据。\n### 参数:\n- video_id: 视频ID，从URL中获取，例如：https://www.youtube.com/watch?v=LuIL5JATZsc，这里的video_id就是LuIL5JATZsc。\n- continuation_token: 用于继续获取推荐视频的令牌。默认为None。\n### 返回:\n- 推荐视频数据。\n\n# [English]\n### Purpose:\n- Get related videos by video ID.\n### Parameters:\n- video_id: Video ID, get it from the URL, for example: https://www.youtube.com/watch?v=LuIL5JATZsc, the id is LuIL5JATZsc.\n- continuation_token: Token to continue fetching related videos. Default is None.\n### Returns:\n- Related videos.\n\n# [示例/Example]\nvideo_id = \"LuIL5JATZsc\"","operationId":"get_relate_video_api_v1_youtube_web_get_relate_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":true,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"LuIL5JATZsc"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/search_video":{"get":{"tags":["YouTube-Web-API"],"summary":"搜索视频/Search video","description":"# [中文]\n### 用途:\n- 搜索视频。\n### 参数:\n- search_query: 搜索关键字。\n- language_code: 语言代码，默认为en。\n- order_by: 排序方式，默认为this_month，可选值为this_week, this_month, this_year, last_hour, today。\n- country_code: 国家代码，默认为us。\n- continuation_token: 用于继续获取搜索结果的令牌。默认为None。\n### 返回:\n- 搜索结果。\n\n# [English]\n### Purpose:\n- Search video.\n### Parameters:\n- search_query: Search keyword.\n- language_code: Language code, default is en.\n- order_by: Order by, default is this_month, optional values are this_week, this_month, this_year, last_hour, today.\n- country_code: Country code, default is us.\n- continuation_token: Token to continue fetching search results. Default is None.\n### Returns:\n- Search results.\n\n# [示例/Example]\nsearch_query = \"Minecraft\"","operationId":"search_video_api_v1_youtube_web_search_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search_query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键字/Search keyword","title":"Search Query"},"description":"搜索关键字/Search keyword","example":"Minecraft"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码/Language code","default":"en","title":"Language Code"},"description":"语言代码/Language code"},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Order by","default":"this_month","title":"Order By"},"description":"排序方式/Order by"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"us","title":"Country Code"},"description":"国家代码/Country code"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_general_search":{"get":{"tags":["YouTube-Web-API"],"summary":"综合搜索（支持过滤条件）/General search with filters","description":"# [中文]\n### 用途:\n- YouTube综合搜索，支持多种过滤条件，可以精确筛选搜索结果\n\n### 参数详解:\n- **search_query**: 搜索关键字\n- **language_code**: 语言代码，推荐使用zh-CN（中文）或en-US（英文）\n- **country_code**: 国家代码，影响搜索结果的地区相关性\n- **time_zone**: 时区设置\n\n### 过滤条件 (选择一个值即可):\n#### 上传时间 (upload_time):\n- `hour`: 过去1小时内上传\n- `today`: 今天上传\n- `week`: 本周上传\n- `month`: 本月上传\n- `year`: 今年上传\n\n#### 视频时长 (duration):\n- `short`: 短视频（少于4分钟）\n- `medium`: 中等时长（4-20分钟）\n- `long`: 长视频（超过20分钟）\n\n#### 内容类型 (content_type):\n- `video`: 视频\n- `channel`: 频道\n- `playlist`: 播放列表\n- `movie`: 电影\n\n#### 特征 (feature):\n- `hd`: 高清视频\n- `4k`: 4K视频\n- `subtitles`: 包含字幕\n- `live`: 直播\n- `creative_commons`: 知识共享许可\n- `360`: 360度视频\n- `vr180`: VR180视频\n- `3d`: 3D视频\n- `hdr`: HDR视频\n- `location`: 包含位置信息\n- `purchased`: 已购买内容\n\n#### 排序方式 (sort_by):\n- `relevance`: 相关性（默认）\n- `upload_date`: 上传日期\n- `view_count`: 观看次数\n- `rating`: 评分\n\n### 返回:\n- 包含过滤条件的搜索结果\n\n# [English]\n### Purpose:\n- YouTube comprehensive search with multiple filter options for precise result filtering\n\n### Parameters:\n- **search_query**: Search keyword\n- **language_code**: Language code (zh-CN for Chinese, en-US for English)\n- **country_code**: Country code affecting regional relevance\n- **time_zone**: Time zone setting\n\n### Filter Options (select one value for each):\n#### Upload Time (upload_time):\n- `hour`: Uploaded in the past hour\n- `today`: Uploaded today\n- `week`: Uploaded this week\n- `month`: Uploaded this month\n- `year`: Uploaded this year\n\n#### Duration (duration):\n- `short`: Short videos (under 4 minutes)\n- `medium`: Medium length (4-20 minutes)\n- `long`: Long videos (over 20 minutes)\n\n#### Content Type (content_type):\n- `video`: Videos\n- `channel`: Channels\n- `playlist`: Playlists\n- `movie`: Movies\n\n#### Features (feature):\n- `hd`: High definition\n- `4k`: 4K videos\n- `subtitles`: With subtitles\n- `live`: Live streams\n- `creative_commons`: Creative Commons licensed\n- `360`: 360-degree videos\n- `vr180`: VR180 videos\n- `3d`: 3D videos\n- `hdr`: HDR videos\n- `location`: With location info\n- `purchased`: Purchased content\n\n#### Sort By (sort_by):\n- `relevance`: Relevance (default)\n- `upload_date`: Upload date\n- `view_count`: View count\n- `rating`: Rating\n\n### Returns:\n- Filtered search results\n\n# [示例/Examples]\n## 基础搜索\nGET /youtube_web/get_general_search?search_query=Python编程\n\n## 搜索本周上传的Python编程短视频\nGET /youtube_web/get_general_search?search_query=Python编程&upload_time=week&duration=short\n\n## 搜索高清的Python教程视频，按观看次数排序\nGET /youtube_web/get_general_search?search_query=Python tutorial&feature=hd&sort_by=view_count\n\n## 搜索今天上传的4K编程直播\nGET /youtube_web/get_general_search?search_query=programming&upload_time=today&feature=4k&content_type=video","operationId":"get_general_search_api_v1_youtube_web_get_general_search_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"search_query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键字/Search keyword","title":"Search Query"},"description":"搜索关键字/Search keyword","example":"Python编程"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, CN等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, CN等）/Country code"},{"name":"time_zone","in":"query","required":false,"schema":{"type":"string","description":"时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone","default":"America/Los_Angeles","title":"Time Zone"},"description":"时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone"},{"name":"upload_time","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeUploadTimeAPI"},{"type":"null"}],"description":"上传时间过滤 | Upload time filter","examples":{"hour":{"summary":"过去1小时","value":"hour"},"today":{"summary":"今天","value":"today"},"week":{"summary":"本周","value":"week"},"month":{"summary":"本月","value":"month"},"year":{"summary":"今年","value":"year"}},"title":"Upload Time"},"description":"上传时间过滤 | Upload time filter"},{"name":"duration","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeDurationAPI"},{"type":"null"}],"description":"视频时长过滤 | Duration filter","examples":{"short":{"summary":"短视频 (<4分钟)","value":"short"},"medium":{"summary":"中等时长 (4-20分钟)","value":"medium"},"long":{"summary":"长视频 (>20分钟)","value":"long"}},"title":"Duration"},"description":"视频时长过滤 | Duration filter"},{"name":"content_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeContentTypeAPI"},{"type":"null"}],"description":"内容类型过滤 | Content type filter","examples":{"video":{"summary":"视频","value":"video"},"channel":{"summary":"频道","value":"channel"},"playlist":{"summary":"播放列表","value":"playlist"},"movie":{"summary":"电影","value":"movie"}},"title":"Content Type"},"description":"内容类型过滤 | Content type filter"},{"name":"feature","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeFeatureAPI"},{"type":"null"}],"description":"特征过滤 | Feature filter","examples":{"hd":{"summary":"高清","value":"hd"},"4k":{"summary":"4K","value":"4k"},"subtitles":{"summary":"字幕","value":"subtitles"},"live":{"summary":"直播","value":"live"},"creative_commons":{"summary":"知识共享","value":"creative_commons"},"360":{"summary":"360度","value":"360"},"vr180":{"summary":"VR180","value":"vr180"},"3d":{"summary":"3D","value":"3d"},"hdr":{"summary":"HDR","value":"hdr"},"location":{"summary":"位置","value":"location"},"purchased":{"summary":"已购买","value":"purchased"}},"title":"Feature"},"description":"特征过滤 | Feature filter"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeSearchSortAPI"},{"type":"null"}],"description":"排序方式 | Sort by","examples":{"relevance":{"summary":"相关性","value":"relevance"},"upload_date":{"summary":"上传日期","value":"upload_date"},"view_count":{"summary":"观看次数","value":"view_count"},"rating":{"summary":"评分","value":"rating"}},"title":"Sort By"},"description":"排序方式 | Sort by"},{"name":"continuation_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_shorts_search":{"get":{"tags":["YouTube-Web-API"],"summary":"YouTube Shorts短视频搜索/YouTube Shorts search","description":"# [中文]\n### 用途:\n- YouTube Shorts短视频专门搜索，使用原生YouTube API接口\n\n### 特点:\n- 🎬 专门搜索YouTube Shorts短视频（<60秒）\n- 🔍 支持多种过滤条件和排序方式\n- 📱 优化的移动端短视频内容\n- ⚡ 智能过滤：首次请求可能返回混合内容（长视频+短视频），默认自动过滤长视频\n\n### 重要说明 - YouTube Shorts搜索机制:\n根据YouTube的搜索逻辑，Shorts搜索有以下特性：\n1. **首次请求**（无continuation_token）：可能返回混合内容（部分长视频 + 部分短视频）\n2. **后续请求**（有continuation_token）：仅返回纯短视频内容\n3. **解决方案**：\n   - 方案A：使用 `filter_mixed_content=true`（默认），自动过滤掉长视频\n   - 方案B：使用第一次返回的 continuation_token 进行第二次请求，获取纯Shorts内容\n   - 方案C：设置 `filter_mixed_content=false`，获取原始混合内容\n\n### 参数详解:\n\n#### 📌 必选参数 (Required Parameters):\n\n**search_query** (string)\n- **作用**: 搜索关键字，用于匹配Shorts视频的标题、描述等内容\n- **格式**: 任意字符串\n- **示例**: `\"Python编程\"`, `\"gaming\"`, `\"cooking tutorial\"`\n- **注意**: 支持中英文及其他语言，空格会被自动处理\n\n#### ⚙️ 可选参数 - 基础设置 (Optional Parameters - Basic Settings):\n\n**language_code** (string, 可选)\n- **作用**: 设置搜索结果的显示语言，影响返回内容的语言偏好\n- **默认值**: `\"en-US\"`\n- **可用值**:\n  - `\"zh-CN\"` - 简体中文\n  - `\"zh-TW\"` - 繁体中文\n  - `\"en-US\"` - 英语（美国）\n  - `\"en-GB\"` - 英语（英国）\n  - `\"ja-JP\"` - 日语\n  - `\"ko-KR\"` - 韩语\n  - `\"es-ES\"` - 西班牙语\n  - `\"fr-FR\"` - 法语\n  - `\"de-DE\"` - 德语\n  - 其他符合IETF BCP 47标准的语言代码\n- **示例**: `language_code=zh-CN`\n- **影响**: 会影响搜索算法的语言匹配和结果排序\n\n**country_code** (string, 可选)\n- **作用**: 设置地区/国家代码，影响搜索结果的地域相关性和内容可用性\n- **默认值**: `\"US\"`\n- **可用值**:\n  - `\"US\"` - 美国\n  - `\"CN\"` - 中国\n  - `\"JP\"` - 日本\n  - `\"KR\"` - 韩国\n  - `\"GB\"` - 英国\n  - `\"DE\"` - 德国\n  - `\"FR\"` - 法国\n  - `\"CA\"` - 加拿大\n  - 其他符合ISO 3166-1 alpha-2标准的国家代码\n- **示例**: `country_code=JP`\n- **影响**: 某些Shorts可能因地区限制而不可见\n\n**time_zone** (string, 可选)\n- **作用**: 设置时区，影响时间相关过滤器（如\"今天\"、\"本周\"）的计算\n- **默认值**: `\"America/Los_Angeles\"`\n- **可用值**: 符合IANA时区数据库的时区标识符\n  - `\"America/Los_Angeles\"` - 美国太平洋时区\n  - `\"America/New_York\"` - 美国东部时区\n  - `\"Asia/Shanghai\"` - 中国时区\n  - `\"Asia/Tokyo\"` - 日本时区\n  - `\"Europe/London\"` - 英国时区\n  - `\"Europe/Paris\"` - 法国时区\n- **示例**: `time_zone=Asia/Shanghai`\n- **影响**: 结合upload_time参数使用时，决定\"今天\"等时间段的具体范围\n\n**filter_mixed_content** (boolean, 可选)\n- **作用**: 控制是否自动过滤掉响应中的长视频（非Shorts内容）\n- **默认值**: `true`\n- **可用值**:\n  - `true` - 自动过滤长视频，只返回Shorts（推荐）\n  - `false` - 返回原始内容，可能包含长视频\n- **示例**: `filter_mixed_content=true`\n- **使用场景**:\n  - `true`: 当你只需要纯Shorts内容时使用（推荐首次请求使用）\n  - `false`: 当你需要分析YouTube原始返回的混合内容时使用（调试用）\n- **注意**: 只影响首次请求，使用continuation_token的请求本身就只返回Shorts\n\n#### 🎯 可选参数 - Shorts过滤条件 (Optional Parameters - Shorts Filters):\n\n**upload_time** (string, 可选)\n- **作用**: 按上传时间过滤Shorts，只返回指定时间段内上传的视频\n- **默认值**: `null` (不过滤)\n- **可用值**:\n  - `\"hour\"` - 过去1小时内上传\n  - `\"today\"` - 今天上传（基于time_zone参数）\n  - `\"week\"` - 本周上传（最近7天）\n  - `\"month\"` - 本月上传（最近30天）\n  - `\"year\"` - 今年上传（最近365天）\n- **示例**: `upload_time=week`\n- **使用场景**: 寻找最新、热门的Shorts内容\n- **注意**: 与time_zone参数配合使用，时间计算基于设定的时区\n\n**sort_by** (string, 可选)\n- **作用**: 设置搜索结果的排序方式\n- **默认值**: `null` (YouTube默认相关性排序)\n- **可用值**:\n  - `\"relevance\"` - 按相关性排序（YouTube默认算法）\n  - `\"upload_date\"` - 按上传日期排序（最新优先）\n  - `\"view_count\"` - 按观看次数排序（最多观看优先）\n  - `\"rating\"` - 按评分排序（最高评分优先）\n- **示例**: `sort_by=view_count`\n- **使用场景**:\n  - `relevance`: 寻找最相关的内容\n  - `upload_date`: 寻找最新发布的Shorts\n  - `view_count`: 寻找最受欢迎的Shorts\n  - `rating`: 寻找质量最高的Shorts\n- **优先级**: sort_by的优先级高于upload_time，两者同时使用时以sort_by为准\n\n#### 📄 可选参数 - 翻页控制 (Optional Parameters - Pagination):\n\n**continuation_token** (string, 可选)\n- **作用**: 用于获取下一页搜索结果的翻页令牌\n- **默认值**: `null` (获取第一页)\n- **格式**: YouTube返回的加密字符串\n- **示例**: `continuation_token=EqcBEgPkuKzor4YybhmgGk...`\n- **获取方式**: 从上一次请求的响应中提取（见\"翻页机制详解\"部分）\n- **使用场景**:\n  - 首次搜索：不传此参数，获取第一页结果\n  - 后续翻页：传入上次返回的token，获取下一页结果\n- **注意**:\n  - Token有时效性，通常在数小时内有效\n  - 使用continuation_token时，必须保持search_query等其他参数一致\n  - 使用token的请求会自动返回纯Shorts内容（无需过滤）\n\n### 翻页机制详解:\n#### 如何获取 continuation_token：\n从响应JSON中提取，路径通常为以下之一：\n```python\n# 路径1：在 onResponseReceivedCommands 中\nresponse[\"data\"][\"onResponseReceivedCommands\"][0][\"appendContinuationItemsAction\"][\"continuationItems\"][-1][\"continuationItemRenderer\"][\"continuationEndpoint\"][\"continuationCommand\"][\"token\"]\n\n# 路径2：在 contents 中\nresponse[\"data\"][\"contents\"][\"twoColumnSearchResultsRenderer\"][\"primaryContents\"][\"sectionListRenderer\"][\"contents\"][-1][\"continuationItemRenderer\"][\"continuationEndpoint\"][\"continuationCommand\"][\"token\"]\n```\n\n#### 使用流程：\n1. **首次请求**: 不传 continuation_token\n   ```\n   GET /api/v1/youtube_web/get_shorts_search?search_query=python\n   ```\n2. **提取token**: 从响应中找到 continuation_token\n3. **后续请求**: 传入 continuation_token 获取下一页\n   ```\n   GET /api/v1/youtube_web/get_shorts_search?search_query=python&continuation_token=xxx\n   ```\n\n### 响应数据结构:\n```json\n{\n  \"code\": 200,\n  \"data\": {\n    \"contents\": {\n      \"twoColumnSearchResultsRenderer\": {\n        \"primaryContents\": {\n          \"sectionListRenderer\": {\n            \"contents\": [\n              {\n                \"itemSectionRenderer\": {\n                  \"contents\": [\n                    {\n                      \"gridShelfViewModel\": {\n                        // Shorts视频列表\n                        \"items\": [...]\n                      }\n                    }\n                  ]\n                }\n              },\n              {\n                \"continuationItemRenderer\": {\n                  \"continuationEndpoint\": {\n                    \"continuationCommand\": {\n                      \"token\": \"xxx\"  // 下一页的token\n                    }\n                  }\n                }\n              }\n            ]\n          }\n        }\n      }\n    }\n  }\n}\n```\n\n### 返回:\n- 专门针对Shorts的搜索结果，包含视频列表和翻页token\n\n# [English]\n### Purpose:\n- YouTube Shorts specialized search using native YouTube API\n\n### Features:\n- 🎬 Specialized search for YouTube Shorts (<60 seconds)\n- 🔍 Support for multiple filter conditions and sorting options\n- 📱 Optimized for mobile short-form content\n- ⚡ Smart filtering: First request may return mixed content (long+short videos), automatically filters long videos by default\n\n### Important - YouTube Shorts Search Mechanism:\nAccording to YouTube's search logic, Shorts search has these characteristics:\n1. **First request** (no continuation_token): May return mixed content (some long videos + some short videos)\n2. **Subsequent requests** (with continuation_token): Returns only pure Shorts content\n3. **Solutions**:\n   - Solution A: Use `filter_mixed_content=true` (default) to automatically filter long videos\n   - Solution B: Use continuation_token from first response for second request to get pure Shorts\n   - Solution C: Set `filter_mixed_content=false` to get original mixed content\n\n### Parameters:\n- **search_query**: Search keyword\n- **language_code**: Language code (zh-CN for Chinese, en-US for English)\n- **country_code**: Country code affecting regional relevance\n- **time_zone**: Time zone (e.g., America/Los_Angeles, Asia/Shanghai)\n- **filter_mixed_content**: Whether to filter long videos from mixed content (default true)\n\n### Shorts-specific Filters:\n#### Upload Time (upload_time):\n- `hour`: Shorts uploaded in the past hour\n- `today`: Shorts uploaded today\n- `week`: Shorts uploaded this week\n- `month`: Shorts uploaded this month\n- `year`: Shorts uploaded this year\n\n#### Sort By (sort_by):\n- `relevance`: Relevance (default)\n- `upload_date`: Upload date\n- `view_count`: View count\n- `rating`: Rating\n\n### Pagination Mechanism Explained:\n#### How to get continuation_token:\nExtract from response JSON, typically at one of these paths:\n```python\n# Path 1: In onResponseReceivedCommands\nresponse[\"onResponseReceivedCommands\"][0][\"appendContinuationItemsAction\"][\"continuationItems\"][-1][\"continuationItemRenderer\"][\"continuationEndpoint\"][\"continuationCommand\"][\"token\"]\n\n# Path 2: In contents\nresponse[\"contents\"][\"twoColumnSearchResultsRenderer\"][\"primaryContents\"][\"sectionListRenderer\"][\"contents\"][-1][\"continuationItemRenderer\"][\"continuationEndpoint\"][\"continuationCommand\"][\"token\"]\n```\n\n#### Usage Flow:\n1. **First request**: Don't pass continuation_token\n   ```\n   GET /api/v1/youtube_web/get_shorts_search?search_query=python\n   ```\n2. **Extract token**: Find continuation_token in response\n3. **Next requests**: Pass continuation_token to get next page\n   ```\n   GET /api/v1/youtube_web/get_shorts_search?search_query=python&continuation_token=xxx\n   ```\n\n### Response Data Structure:\n```json\n{\n  \"code\": 200,\n  \"data\": {\n    \"contents\": {\n      \"twoColumnSearchResultsRenderer\": {\n        \"primaryContents\": {\n          \"sectionListRenderer\": {\n            \"contents\": [\n              {\n                \"itemSectionRenderer\": {\n                  \"contents\": [\n                    {\n                      \"gridShelfViewModel\": {\n                        // Shorts video list\n                        \"items\": [...]\n                      }\n                    }\n                  ]\n                }\n              },\n              {\n                \"continuationItemRenderer\": {\n                  \"continuationEndpoint\": {\n                    \"continuationCommand\": {\n                      \"token\": \"xxx\"  // Token for next page\n                    }\n                  }\n                }\n              }\n            ]\n          }\n        }\n      }\n    }\n  }\n}\n```\n\n### Returns:\n- Shorts-specific search results with video list and pagination token\n\n# [示例/Examples]\n## 基础Shorts搜索（自动过滤长视频）\nGET /youtube_web/get_shorts_search?search_query=Python编程\n\n## 获取原始混合内容（包含长视频）\nGET /youtube_web/get_shorts_search?search_query=Python编程&filter_mixed_content=false\n\n## 搜索本周上传的Python相关Shorts\nGET /youtube_web/get_shorts_search?search_query=python&upload_time=week\n\n## 搜索观看次数最多的技术Shorts\nGET /youtube_web/get_shorts_search?search_query=技术&sort_by=view_count\n\n## 翻页获取更多Shorts\nGET /youtube_web/get_shorts_search?search_query=编程&continuation_token=EqcBEgPkuKzor4YybhmgGk...","operationId":"get_shorts_search_api_v1_youtube_web_get_shorts_search_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"search_query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键字/Search keyword","title":"Search Query"},"description":"搜索关键字/Search keyword","example":"Python编程"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"en-US","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"en-US"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, CN等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, CN等）/Country code","example":"US"},{"name":"time_zone","in":"query","required":false,"schema":{"type":"string","description":"时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone","default":"America/Los_Angeles","title":"Time Zone"},"description":"时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone","example":"America/Los_Angeles"},{"name":"upload_time","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeUploadTimeAPI"},{"type":"null"}],"description":"上传时间过滤 | Upload time filter for Shorts","examples":{"hour":{"summary":"过去1小时","value":"hour"},"today":{"summary":"今天","value":"today"},"week":{"summary":"本周","value":"week"},"month":{"summary":"本月","value":"month"},"year":{"summary":"今年","value":"year"}},"title":"Upload Time"},"description":"上传时间过滤 | Upload time filter for Shorts"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeSearchSortAPI"},{"type":"null"}],"description":"排序方式 | Sort by for Shorts","examples":{"relevance":{"summary":"相关性","value":"relevance"},"upload_date":{"summary":"上传日期","value":"upload_date"},"view_count":{"summary":"观看次数","value":"view_count"},"rating":{"summary":"评分","value":"rating"}},"title":"Sort By"},"description":"排序方式 | Sort by for Shorts"},{"name":"continuation_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token","example":""},{"name":"filter_mixed_content","in":"query","required":false,"schema":{"type":"boolean","description":"是否过滤混合内容（长视频），默认True / Filter mixed content (long videos), default True","default":true,"title":"Filter Mixed Content"},"description":"是否过滤混合内容（长视频），默认True / Filter mixed content (long videos), default True","example":true}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_channel_id":{"get":{"tags":["YouTube-Web-API"],"summary":"获取频道ID/Get channel ID","description":"# [中文]\n### 用途:\n- 获取频道ID。\n### 参数:\n- channel_name: 频道名称。\n### 返回:\n- 频道ID。\n\n# [English]\n### Purpose:\n- Get channel ID.\n### Parameters:\n- channel_name: Channel name.\n### Returns:\n- Channel ID.\n\n# [示例/Example]\nchannel_name = \"LinusTechTips\"","operationId":"get_channel_id_api_v1_youtube_web_get_channel_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_name","in":"query","required":true,"schema":{"type":"string","description":"频道名称/Channel name","title":"Channel Name"},"description":"频道名称/Channel name","example":"LinusTechTips"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_channel_id_v2":{"get":{"tags":["YouTube-Web-API"],"summary":"从频道URL获取频道ID V2/Get channel ID from URL V2","description":"# [中文]\n### 用途:\n- 从YouTube频道URL转换获取频道ID（channel_id）。\n- 支持多种URL格式，包括@用户名格式、/channel/格式、/c/格式、/user/格式。\n### 参数:\n- channel_url: 频道URL。\n### 返回:\n- channel_id: 频道ID（如：UCeu6U67OzJhV1KwBansH3Dg）\n- channel_url: 标准化的频道URL\n- source: 数据来源（url_parse表示直接从URL解析，page_parse表示从页面解析）\n\n# [English]\n### Purpose:\n- Convert YouTube channel URL to channel ID.\n- Supports multiple URL formats including @username, /channel/, /c/, /user/ formats.\n### Parameters:\n- channel_url: Channel URL.\n### Returns:\n- channel_id: Channel ID (e.g., UCeu6U67OzJhV1KwBansH3Dg)\n- channel_url: Normalized channel URL\n- source: Data source (url_parse means parsed from URL directly, page_parse means parsed from page)\n\n# [示例/Example]\nchannel_url = \"https://www.youtube.com/@CozyCraftYT\"","operationId":"get_channel_id_v2_api_v1_youtube_web_get_channel_id_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_url","in":"query","required":true,"schema":{"type":"string","description":"频道URL/Channel URL，支持多种格式如：https://www.youtube.com/@username, https://www.youtube.com/channel/UCxxxxxx, https://www.youtube.com/c/channelname","title":"Channel Url"},"description":"频道URL/Channel URL，支持多种格式如：https://www.youtube.com/@username, https://www.youtube.com/channel/UCxxxxxx, https://www.youtube.com/c/channelname","example":"https://www.youtube.com/@CozyCraftYT"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_channel_url":{"get":{"tags":["YouTube-Web-API"],"summary":"从频道ID获取频道URL/Get channel URL from channel ID","description":"# [中文]\n### 用途:\n- 从YouTube频道ID转换获取频道Handle (@用户名)\n- 与 get_channel_id_v2 接口互为反向操作\n\n### 参数:\n- channel_id: 频道ID（如：UCeu6U67OzJhV1KwBansH3Dg）\n\n### 返回:\n- channel_id: 频道ID\n- handle: 频道Handle（如：CozyCraftYT）\n- title: 频道名称\n- channel_url: 标准频道URL（/channel/格式）\n- vanity_url: 个性化URL（/@用户名格式）\n\n### 使用场景:\n- 当你有频道ID但需要获取@用户名格式的URL时\n- 需要展示用户友好的频道链接时\n\n# [English]\n### Purpose:\n- Convert YouTube channel ID to channel handle (@username)\n- Reverse operation of get_channel_id_v2 endpoint\n\n### Parameters:\n- channel_id: Channel ID (e.g., UCeu6U67OzJhV1KwBansH3Dg)\n\n### Returns:\n- channel_id: Channel ID\n- handle: Channel handle (e.g., CozyCraftYT)\n- title: Channel name\n- channel_url: Standard channel URL (/channel/ format)\n- vanity_url: Vanity URL (/@username format)\n\n### Use Cases:\n- When you have channel ID but need @username format URL\n- When you need to display user-friendly channel links\n\n# [示例/Example]\nchannel_id = \"UCeu6U67OzJhV1KwBansH3Dg\"","operationId":"get_channel_url_api_v1_youtube_web_get_channel_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","description":"频道ID/Channel ID (格式如：UCeu6U67OzJhV1KwBansH3Dg)","title":"Channel Id"},"description":"频道ID/Channel ID (格式如：UCeu6U67OzJhV1KwBansH3Dg)","example":"UCeu6U67OzJhV1KwBansH3Dg"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_channel_info":{"get":{"tags":["YouTube-Web-API"],"summary":"获取频道信息/Get channel information","description":"# [中文]\n### 用途:\n- 获取频道信息。\n### 参数:\n- channel_id: 频道ID。\n### 返回:\n- 频道信息。\n\n# [English]\n### Purpose:\n- Get channel information.\n### Parameters:\n- channel_id: Channel ID.\n### Returns:\n- Channel information.\n\n# [示例/Example]\nchannel_id = \"UCXuqSBlHAE6Xw-yeJA0Tunw\"","operationId":"get_channel_info_api_v1_youtube_web_get_channel_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","description":"频道ID/Channel ID","title":"Channel Id"},"description":"频道ID/Channel ID","example":"UCXuqSBlHAE6Xw-yeJA0Tunw"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_channel_videos":{"get":{"tags":["YouTube-Web-API"],"summary":"获取频道视频 V1（即将过时，优先使用 V2）/Get channel videos V1 (deprecated soon, use V2 first)","description":"# [中文]\n### 用途:\n- 获取频道视频。\n### 参数:\n- channel_id: 频道ID。\n- continuation_token: 用于继续获取频道视频的令牌。默认为None。\n### 返回:\n- 频道视频。\n\n# [English]\n### Purpose:\n- Get channel videos.\n### Parameters:\n- channel_id: Channel ID.\n- continuation_token: Token to continue fetching channel videos. Default is None.\n### Returns:\n- Channel videos.\n\n# [示例/Example]\nchannel_id = \"UCXuqSBlHAE6Xw-yeJA0Tunw\"","operationId":"get_channel_videos_api_v1_youtube_web_get_channel_videos_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","description":"频道ID/Channel ID","title":"Channel Id"},"description":"频道ID/Channel ID","example":"UCXuqSBlHAE6Xw-yeJA0Tunw"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_channel_videos_v2":{"get":{"tags":["YouTube-Web-API"],"summary":"获取频道视频 V2/Get channel videos V2","description":"# [中文]\n\n### 用途:\n- 获取频道视频 V2，支持获取频道视频列表，频道短视频列表，频道直播列表。\n\n### 参数:\n- channel_id: 频道ID或频道名称，如果是频道名称，则需要在前面加上 `@` 符号，例如：@LinusTechTips。\n- lang: 视频结果语言代码，默认为 `en-US`，任何语言代码均可，当提交不支持的语言代码时，默认使用 `en-US` 作为语言代码。\n- sortBy: 排序方式，默认为 `newest`，可选值为 `newest` 和 `oldest` 和 `mostPopular`：\n    - newest: 按照最新排序，默认值。\n    - oldest: 按照最旧排序。\n    - mostPopular: 按照最热排序。\n- contentType: 内容类型，默认为 `videos`，可选值为 `videos` 和 `shorts` 和 `live`：\n    - videos: 视频列表，默认值。\n    - shorts: 短视频列表。\n    - live: 直播列表。\n- nextToken: 用于继续获取视频的令牌。可选参数，默认值为空，从第一页开始获取。\n    - 如果获取第一页，则nextToken参数为None。\n    - 如果获取第二页，则nextToken参数为第一页请求返回的nextToken。\n\n### 返回:\n- 频道视频列表，包含视频ID、标题、缩略图、观看次数、点赞次数、评论数、视频时长等信息。\n\n# [English]\n\n### Purpose:\n- Get channel videos V2, support getting channel video list, channel short video list, channel live list.\n\n### Parameters:\n- channel_id: Channel ID or channel name, if it is a channel name, add `@` symbol in front of it, for example: @LinusTechTips.\n- lang: Video result language code, default is `en-US`, any language code is supported, when submitting unsupported language code, default use `en-US` as language code.\n- sortBy: Sort by, default is `newest`, optional values are `newest` and `oldest` and `mostPopular`:\n    - newest: Sort by newest, default value.\n    - oldest: Sort by oldest.\n    - mostPopular: Sort by most popular.\n- contentType: Content type, default is `videos`, optional values are `videos`\n    - videos: Video list, default value.\n    - shorts: Short video list.\n    - live: Live list.\n- nextToken: Token to continue fetching videos. Optional parameter, default value is empty, start from the first page.\n    - If fetching the first page, the nextToken parameter is None.\n    - If fetching the second page, the nextToken parameter is the nextToken returned by the first page request.\n### Returns:\n- Channel video list, including video ID, title, thumbnail, view count, like count, comment count, video duration and other information.\n\n# [示例/Example]\nchannel_id = \"UCXuqSBlHAE6Xw-yeJA0Tunw\"\nlang = \"en-US\"\nsortBy = \"newest\"\ncontentType = \"videos\"\nnextToken = None","operationId":"get_channel_videos_v2_api_v1_youtube_web_get_channel_videos_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","description":"频道ID/Channel ID","title":"Channel Id"},"description":"频道ID/Channel ID","example":"UCXuqSBlHAE6Xw-yeJA0Tunw"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","description":"视频结果语言代码/Video result language code","default":"en-US","title":"Lang"},"description":"视频结果语言代码/Video result language code","example":"en-US"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort by","default":"newest","title":"Sortby"},"description":"排序方式/Sort by","example":"newest"},{"name":"contentType","in":"query","required":false,"schema":{"type":"string","description":"内容类型/Content type","default":"videos","title":"Contenttype"},"description":"内容类型/Content type","example":"videos"},{"name":"nextToken","in":"query","required":false,"schema":{"type":"string","description":"翻页令牌/Pagination token","default":"","title":"Nexttoken"},"description":"翻页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_channel_videos_v3":{"get":{"tags":["YouTube-Web-API"],"summary":"获取频道视频 V3/Get channel videos V3","description":"# [中文]\n### 用途:\n- 获取YouTube频道的视频列表 V3\n- 支持分页获取，可通过 continuation_token 获取更多视频\n\n### 参数详解:\n\n#### 📌 必选参数:\n**channel_id** (string)\n- **作用**: 频道ID\n- **获取方式**:\n  - 从频道URL中提取，例如 `https://www.youtube.com/channel/UCJHBJ7F-nAIlMGolm0Hu4vg`\n  - 或从 `@用户名` 格式的URL中，先访问频道页面获取真实的频道ID\n- **示例**: `\"UCJHBJ7F-nAIlMGolm0Hu4vg\"`\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n**country_code** (string, 可选)\n- **作用**: 设置地区代码\n- **默认值**: `\"US\"`\n- **可用值**: `\"US\"`, `\"JP\"`, `\"GB\"` 等\n\n**continuation_token** (string, 可选)\n- **作用**: 分页token，用于获取下一页视频\n- **获取方式**: 从上一次请求的响应中提取\n- **首次请求**: 不传此参数或传 `null`\n\n**need_format** (boolean, 可选)\n- **作用**: 是否返回清洗后的精简数据\n- **默认值**: `false`\n- **可用值**:\n  - `false` - 返回原始完整数据\n  - `true` - 返回清洗后的精简数据（推荐）\n\n### 返回数据结构 (need_format=true):\n```json\n{\n  \"videos\": [\n    {\n      \"video_id\": \"zd3yCa1bJCM\",\n      \"title\": \"Minecraft: DREAM! - Asleep Custom Map\",\n      \"thumbnail\": \"https://i.ytimg.com/vi/zd3yCa1bJCM/hqdefault.jpg\",\n      \"thumbnails\": [\n        {\"url\": \"...\", \"width\": 168, \"height\": 94},\n        {\"url\": \"...\", \"width\": 336, \"height\": 188}\n      ],\n      \"moving_thumbnail\": \"https://i.ytimg.com/an_webp/zd3yCa1bJCM/mqdefault_6s.webp?...\",\n      \"duration\": \"16:57\",\n      \"duration_accessibility\": \"16分钟57秒钟\",\n      \"view_count\": \"343,369次观看\",\n      \"short_view_count\": \"34万次观看\",\n      \"published_time\": \"18小时前\",\n      \"description\": \"Today, we're trapped in a super weird dream...\",\n      \"is_live\": false,\n      \"is_verified\": true,\n      \"url\": \"https://www.youtube.com/watch?v=zd3yCa1bJCM\",\n      \"playback_url\": \"https://rr5---sn-ogueln67.googlevideo.com/initplayback?...\"\n    }\n  ],\n  \"continuation_token\": \"下一页token\"\n}\n```\n\n### 清洗后的字段说明:\n- `video_id`: 视频ID\n- `title`: 视频标题\n- `thumbnail`: 最高清晰度缩略图URL\n- `thumbnails`: 所有分辨率的缩略图列表\n- `moving_thumbnail`: 动态缩略图URL（webp格式，鼠标悬停预览）\n- `duration`: 视频时长（如\"16:57\"）\n- `duration_accessibility`: 时长无障碍文本（如\"16分钟57秒钟\"）\n- `view_count`: 完整观看次数（如\"343,369次观看\"）\n- `short_view_count`: 简短观看次数（如\"34万次观看\"）\n- `published_time`: 发布时间（如\"18小时前\"）\n- `description`: 视频描述片段\n- `is_live`: 是否为直播\n- `is_verified`: 频道是否已认证\n- `url`: 视频播放页URL\n- `playback_url`: 视频播放初始化URL（googlevideo.com，可能为空）\n- `continuation_token`: 下一页的分页token\n\n# [English]\n### Purpose:\n- Get YouTube channel video list V3\n- Supports pagination via continuation_token\n\n### Parameters:\n\n#### 📌 Required:\n**channel_id** (string)\n- **Purpose**: Channel ID\n- **How to get**:\n  - Extract from channel URL, e.g., `https://www.youtube.com/channel/UCJHBJ7F-nAIlMGolm0Hu4vg`\n  - Or visit the channel page to get the real channel ID from `@username` format URLs\n- **Example**: `\"UCJHBJ7F-nAIlMGolm0Hu4vg\"`\n\n#### ⚙️ Optional:\n**language_code** (string, optional)\n- **Purpose**: Set language preference\n- **Default**: `\"zh-CN\"`\n- **Values**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"`, etc.\n\n**country_code** (string, optional)\n- **Purpose**: Set region code\n- **Default**: `\"US\"`\n- **Values**: `\"US\"`, `\"JP\"`, `\"GB\"`, etc.\n\n**continuation_token** (string, optional)\n- **Purpose**: Pagination token for next page\n- **How to get**: Extract from previous response\n- **First request**: Omit or set to `null`\n\n**need_format** (boolean, optional)\n- **Purpose**: Whether to return cleaned simplified data\n- **Default**: `false`\n- **Values**:\n  - `false` - Return raw complete data\n  - `true` - Return cleaned simplified data (recommended)\n\n### Response Structure (need_format=true):\n```json\n{\n  \"videos\": [\n    {\n      \"video_id\": \"zd3yCa1bJCM\",\n      \"title\": \"Minecraft: DREAM! - Asleep Custom Map\",\n      \"thumbnail\": \"https://i.ytimg.com/vi/zd3yCa1bJCM/hqdefault.jpg\",\n      \"thumbnails\": [\n        {\"url\": \"...\", \"width\": 168, \"height\": 94},\n        {\"url\": \"...\", \"width\": 336, \"height\": 188}\n      ],\n      \"moving_thumbnail\": \"https://i.ytimg.com/an_webp/zd3yCa1bJCM/mqdefault_6s.webp?...\",\n      \"duration\": \"16:57\",\n      \"duration_accessibility\": \"16 minutes, 57 seconds\",\n      \"view_count\": \"343,369 views\",\n      \"short_view_count\": \"343K views\",\n      \"published_time\": \"18 hours ago\",\n      \"description\": \"Today, we're trapped in a super weird dream...\",\n      \"is_live\": false,\n      \"is_verified\": true,\n      \"url\": \"https://www.youtube.com/watch?v=zd3yCa1bJCM\",\n      \"playback_url\": \"https://rr5---sn-ogueln67.googlevideo.com/initplayback?...\"\n    }\n  ],\n  \"continuation_token\": \"next page token\"\n}\n```\n\n### Cleaned Data Field Descriptions:\n- `video_id`: Video ID\n- `title`: Video title\n- `thumbnail`: Highest resolution thumbnail URL\n- `thumbnails`: List of all resolution thumbnails\n- `moving_thumbnail`: Moving thumbnail URL (webp format, hover preview)\n- `duration`: Video duration (e.g., \"16:57\")\n- `duration_accessibility`: Duration accessibility text (e.g., \"16 minutes, 57 seconds\")\n- `view_count`: Full view count (e.g., \"343,369 views\")\n- `short_view_count`: Short view count (e.g., \"343K views\")\n- `published_time`: Published time (e.g., \"18 hours ago\")\n- `description`: Video description snippet\n- `is_live`: Whether it's a live stream\n- `is_verified`: Whether the channel is verified\n- `url`: Video playback page URL\n- `playback_url`: Video playback initialization URL (googlevideo.com, may be empty)\n- `continuation_token`: Pagination token for next page\n\n# [示例/Examples]\n## 获取频道首页视频 / Get first page of channel videos\nGET /youtube_web/get_channel_videos_v3?channel_id=UCJHBJ7F-nAIlMGolm0Hu4vg\n\n## 获取清洗后的数据（推荐）/ Get cleaned data (recommended)\nGET /youtube_web/get_channel_videos_v3?channel_id=UCJHBJ7F-nAIlMGolm0Hu4vg&need_format=true\n\n## 获取下一页 / Get next page\nGET /youtube_web/get_channel_videos_v3?channel_id=UCJHBJ7F-nAIlMGolm0Hu4vg&continuation_token=xxxxx&need_format=true","operationId":"get_channel_videos_v3_api_v1_youtube_web_get_channel_videos_v3_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","description":"频道ID/Channel ID","title":"Channel Id"},"description":"频道ID/Channel ID","example":"UCJHBJ7F-nAIlMGolm0Hu4vg"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, JP等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, JP等）/Country code","example":"US"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"分页token，用于获取下一页/Pagination token for next page","title":"Continuation Token"},"description":"分页token，用于获取下一页/Pagination token for next page"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_channel_short_videos":{"get":{"tags":["YouTube-Web-API"],"summary":"获取频道短视频/Get channel short videos","description":"# [中文]\n### 用途:\n- 获取频道短视频。\n### 参数:\n- channel_id: 频道ID。\n- continuation_token: 用于继续获取频道短视频的令牌。默认为None。\n### 返回:\n- 频道短视频。\n\n# [English]\n### Purpose:\n- Get channel short videos.\n### Parameters:\n- channel_id: Channel ID.\n- continuation_token: Token to continue fetching channel short videos. Default is None.\n### Returns:\n- Channel short videos.\n\n# [示例/Example]\nchannel_id = \"UCXuqSBlHAE6Xw-yeJA0Tunw\"","operationId":"get_channel_short_videos_api_v1_youtube_web_get_channel_short_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","description":"频道ID/Channel ID","title":"Channel Id"},"description":"频道ID/Channel ID","example":"UCXuqSBlHAE6Xw-yeJA0Tunw"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/search_channel":{"get":{"tags":["YouTube-Web-API"],"summary":"搜索频道/Search channel","description":"# [中文]\n### 用途:\n- 搜索频道。\n### 参数:\n- search_query: 搜索关键字。\n- language_code: 语言代码，默认为en。\n- country_code: 国家代码，默认为us。\n- continuation_token: 用于继续获取搜索结果的令牌。默认为None。\n### 返回:\n- 搜索结果。\n\n# [English]\n### Purpose:\n- Search channel.\n### Parameters:\n- search_query: Search keyword.\n- language_code: Language code, default is en.\n- country_code: Country code, default is us.\n- continuation_token: Token to continue fetching search results. Default is None.\n### Returns:\n- Search results.\n\n# [示例/Example]\nchannel_id = \"UCXuqSBlHAE6Xw-yeJA0Tunw\"\nsearch_query = \"AMD\"","operationId":"search_channel_api_v1_youtube_web_search_channel_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","description":"频道ID/Channel ID","title":"Channel Id"},"description":"频道ID/Channel ID","example":"UCXuqSBlHAE6Xw-yeJA0Tunw"},{"name":"search_query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键字/Search keyword","title":"Search Query"},"description":"搜索关键字/Search keyword","example":"AMD"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码/Language code","default":"en","title":"Language Code"},"description":"语言代码/Language code"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"us","title":"Country Code"},"description":"国家代码/Country code"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web/get_trending_videos":{"get":{"tags":["YouTube-Web-API"],"summary":"获取趋势视频/Get trending videos","description":"# [中文]\n### 用途:\n- 获取趋势视频。\n### 参数:\n- language_code: 语言代码，默认为en。\n- country_code: 国家代码，默认为us。\n- section: 类型，默认为Now，可选值为Music, Gaming, Movies。\n### 返回:\n- 趋势视频。\n\n# [English]\n### Purpose:\n- Get trending videos.\n### Parameters:\n- language_code: Language code, default is en.\n- country_code: Country code, default is us.\n- section: Section, default is Now, optional values are Music, Gaming, Movies.\n### Returns:\n- Trending videos.\n\n# [示例/Example]","operationId":"get_trending_videos_api_v1_youtube_web_get_trending_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码/Language code","default":"en","title":"Language Code"},"description":"语言代码/Language code"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码/Country code","default":"us","title":"Country Code"},"description":"国家代码/Country code"},{"name":"section","in":"query","required":false,"schema":{"type":"string","description":"类型/Section","default":"Now","title":"Section"},"description":"类型/Section"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_video_info":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取视频详情 /Get video information","description":"# [中文]\n### 用途:\n- 获取YouTube视频详情信息\n- 返回原始完整数据（包含 playerResponse 和 initialData）\n\n### 参数详解:\n\n#### 📌 必选参数:\n**video_id** (string)\n- **作用**: 视频ID\n- **获取方式**: 从视频URL中提取，例如 `https://www.youtube.com/watch?v=oaSNBz4qMQY`，video_id 就是 `oaSNBz4qMQY`\n- **示例**: `\"oaSNBz4qMQY\"`\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n### 返回数据结构:\n```json\n{\n  \"playerResponse\": {\n    \"videoDetails\": {},\n    \"streamingData\": {\n      \"formats\": [],\n      \"adaptiveFormats\": []\n    },\n    \"microformat\": {},\n    ...\n  },\n  \"initialData\": {\n    \"contents\": {\n      \"twoColumnWatchNextResults\": {\n        \"results\": {\n          \"results\": {\n            \"contents\": [\n              {\n                \"videoPrimaryInfoRenderer\": {...},\n                \"videoSecondaryInfoRenderer\": {...}\n              }\n            ]\n          }\n        }\n      }\n    },\n    ...\n  }\n}\n```\n\n### 主要字段说明:\n- `playerResponse`: YouTube 播放器响应数据\n  - `videoDetails`: 视频基本信息（可能为空，取决于YouTube的返回）\n  - `streamingData`: 视频流数据（包含 formats 和 adaptiveFormats，包含 googlevideo.com 的URL）\n  - `microformat`: 元数据信息\n- `initialData`: YouTube 页面初始化数据\n  - `videoPrimaryInfoRenderer`: 主要信息（标题、观看次数、点赞数等）\n  - `videoSecondaryInfoRenderer`: 次要信息（频道信息、描述等）\n\n# [English]\n### Purpose:\n- Get YouTube video details\n- Returns raw complete data (includes playerResponse and initialData)\n\n### Parameters:\n\n#### 📌 Required:\n**video_id** (string)\n- **Purpose**: Video ID\n- **How to get**: Extract from video URL, e.g., `https://www.youtube.com/watch?v=oaSNBz4qMQY`, video_id is `oaSNBz4qMQY`\n- **Example**: `\"oaSNBz4qMQY\"`\n\n#### ⚙️ Optional:\n**language_code** (string, optional)\n- **Purpose**: Set language preference\n- **Default**: `\"zh-CN\"`\n- **Values**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"`, etc.\n\n### Response Structure:\n```json\n{\n  \"playerResponse\": {\n    \"videoDetails\": {},\n    \"streamingData\": {\n      \"formats\": [],\n      \"adaptiveFormats\": []\n    },\n    \"microformat\": {},\n    ...\n  },\n  \"initialData\": {\n    \"contents\": {\n      \"twoColumnWatchNextResults\": {\n        \"results\": {\n          \"results\": {\n            \"contents\": [\n              {\n                \"videoPrimaryInfoRenderer\": {...},\n                \"videoSecondaryInfoRenderer\": {...}\n              }\n            ]\n          }\n        }\n      }\n    },\n    ...\n  }\n}\n```\n\n### Key Fields:\n- `playerResponse`: YouTube player response data\n  - `videoDetails`: Basic video info (may be empty depending on YouTube's response)\n  - `streamingData`: Video stream data (includes formats and adaptiveFormats with googlevideo.com URLs)\n  - `microformat`: Metadata information\n- `initialData`: YouTube page initialization data\n  - `videoPrimaryInfoRenderer`: Primary info (title, view count, like count, etc.)\n  - `videoSecondaryInfoRenderer`: Secondary info (channel info, description, etc.)\n\n# [示例/Examples]\n## 获取视频详情数据 / Get video details\nGET /youtube_web/get_video_info?video_id=oaSNBz4qMQY\n\n## 指定语言 / Specify language\nGET /youtube_web/get_video_info?video_id=oaSNBz4qMQY&language_code=en-US","operationId":"get_video_info_api_v1_youtube_web_v2_get_video_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":true,"schema":{"type":"string","minLength":11,"maxLength":11,"description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"oaSNBz4qMQY"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data","default":true,"title":"Need Format"},"description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_video_comments":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取视频评论/Get video comments","description":"# [中文]\n### 用途:\n- 获取YouTube视频的一级评论\n\n### 参数详解:\n\n#### 📌 必选参数:\n**video_id** (string)\n- **作用**: 视频ID\n- **格式**: YouTube视频ID字符串\n- **示例**: `\"oaSNBz4qMQY\"`\n- **获取方式**: 从URL `https://www.youtube.com/watch?v=oaSNBz4qMQY` 中提取\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置评论显示的语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n**country_code** (string, 可选)\n- **作用**: 设置地区代码\n- **默认值**: `\"US\"`\n- **可用值**: `\"US\"`, `\"JP\"`, `\"GB\"` 等\n\n**sort_by** (string, 可选)\n- **作用**: 评论排序方式\n- **默认值**: `\"top\"`\n- **可用值**:\n  - `\"top\"` - 热门评论（按点赞数排序）\n  - `\"newest\"` - 最新评论（按时间排序）\n\n**continuation_token** (string, 可选)\n- **作用**: 翻页令牌，用于获取下一页评论\n- **默认值**: `null`\n- **获取方式**: 从上一次请求的响应中提取\n\n**need_format** (boolean, 可选)\n- **作用**: 是否返回清洗后的精简数据\n- **默认值**: `true`\n- **可用值**:\n  - `false` - 返回原始完整数据\n  - `true` - 返回清洗后的精简数据（推荐，默认）\n\n### 返回数据结构 (need_format=true):\n```json\n{\n  \"comments\": [\n    {\n      \"comment_id\": \"UgzRDoUJAvDNn5_8i8p4AaABAg\",\n      \"content\": \"评论内容文本\",\n      \"published_time\": \"1天前\",\n      \"reply_level\": 0,\n      \"like_count\": \"2\",\n      \"like_count_a11y\": \"2 次赞\",\n      \"reply_count\": \"0\",\n      \"reply_count_a11y\": \"0 条回复\",\n      \"reply_count_text\": \"1 条回复\",\n      \"reply_continuation_token\": \"...\",\n      \"author\": {\n        \"channel_id\": \"UCzRzHrLFuH0lHZYnrI84I8Q\",\n        \"display_name\": \"@username\",\n        \"channel_url\": \"https://www.youtube.com/@username\",\n        \"avatar_url\": \"https://yt3.ggpht.com/...\",\n        \"avatar_thumbnails\": [\n          {\"url\": \"...\", \"width\": 88, \"height\": 88}\n        ],\n        \"is_verified\": false,\n        \"is_creator\": false,\n        \"is_artist\": false\n      },\n      \"creator_thumbnail_url\": \"https://yt3.ggpht.com/...\"\n    }\n  ],\n  \"continuation_token\": \"下一页token\"\n}\n```\n\n### 字段说明:\n- `comment_id`: 评论唯一ID\n- `content`: 评论文本内容\n- `published_time`: 发布时间（相对时间，如\"1天前\"）\n- `reply_level`: 回复层级（0表示一级评论）\n- `like_count`: 点赞数\n- `reply_count`: 回复数\n- `reply_count_text`: 回复数文本（如\"1 条回复\"）\n- `reply_continuation_token`: 获取该评论回复的token\n- `author`: 评论作者信息\n  - `channel_id`: 作者频道ID\n  - `display_name`: 显示名称\n  - `channel_url`: 频道URL\n  - `avatar_url`: 头像URL\n  - `is_verified`: 是否已认证\n  - `is_creator`: 是否为视频创作者\n  - `is_artist`: 是否为音乐人\n- `creator_thumbnail_url`: 视频创作者头像URL\n\n# [English]\n### Purpose:\n- Get YouTube video first-level comments\n\n### Parameters:\n\n#### 📌 Required:\n**video_id** (string)\n- **Purpose**: Video ID\n- **Format**: YouTube video ID string\n- **Example**: `\"oaSNBz4qMQY\"`\n- **How to get**: Extract from URL `https://www.youtube.com/watch?v=oaSNBz4qMQY`\n\n#### ⚙️ Optional:\n**language_code** (string, optional)\n- **Purpose**: Set language preference for comments\n- **Default**: `\"zh-CN\"`\n- **Values**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"`, etc.\n\n**country_code** (string, optional)\n- **Purpose**: Set region code\n- **Default**: `\"US\"`\n- **Values**: `\"US\"`, `\"JP\"`, `\"GB\"`, etc.\n\n**sort_by** (string, optional)\n- **Purpose**: Comment sorting method\n- **Default**: `\"top\"`\n- **Values**:\n  - `\"top\"` - Top comments (sorted by likes)\n  - `\"newest\"` - Newest comments (sorted by time)\n\n**continuation_token** (string, optional)\n- **Purpose**: Pagination token for next page\n- **Default**: `null`\n- **How to get**: Extract from previous response\n\n**need_format** (boolean, optional)\n- **Purpose**: Whether to return cleaned simplified data\n- **Default**: `true`\n- **Values**:\n  - `false` - Return raw complete data\n  - `true` - Return cleaned simplified data (recommended, default)\n\n### Response Structure (need_format=true):\n```json\n{\n  \"comments\": [\n    {\n      \"comment_id\": \"UgzRDoUJAvDNn5_8i8p4AaABAg\",\n      \"content\": \"Comment text content\",\n      \"published_time\": \"1 day ago\",\n      \"reply_level\": 0,\n      \"like_count\": \"2\",\n      \"like_count_a11y\": \"2 likes\",\n      \"reply_count\": \"0\",\n      \"reply_count_a11y\": \"0 replies\",\n      \"reply_count_text\": \"1 reply\",\n      \"reply_continuation_token\": \"...\",\n      \"author\": {\n        \"channel_id\": \"UCzRzHrLFuH0lHZYnrI84I8Q\",\n        \"display_name\": \"@username\",\n        \"channel_url\": \"https://www.youtube.com/@username\",\n        \"avatar_url\": \"https://yt3.ggpht.com/...\",\n        \"avatar_thumbnails\": [\n          {\"url\": \"...\", \"width\": 88, \"height\": 88}\n        ],\n        \"is_verified\": false,\n        \"is_creator\": false,\n        \"is_artist\": false\n      },\n      \"creator_thumbnail_url\": \"https://yt3.ggpht.com/...\"\n    }\n  ],\n  \"continuation_token\": \"next page token\"\n}\n```\n\n### Field Descriptions:\n- `comment_id`: Unique comment ID\n- `content`: Comment text content\n- `published_time`: Published time (relative, e.g., \"1 day ago\")\n- `reply_level`: Reply level (0 for first-level comments)\n- `like_count`: Number of likes\n- `reply_count`: Number of replies\n- `reply_count_text`: Reply count text (e.g., \"1 reply\")\n- `reply_continuation_token`: Token to get replies for this comment\n- `author`: Comment author info\n  - `channel_id`: Author's channel ID\n  - `display_name`: Display name\n  - `channel_url`: Channel URL\n  - `avatar_url`: Avatar URL\n  - `is_verified`: Whether verified\n  - `is_creator`: Whether video creator\n  - `is_artist`: Whether artist\n- `creator_thumbnail_url`: Video creator's avatar URL\n\n# [示例/Examples]\n## 获取热门评论\nGET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&sort_by=top\n\n## 获取最新评论\nGET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&sort_by=newest\n\n## 获取清洗后的评论数据（推荐）\nGET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&need_format=true\n\n## 翻页获取更多评论\nGET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&continuation_token=xxx&need_format=true","operationId":"get_video_comments_api_v1_youtube_web_v2_get_video_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":true,"schema":{"type":"string","minLength":11,"maxLength":11,"description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"LuIL5JATZsc"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, JP等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, JP等）/Country code","example":"US"},{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CommentSortByAPI","description":"排序方式 | Sort by","examples":{"top":{"summary":"热门评论","value":"top"},"newest":{"summary":"最新评论","value":"newest"}},"default":"top"},"description":"排序方式 | Sort by"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data","default":true,"title":"Need Format"},"description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_video_comment_replies":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取视频二级评论/Get video sub comments","description":"# [中文]\n### 用途:\n- 获取视频二级评论\n\n### 参数详解:\n\n#### 📌 必选参数:\n**continuation_token** (string)\n- **作用**: 回复的continuation token\n- **获取方式**: 从一级评论的响应数据中获取 `reply_continuation_token` 字段\n- **示例**: `\"Eg0SC29hU05CejRxTVFZGAYygwEaUBIaVWd3WmhjUXVGUmJZTlhkUV85VjRBYUFCQWciAggAKhhVQ0pIQko3Ri1uQUlsTUdvbG0wSHU0dmcyC29hU05CejRxTVFZQAFICoIBAggBQi9jb21tZW50LXJlcGxpZXMtaXRlbS1VZ3daaGNRdUZSYllOWGRRXzlWNEFhQUJBZw%3D%3D\"`\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置回复显示的语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n**country_code** (string, 可选)\n- **作用**: 设置地区代码\n- **默认值**: `\"US\"`\n- **可用值**: `\"US\"`, `\"JP\"`, `\"GB\"` 等\n\n**need_format** (boolean, 可选)\n- **作用**: 是否返回清洗后的精简数据\n- **默认值**: `true`\n- **可用值**:\n  - `false` - 返回原始完整数据\n  - `true` - 返回清洗后的精简数据（推荐，默认）\n\n### 使用流程:\n1. 先调用 `/get_video_comments` 接口获取一级评论\n2. 从一级评论的响应中找到 `reply_continuation_token` 字段\n3. 使用该 token 调用本接口获取该评论的所有回复\n\n### 返回数据结构 (need_format=true):\n```json\n{\n  \"comments\": [\n    {\n      \"comment_id\": \"UgwZhcQuFRbYNXdQ_9V4AaABAg.A2B3C4D5E6F7G8H9I0J1\",\n      \"content\": \"回复内容文本\",\n      \"published_time\": \"2天前\",\n      \"reply_level\": 1,\n      \"like_count\": \"5\",\n      \"like_count_a11y\": \"5 次赞\",\n      \"reply_count\": \"0\",\n      \"author\": {\n        \"channel_id\": \"UCxxxxxx\",\n        \"display_name\": \"@username\",\n        \"channel_url\": \"https://www.youtube.com/@username\",\n        \"avatar_url\": \"https://yt3.ggpht.com/...\",\n        \"is_verified\": false,\n        \"is_creator\": true,\n        \"is_artist\": false\n      }\n    }\n  ],\n  \"continuation_token\": \"下一页token（如果有更多回复）\"\n}\n```\n\n### 字段说明:\n- `reply_level`: 回复层级（1表示二级评论/回复）\n- `is_creator`: 是否为视频创作者（如果是创作者回复会标记为true）\n- 其他字段与一级评论相同\n\n# [English]\n### Purpose:\n- Get video second-level comment replies\n\n### Parameters:\n\n#### Required:\n**continuation_token** (string)\n- **Purpose**: Reply continuation token from first-level comment\n- **How to get**: Extract `reply_continuation_token` from the first-level comment response\n\n#### Optional:\n**language_code** (string, optional)\n- **Purpose**: Language preference for comments\n- **Default**: `\"zh-CN\"`\n\n**country_code** (string, optional)\n- **Purpose**: Region code\n- **Default**: `\"US\"`\n\n**need_format** (boolean, optional)\n- **Purpose**: Whether to return cleaned simplified data\n- **Default**: `true`\n\n### Returns:\n- `replies`: List of reply comments\n- `continuation_token`: Next page token (if more replies available)\n\n### Usage flow:\n1. Get first-level comments via `get_video_comments`\n2. Extract `reply_continuation_token` from a comment that has replies\n3. Pass it as `continuation_token` to this endpoint\n4. For more replies, use the returned `continuation_token`\n\n# [示例/Example]\nGET /get_video_comment_replies?continuation_token=xxx&need_format=true","operationId":"get_video_comment_replies_api_v1_youtube_web_v2_get_video_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"continuation_token","in":"query","required":true,"schema":{"type":"string","description":"回复的continuation token（从一级评论的reply_continuation_token字段获取）/Reply continuation token from first-level comment","title":"Continuation Token"},"description":"回复的continuation token（从一级评论的reply_continuation_token字段获取）/Reply continuation token from first-level comment"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, JP等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, JP等）/Country code","example":"US"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data","default":true,"title":"Need Format"},"description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_channel_description":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取频道描述信息/Get channel description","description":"# [中文]\n### 用途:\n- 获取YouTube频道的介绍信息（订阅数、视频数、观看次数、注册时间、社交链接等）\n\n### 重要提示 - 需要两次请求获取完整数据:\n- **第一次请求**（使用channel_id）: 返回基本信息（频道名称、描述、订阅数、视频数、头像、横幅等）\n- **第二次请求**（使用continuation_token）: 返回高级信息（**注册时间、社交媒体链接、国家、观看次数**等）\n\n### 如何获取channel_id:\n- 如果你只有频道URL（如 `https://www.youtube.com/@CozyCraftYT`），请先调用 **get_channel_id** 接口获取channel_id\n- 该接口会返回类似 `UCeu6U67OzJhV1KwBansH3Dg` 的频道ID\n\n### 参数详解:\n\n#### 📌 必选参数（二选一）:\n**channel_id** (string)\n- **作用**: 频道ID，用于第一次请求获取频道基本信息\n- **格式**: 通常以 `UC` 开头的24位字符串\n- **示例**: `\"UCeu6U67OzJhV1KwBansH3Dg\"`\n- **获取方式**: 调用 **get_channel_id** 接口，传入频道URL即可获取\n\n**continuation_token** (string)\n- **作用**: 翻页标志，用于第二次请求获取频道的高级信息\n- **获取方式**: 从第一次请求的响应中获取 `continuation_token` 字段\n- **注意**: `channel_id` 和 `continuation_token` 必须提供其中一个\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置显示语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n**country_code** (string, 可选)\n- **作用**: 设置地区代码\n- **默认值**: `\"US\"`\n- **可用值**: `\"US\"`, `\"JP\"`, `\"GB\"` 等\n\n**need_format** (boolean, 可选)\n- **作用**: 是否返回清洗后的精简数据\n- **默认值**: `true`\n- **可用值**:\n  - `false` - 返回原始完整数据\n  - `true` - 返回清洗后的精简数据（推荐，默认）\n\n### 使用流程（三步获取完整数据）:\n1. **获取channel_id**: 如果只有频道URL，先调用 `get_channel_id?channel_url=https://www.youtube.com/@CozyCraftYT`\n2. **第一次请求**: 使用 `channel_id` 参数获取频道基本信息，同时获取 `continuation_token`\n3. **第二次请求**: 使用 `continuation_token` 获取高级信息（注册时间、社交链接等）\n\n### 返回数据结构 (need_format=true):\n\n#### 第一次请求返回（使用channel_id）:\n```json\n{\n  \"channel_id\": \"UCeu6U67OzJhV1KwBansH3Dg\",\n  \"title\": \"CozyCraft\",\n  \"handle\": \"CozyCraftYT\",\n  \"description\": \"频道介绍...\",\n  \"subscriber_count\": \"9.84万位订阅者\",\n  \"video_count\": \"181 个视频\",\n  \"view_count\": null,\n  \"country\": null,\n  \"creation_date\": null,\n  \"links\": [],\n  \"avatar\": [{\"url\": \"...\", \"width\": 900, \"height\": 900}],\n  \"banner\": [{\"url\": \"...\", \"width\": 2560, \"height\": 424}],\n  \"keywords\": \"Minecraft Ambience...\",\n  \"channel_url\": \"https://www.youtube.com/channel/UCeu6U67OzJhV1KwBansH3Dg\",\n  \"vanity_url\": \"http://www.youtube.com/@CozyCraftYT\",\n  \"rss_url\": \"https://www.youtube.com/feeds/videos.xml?channel_id=UCeu6U67OzJhV1KwBansH3Dg\",\n  \"is_family_safe\": true,\n  \"verified\": false,\n  \"has_business_email\": false,\n  \"has_membership\": true,\n  \"continuation_token\": \"4qmFsgJg...\"\n}\n```\n\n#### 第二次请求返回（使用continuation_token）:\n```json\n{\n  \"channel_id\": \"UCeu6U67OzJhV1KwBansH3Dg\",\n  \"title\": null,\n  \"handle\": \"CozyCraftYT\",\n  \"description\": \"完整频道介绍...\",\n  \"subscriber_count\": \"98.4K subscribers\",\n  \"video_count\": \"181 videos\",\n  \"view_count\": \"53,218,926 views\",\n  \"country\": \"United States\",\n  \"creation_date\": \"Oct 28, 2022\",\n  \"links\": [\n    {\"name\": \"Discord\", \"url\": \"https://discord.gg/tvuxxcsgSS\"},\n    {\"name\": \"Twitter\", \"url\": \"https://twitter.com/...\"}\n  ],\n  \"avatar\": [],\n  \"banner\": [],\n  \"verified\": false,\n  \"has_business_email\": true,\n  \"continuation_token\": null\n}\n```\n\n### 注意事项:\n- **必须进行两次请求才能获取完整的频道信息**\n- 第一次请求: 获取基本信息（title、avatar、banner、keywords、rss_url等）和 continuation_token\n- 第二次请求: 获取高级信息（creation_date、links、view_count、country等）\n- 建议两次请求都设置 `need_format=true` 获取清洗后的数据\n- 可以合并两次请求的结果来获得完整的频道信息\n\n# [English]\n### Purpose:\n- Get YouTube channel description information (subscribers, videos, views, creation date, social links, etc.)\n\n### Important - Two requests required for complete data:\n- **First request** (with channel_id): Returns basic info (title, description, subscribers, videos, avatar, banner, etc.)\n- **Second request** (with continuation_token): Returns advanced info (**creation date, social media links, country, view count**, etc.)\n\n### How to get channel_id:\n- If you only have channel URL (e.g., `https://www.youtube.com/@CozyCraftYT`), call **get_channel_id** endpoint first\n- It will return channel_id like `UCeu6U67OzJhV1KwBansH3Dg`\n\n### Parameters:\n\n#### 📌 Required (choose one):\n**channel_id** (string)\n- **Purpose**: Channel ID for first request to get basic channel info\n- **Format**: Usually starts with `UC`, 24 characters\n- **Example**: `\"UCeu6U67OzJhV1KwBansH3Dg\"`\n- **How to get**: Call **get_channel_id** endpoint with channel URL\n\n**continuation_token** (string)\n- **Purpose**: Pagination token for second request to get advanced info\n- **How to get**: Get `continuation_token` field from first request response\n- **Note**: Must provide either `channel_id` or `continuation_token`\n\n#### ⚙️ Optional:\n**language_code** (string, optional)\n- **Purpose**: Set language preference\n- **Default**: `\"zh-CN\"`\n- **Values**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"`, etc.\n\n**country_code** (string, optional)\n- **Purpose**: Set region code\n- **Default**: `\"US\"`\n- **Values**: `\"US\"`, `\"JP\"`, `\"GB\"`, etc.\n\n**need_format** (boolean, optional)\n- **Purpose**: Whether to return cleaned simplified data\n- **Default**: `true`\n- **Values**:\n  - `false` - Return raw complete data\n  - `true` - Return cleaned simplified data (recommended, default)\n\n### Usage Flow (3 steps for complete data):\n1. **Get channel_id**: If you only have URL, call `get_channel_id?channel_url=https://www.youtube.com/@CozyCraftYT`\n2. **First request**: Use `channel_id` parameter to get basic info and `continuation_token`\n3. **Second request**: Use `continuation_token` to get advanced info (creation date, social links, etc.)\n\n### Response Structure (need_format=true):\n\n#### First request response (with channel_id):\n```json\n{\n  \"channel_id\": \"UCeu6U67OzJhV1KwBansH3Dg\",\n  \"title\": \"CozyCraft\",\n  \"handle\": \"CozyCraftYT\",\n  \"description\": \"Channel description...\",\n  \"subscriber_count\": \"98.4K subscribers\",\n  \"video_count\": \"181 videos\",\n  \"view_count\": null,\n  \"country\": null,\n  \"creation_date\": null,\n  \"links\": [],\n  \"avatar\": [{\"url\": \"...\", \"width\": 900, \"height\": 900}],\n  \"banner\": [{\"url\": \"...\", \"width\": 2560, \"height\": 424}],\n  \"keywords\": \"Minecraft Ambience...\",\n  \"channel_url\": \"https://www.youtube.com/channel/UCeu6U67OzJhV1KwBansH3Dg\",\n  \"vanity_url\": \"http://www.youtube.com/@CozyCraftYT\",\n  \"rss_url\": \"https://www.youtube.com/feeds/videos.xml?channel_id=UCeu6U67OzJhV1KwBansH3Dg\",\n  \"is_family_safe\": true,\n  \"verified\": false,\n  \"has_business_email\": false,\n  \"has_membership\": true,\n  \"continuation_token\": \"4qmFsgJg...\"\n}\n```\n\n#### Second request response (with continuation_token):\n```json\n{\n  \"channel_id\": \"UCeu6U67OzJhV1KwBansH3Dg\",\n  \"title\": null,\n  \"handle\": \"CozyCraftYT\",\n  \"description\": \"Full channel description...\",\n  \"subscriber_count\": \"98.4K subscribers\",\n  \"video_count\": \"181 videos\",\n  \"view_count\": \"53,218,926 views\",\n  \"country\": \"United States\",\n  \"creation_date\": \"Oct 28, 2022\",\n  \"links\": [\n    {\"name\": \"Discord\", \"url\": \"https://discord.gg/tvuxxcsgSS\"},\n    {\"name\": \"Twitter\", \"url\": \"https://twitter.com/...\"}\n  ],\n  \"avatar\": [],\n  \"banner\": [],\n  \"verified\": false,\n  \"has_business_email\": true,\n  \"continuation_token\": null\n}\n```\n\n### Notes:\n- **Two requests are required to get complete channel information**\n- First request: Get basic info (title, avatar, banner, keywords, rss_url, etc.) and continuation_token\n- Second request: Get advanced info (creation_date, links, view_count, country, etc.)\n- Recommend setting `need_format=true` for both requests\n- You can merge results from both requests for complete channel info\n\n# [示例/Examples]\n## 步骤1 - 获取channel_id（如果只有URL）\nGET /youtube_web/get_channel_id?channel_url=https://www.youtube.com/@CozyCraftYT\n\n## 步骤2 - 第一次请求获取基本信息和continuation_token\nGET /youtube_web/get_channel_description?channel_id=UCeu6U67OzJhV1KwBansH3Dg&need_format=true\n\n## 步骤3 - 第二次请求获取高级信息（使用返回的continuation_token）\nGET /youtube_web/get_channel_description?continuation_token=xxx&need_format=true","operationId":"get_channel_description_api_v1_youtube_web_v2_get_channel_description_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":false,"schema":{"type":"string","description":"频道ID（格式如：UCeu6U67OzJhV1KwBansH3Dg），可通过get_channel_id接口从频道URL获取/Channel ID, can be obtained from channel URL via get_channel_id endpoint","title":"Channel Id"},"description":"频道ID（格式如：UCeu6U67OzJhV1KwBansH3Dg），可通过get_channel_id接口从频道URL获取/Channel ID, can be obtained from channel URL via get_channel_id endpoint","example":"UCeu6U67OzJhV1KwBansH3Dg"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"翻页标志（用于获取频道注册时间等高级信息）/Continuation token for getting advanced info like channel creation date","title":"Continuation Token"},"description":"翻页标志（用于获取频道注册时间等高级信息）/Continuation token for getting advanced info like channel creation date"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, JP等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, JP等）/Country code","example":"US"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data","default":true,"title":"Need Format"},"description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_general_search":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"综合搜索（原始数据，推荐使用V2）/General search (raw data, recommend V2)","description":"# [中文]\n### ⚠️ 推荐使用 V2 版本:\n- 本接口返回 YouTube 原始数据结构，需要自行解析\n- **清洗过的数据版本请使用 `/get_general_search_v2` 接口**，返回结构化的视频、Shorts、频道、播放列表数据\n\n### 用途:\n- YouTube综合搜索，支持多种过滤条件，可以精确筛选搜索结果\n\n### 参数详解:\n- **search_query**: 搜索关键字\n- **language_code**: 语言代码，推荐使用zh-CN（中文）或en-US（英文）\n- **country_code**: 国家代码，影响搜索结果的地区相关性\n- **time_zone**: 时区设置\n\n### 过滤条件 (选择一个值即可):\n#### 上传时间 (upload_time):\n- `hour`: 过去1小时内上传\n- `today`: 今天上传\n- `week`: 本周上传\n- `month`: 本月上传\n- `year`: 今年上传\n\n#### 视频时长 (duration):\n- `short`: 短视频（少于4分钟）\n- `medium`: 中等时长（4-20分钟）\n- `long`: 长视频（超过20分钟）\n\n#### 内容类型 (content_type):\n- `video`: 视频\n- `channel`: 频道\n- `playlist`: 播放列表\n- `movie`: 电影\n\n#### 特征 (feature):\n- `hd`: 高清视频\n- `4k`: 4K视频\n- `subtitles`: 包含字幕\n- `live`: 直播\n- `creative_commons`: 知识共享许可\n- `360`: 360度视频\n- `vr180`: VR180视频\n- `3d`: 3D视频\n- `hdr`: HDR视频\n- `location`: 包含位置信息\n- `purchased`: 已购买内容\n\n#### 排序方式 (sort_by):\n- `relevance`: 相关性（默认）\n- `upload_date`: 上传日期\n- `view_count`: 观看次数\n- `rating`: 评分\n\n### 返回:\n- 包含过滤条件的搜索结果\n\n# [English]\n### Purpose:\n- YouTube comprehensive search with multiple filter options for precise result filtering\n\n### Parameters:\n- **search_query**: Search keyword\n- **language_code**: Language code (zh-CN for Chinese, en-US for English)\n- **country_code**: Country code affecting regional relevance\n- **time_zone**: Time zone setting\n\n### Filter Options (select one value for each):\n#### Upload Time (upload_time):\n- `hour`: Uploaded in the past hour\n- `today`: Uploaded today\n- `week`: Uploaded this week\n- `month`: Uploaded this month\n- `year`: Uploaded this year\n\n#### Duration (duration):\n- `short`: Short videos (under 4 minutes)\n- `medium`: Medium length (4-20 minutes)\n- `long`: Long videos (over 20 minutes)\n\n#### Content Type (content_type):\n- `video`: Videos\n- `channel`: Channels\n- `playlist`: Playlists\n- `movie`: Movies\n\n#### Features (feature):\n- `hd`: High definition\n- `4k`: 4K videos\n- `subtitles`: With subtitles\n- `live`: Live streams\n- `creative_commons`: Creative Commons licensed\n- `360`: 360-degree videos\n- `vr180`: VR180 videos\n- `3d`: 3D videos\n- `hdr`: HDR videos\n- `location`: With location info\n- `purchased`: Purchased content\n\n#### Sort By (sort_by):\n- `relevance`: Relevance (default)\n- `upload_date`: Upload date\n- `view_count`: View count\n- `rating`: Rating\n\n### ⚠️ Recommend using V2 version:\n- This endpoint returns raw YouTube data structure that requires manual parsing\n- **For cleaned/structured data, use `/get_general_search_v2` endpoint**, which returns structured videos, Shorts, channels, and playlists data\n\n### Returns:\n- Filtered search results\n\n# [示例/Examples]\n## 基础搜索\nGET /youtube_web/get_general_search?search_query=Python编程\n\n## 搜索本周上传的Python编程短视频\nGET /youtube_web/get_general_search?search_query=Python编程&upload_time=week&duration=short\n\n## 搜索高清的Python教程视频，按观看次数排序\nGET /youtube_web/get_general_search?search_query=Python tutorial&feature=hd&sort_by=view_count\n\n## 搜索今天上传的4K编程直播\nGET /youtube_web/get_general_search?search_query=programming&upload_time=today&feature=4k&content_type=video","operationId":"get_general_search_api_v1_youtube_web_v2_get_general_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search_query","in":"query","required":true,"schema":{"type":"string","maxLength":200,"description":"搜索关键字/Search keyword","title":"Search Query"},"description":"搜索关键字/Search keyword","example":"Python编程"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, CN等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, CN等）/Country code"},{"name":"time_zone","in":"query","required":false,"schema":{"type":"string","description":"时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone","default":"America/Los_Angeles","title":"Time Zone"},"description":"时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone"},{"name":"upload_time","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeUploadTimeAPI"},{"type":"null"}],"description":"上传时间过滤 | Upload time filter","examples":{"hour":{"summary":"过去1小时","value":"hour"},"today":{"summary":"今天","value":"today"},"week":{"summary":"本周","value":"week"},"month":{"summary":"本月","value":"month"},"year":{"summary":"今年","value":"year"}},"title":"Upload Time"},"description":"上传时间过滤 | Upload time filter"},{"name":"duration","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeDurationAPI"},{"type":"null"}],"description":"视频时长过滤 | Duration filter","examples":{"short":{"summary":"短视频 (<4分钟)","value":"short"},"medium":{"summary":"中等时长 (4-20分钟)","value":"medium"},"long":{"summary":"长视频 (>20分钟)","value":"long"}},"title":"Duration"},"description":"视频时长过滤 | Duration filter"},{"name":"content_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeContentTypeAPI"},{"type":"null"}],"description":"内容类型过滤 | Content type filter","examples":{"video":{"summary":"视频","value":"video"},"channel":{"summary":"频道","value":"channel"},"playlist":{"summary":"播放列表","value":"playlist"},"movie":{"summary":"电影","value":"movie"}},"title":"Content Type"},"description":"内容类型过滤 | Content type filter"},{"name":"feature","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeFeatureAPI"},{"type":"null"}],"description":"特征过滤 | Feature filter","examples":{"hd":{"summary":"高清","value":"hd"},"4k":{"summary":"4K","value":"4k"},"subtitles":{"summary":"字幕","value":"subtitles"},"live":{"summary":"直播","value":"live"},"creative_commons":{"summary":"知识共享","value":"creative_commons"},"360":{"summary":"360度","value":"360"},"vr180":{"summary":"VR180","value":"vr180"},"3d":{"summary":"3D","value":"3d"},"hdr":{"summary":"HDR","value":"hdr"},"location":{"summary":"位置","value":"location"},"purchased":{"summary":"已购买","value":"purchased"}},"title":"Feature"},"description":"特征过滤 | Feature filter"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeSearchSortAPI"},{"type":"null"}],"description":"排序方式 | Sort by","examples":{"relevance":{"summary":"相关性","value":"relevance"},"upload_date":{"summary":"上传日期","value":"upload_date"},"view_count":{"summary":"观看次数","value":"view_count"},"rating":{"summary":"评分","value":"rating"}},"title":"Sort By"},"description":"排序方式 | Sort by"},{"name":"continuation_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_general_search_v2":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"综合搜索V2/General search V2","description":"# [中文]\n### 用途:\n- 搜索 YouTube 视频、Shorts、频道、播放列表\n- 返回清洗后的结构化数据（相比 get_general_search 返回原始数据）\n- 支持多种过滤条件和排序方式\n- 支持分页加载更多结果\n\n### 参数:\n- keyword: 搜索关键词（首次请求必填）\n- continuation_token: 分页token（获取下一页时传入，从上一次返回结果中获取）\n- upload_date: 上传时间过滤 - last_hour/today/this_week/this_month/this_year\n- type: 结果类型过滤 - video/channel/playlist/movie\n- duration: 视频时长过滤 - short(<4分钟)/medium(4-20分钟)/long(>20分钟)\n- features: 特性过滤（多个用逗号分隔）- live/4k/hd/subtitles/creative_commons/360/vr180/3d/hdr\n- sort_by: 排序方式 - relevance(相关性)/upload_date(上传日期)/view_count(播放量)/rating(评分)\n\n### 返回数据:\n- videos: 视频列表（标题、时长、播放量、作者、频道ID、缩略图等）\n- shorts: Shorts 短视频列表\n- channels: 频道列表\n- playlists: 播放列表\n- continuation_token: 下一页 token\n- completion_suggestions: 搜索建议词\n\n### 使用流程:\n1. 首次搜索传入 keyword（可选过滤参数）\n2. 加载更多时传入上一次返回的 continuation_token\n\n# [English]\n### Purpose:\n- Search YouTube videos, Shorts, channels, and playlists\n- Returns cleaned structured data (compared to get_general_search which returns raw data)\n- Supports multiple filter conditions and sorting options\n- Supports pagination for loading more results\n\n### Parameters:\n- keyword: Search keyword (required for first request)\n- continuation_token: Pagination token (pass from previous response for next page)\n- upload_date: Upload date filter - last_hour/today/this_week/this_month/this_year\n- type: Result type filter - video/channel/playlist/movie\n- duration: Video duration filter - short(<4min)/medium(4-20min)/long(>20min)\n- features: Feature filter (comma separated) - live/4k/hd/subtitles/creative_commons/360/vr180/3d/hdr\n- sort_by: Sort by - relevance/upload_date/view_count/rating\n\n### Returns:\n- videos: Video list (title, duration, views, author, channel_id, thumbnails, etc.)\n- shorts: Shorts video list\n- channels: Channel list\n- playlists: Playlist list\n- continuation_token: Next page token\n- completion_suggestions: Search suggestions\n\n### Usage flow:\n1. First search with keyword (optional filter params)\n2. Load more by passing continuation_token from previous response\n\n# [示例/Example]\n#### 基础搜索: GET /get_general_search_v2?keyword=Python tutorial\n#### 带过滤: GET /get_general_search_v2?keyword=Python tutorial&upload_date=this_week&type=video&sort_by=view_count\n#### 下一页: GET /get_general_search_v2?continuation_token=xxx","operationId":"get_general_search_v2_api_v1_youtube_web_v2_get_general_search_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"搜索关键词（首次请求必填）/Search keyword (required for first request)","title":"Keyword"},"description":"搜索关键词（首次请求必填）/Search keyword (required for first request)","example":"Python tutorial"},{"name":"continuation_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"分页token，用于获取下一页/Continuation token for next page","title":"Continuation Token"},"description":"分页token，用于获取下一页/Continuation token for next page"},{"name":"upload_date","in":"query","required":false,"schema":{"anyOf":[{"enum":["last_hour","today","this_week","this_month","this_year"],"type":"string"},{"type":"null"}],"description":"上传时间过滤/Upload date filter","title":"Upload Date"},"description":"上传时间过滤/Upload date filter"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["video","channel","playlist","movie"],"type":"string"},{"type":"null"}],"description":"类型过滤/Type filter","title":"Type"},"description":"类型过滤/Type filter"},{"name":"duration","in":"query","required":false,"schema":{"anyOf":[{"enum":["short","medium","long"],"type":"string"},{"type":"null"}],"description":"时长过滤/Duration filter: short (<4min), medium (4-20min), long (>20min)","title":"Duration"},"description":"时长过滤/Duration filter: short (<4min), medium (4-20min), long (>20min)"},{"name":"features","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"特性过滤（逗号分隔）/Feature filter (comma separated): live, 4k, hd, subtitles, creative_commons, 360, vr180, 3d, hdr","title":"Features"},"description":"特性过滤（逗号分隔）/Feature filter (comma separated): live, 4k, hd, subtitles, creative_commons, 360, vr180, 3d, hdr"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"enum":["relevance","upload_date","view_count","rating"],"type":"string"},{"type":"null"}],"description":"排序方式/Sort by","title":"Sort By"},"description":"排序方式/Sort by"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_shorts_search":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"Shorts搜索（原始数据，推荐使用V2）/Shorts search (raw data, recommend V2)","description":"# [中文]\n### ⚠️ 推荐使用 V2 版本:\n- 本接口返回 YouTube 原始数据结构，需要自行解析\n- **清洗过的数据版本请使用 `/get_shorts_search_v2` 接口**，返回结构化的 Shorts 列表数据，自动过滤非 Shorts 内容\n\n### 用途:\n- YouTube Shorts短视频专门搜索，使用原生YouTube API接口\n\n### 特点:\n- 🎬 专门搜索YouTube Shorts短视频（<60秒）\n- 🔍 支持多种过滤条件和排序方式\n- 📱 优化的移动端短视频内容\n- ⚡ 智能过滤：首次请求可能返回混合内容（长视频+短视频），默认自动过滤长视频\n\n### 重要说明 - YouTube Shorts搜索机制:\n根据YouTube的搜索逻辑，Shorts搜索有以下特性：\n1. **首次请求**（无continuation_token）：可能返回混合内容（部分长视频 + 部分短视频）\n2. **后续请求**（有continuation_token）：仅返回纯短视频内容\n3. **解决方案**：\n   - 方案A：使用 `filter_mixed_content=true`（默认），自动过滤掉长视频\n   - 方案B：使用第一次返回的 continuation_token 进行第二次请求，获取纯Shorts内容\n   - 方案C：设置 `filter_mixed_content=false`，获取原始混合内容\n\n### 参数详解:\n\n#### 📌 必选参数 (Required Parameters):\n\n**search_query** (string)\n- **作用**: 搜索关键字，用于匹配Shorts视频的标题、描述等内容\n- **格式**: 任意字符串\n- **示例**: `\"Python编程\"`, `\"gaming\"`, `\"cooking tutorial\"`\n- **注意**: 支持中英文及其他语言，空格会被自动处理\n\n#### ⚙️ 可选参数 - 基础设置 (Optional Parameters - Basic Settings):\n\n**language_code** (string, 可选)\n- **作用**: 设置搜索结果的显示语言，影响返回内容的语言偏好\n- **默认值**: `\"en-US\"`\n- **可用值**:\n  - `\"zh-CN\"` - 简体中文\n  - `\"zh-TW\"` - 繁体中文\n  - `\"en-US\"` - 英语（美国）\n  - `\"en-GB\"` - 英语（英国）\n  - `\"ja-JP\"` - 日语\n  - `\"ko-KR\"` - 韩语\n  - `\"es-ES\"` - 西班牙语\n  - `\"fr-FR\"` - 法语\n  - `\"de-DE\"` - 德语\n  - 其他符合IETF BCP 47标准的语言代码\n- **示例**: `language_code=zh-CN`\n- **影响**: 会影响搜索算法的语言匹配和结果排序\n\n**country_code** (string, 可选)\n- **作用**: 设置地区/国家代码，影响搜索结果的地域相关性和内容可用性\n- **默认值**: `\"US\"`\n- **可用值**:\n  - `\"US\"` - 美国\n  - `\"CN\"` - 中国\n  - `\"JP\"` - 日本\n  - `\"KR\"` - 韩国\n  - `\"GB\"` - 英国\n  - `\"DE\"` - 德国\n  - `\"FR\"` - 法国\n  - `\"CA\"` - 加拿大\n  - 其他符合ISO 3166-1 alpha-2标准的国家代码\n- **示例**: `country_code=JP`\n- **影响**: 某些Shorts可能因地区限制而不可见\n\n**time_zone** (string, 可选)\n- **作用**: 设置时区，影响时间相关过滤器（如\"今天\"、\"本周\"）的计算\n- **默认值**: `\"America/Los_Angeles\"`\n- **可用值**: 符合IANA时区数据库的时区标识符\n  - `\"America/Los_Angeles\"` - 美国太平洋时区\n  - `\"America/New_York\"` - 美国东部时区\n  - `\"Asia/Shanghai\"` - 中国时区\n  - `\"Asia/Tokyo\"` - 日本时区\n  - `\"Europe/London\"` - 英国时区\n  - `\"Europe/Paris\"` - 法国时区\n- **示例**: `time_zone=Asia/Shanghai`\n- **影响**: 结合upload_time参数使用时，决定\"今天\"等时间段的具体范围\n\n**filter_mixed_content** (boolean, 可选)\n- **作用**: 控制是否自动过滤掉响应中的长视频（非Shorts内容）\n- **默认值**: `true`\n- **可用值**:\n  - `true` - 自动过滤长视频，只返回Shorts（推荐）\n  - `false` - 返回原始内容，可能包含长视频\n- **示例**: `filter_mixed_content=true`\n- **使用场景**:\n  - `true`: 当你只需要纯Shorts内容时使用（推荐首次请求使用）\n  - `false`: 当你需要分析YouTube原始返回的混合内容时使用（调试用）\n- **注意**: 只影响首次请求，使用continuation_token的请求本身就只返回Shorts\n\n#### 🎯 可选参数 - Shorts过滤条件 (Optional Parameters - Shorts Filters):\n\n**upload_time** (string, 可选)\n- **作用**: 按上传时间过滤Shorts，只返回指定时间段内上传的视频\n- **默认值**: `null` (不过滤)\n- **可用值**:\n  - `\"hour\"` - 过去1小时内上传\n  - `\"today\"` - 今天上传（基于time_zone参数）\n  - `\"week\"` - 本周上传（最近7天）\n  - `\"month\"` - 本月上传（最近30天）\n  - `\"year\"` - 今年上传（最近365天）\n- **示例**: `upload_time=week`\n- **使用场景**: 寻找最新、热门的Shorts内容\n- **注意**: 与time_zone参数配合使用，时间计算基于设定的时区\n\n**sort_by** (string, 可选)\n- **作用**: 设置搜索结果的排序方式\n- **默认值**: `null` (YouTube默认相关性排序)\n- **可用值**:\n  - `\"relevance\"` - 按相关性排序（YouTube默认算法）\n  - `\"upload_date\"` - 按上传日期排序（最新优先）\n  - `\"view_count\"` - 按观看次数排序（最多观看优先）\n  - `\"rating\"` - 按评分排序（最高评分优先）\n- **示例**: `sort_by=view_count`\n- **使用场景**:\n  - `relevance`: 寻找最相关的内容\n  - `upload_date`: 寻找最新发布的Shorts\n  - `view_count`: 寻找最受欢迎的Shorts\n  - `rating`: 寻找质量最高的Shorts\n- **优先级**: sort_by的优先级高于upload_time，两者同时使用时以sort_by为准\n\n#### 📄 可选参数 - 翻页控制 (Optional Parameters - Pagination):\n\n**continuation_token** (string, 可选)\n- **作用**: 用于获取下一页搜索结果的翻页令牌\n- **默认值**: `null` (获取第一页)\n- **格式**: YouTube返回的加密字符串\n- **示例**: `continuation_token=EqcBEgPkuKzor4YybhmgGk...`\n- **获取方式**: 从上一次请求的响应中提取（见\"翻页机制详解\"部分）\n- **使用场景**:\n  - 首次搜索：不传此参数，获取第一页结果\n  - 后续翻页：传入上次返回的token，获取下一页结果\n- **注意**:\n  - Token有时效性，通常在数小时内有效\n  - 使用continuation_token时，必须保持search_query等其他参数一致\n  - 使用token的请求会自动返回纯Shorts内容（无需过滤）\n\n### 翻页机制详解:\n#### 如何获取 continuation_token：\n从响应JSON中提取，路径通常为以下之一：\n```python\n# 路径1：在 onResponseReceivedCommands 中\nresponse[\"data\"][\"onResponseReceivedCommands\"][0][\"appendContinuationItemsAction\"][\"continuationItems\"][-1][\"continuationItemRenderer\"][\"continuationEndpoint\"][\"continuationCommand\"][\"token\"]\n\n# 路径2：在 contents 中\nresponse[\"data\"][\"contents\"][\"twoColumnSearchResultsRenderer\"][\"primaryContents\"][\"sectionListRenderer\"][\"contents\"][-1][\"continuationItemRenderer\"][\"continuationEndpoint\"][\"continuationCommand\"][\"token\"]\n```\n\n#### 使用流程：\n1. **首次请求**: 不传 continuation_token\n   ```\n   GET /api/v1/youtube_web/get_shorts_search?search_query=python\n   ```\n2. **提取token**: 从响应中找到 continuation_token\n3. **后续请求**: 传入 continuation_token 获取下一页\n   ```\n   GET /api/v1/youtube_web/get_shorts_search?search_query=python&continuation_token=xxx\n   ```\n\n### 响应数据结构:\n```json\n{\n  \"code\": 200,\n  \"data\": {\n    \"contents\": {\n      \"twoColumnSearchResultsRenderer\": {\n        \"primaryContents\": {\n          \"sectionListRenderer\": {\n            \"contents\": [\n              {\n                \"itemSectionRenderer\": {\n                  \"contents\": [\n                    {\n                      \"gridShelfViewModel\": {\n                        // Shorts视频列表\n                        \"items\": [...]\n                      }\n                    }\n                  ]\n                }\n              },\n              {\n                \"continuationItemRenderer\": {\n                  \"continuationEndpoint\": {\n                    \"continuationCommand\": {\n                      \"token\": \"xxx\"  // 下一页的token\n                    }\n                  }\n                }\n              }\n            ]\n          }\n        }\n      }\n    }\n  }\n}\n```\n\n### 返回:\n- 专门针对Shorts的搜索结果，包含视频列表和翻页token\n\n# [English]\n### Purpose:\n- YouTube Shorts specialized search using native YouTube API\n\n### Features:\n- 🎬 Specialized search for YouTube Shorts (<60 seconds)\n- 🔍 Support for multiple filter conditions and sorting options\n- 📱 Optimized for mobile short-form content\n- ⚡ Smart filtering: First request may return mixed content (long+short videos), automatically filters long videos by default\n\n### Important - YouTube Shorts Search Mechanism:\nAccording to YouTube's search logic, Shorts search has these characteristics:\n1. **First request** (no continuation_token): May return mixed content (some long videos + some short videos)\n2. **Subsequent requests** (with continuation_token): Returns only pure Shorts content\n3. **Solutions**:\n   - Solution A: Use `filter_mixed_content=true` (default) to automatically filter long videos\n   - Solution B: Use continuation_token from first response for second request to get pure Shorts\n   - Solution C: Set `filter_mixed_content=false` to get original mixed content\n\n### Parameters:\n- **search_query**: Search keyword\n- **language_code**: Language code (zh-CN for Chinese, en-US for English)\n- **country_code**: Country code affecting regional relevance\n- **time_zone**: Time zone (e.g., America/Los_Angeles, Asia/Shanghai)\n- **filter_mixed_content**: Whether to filter long videos from mixed content (default true)\n\n### Shorts-specific Filters:\n#### Upload Time (upload_time):\n- `hour`: Shorts uploaded in the past hour\n- `today`: Shorts uploaded today\n- `week`: Shorts uploaded this week\n- `month`: Shorts uploaded this month\n- `year`: Shorts uploaded this year\n\n#### Sort By (sort_by):\n- `relevance`: Relevance (default)\n- `upload_date`: Upload date\n- `view_count`: View count\n- `rating`: Rating\n\n### Pagination Mechanism Explained:\n#### How to get continuation_token:\nExtract from response JSON, typically at one of these paths:\n```python\n# Path 1: In onResponseReceivedCommands\nresponse[\"onResponseReceivedCommands\"][0][\"appendContinuationItemsAction\"][\"continuationItems\"][-1][\"continuationItemRenderer\"][\"continuationEndpoint\"][\"continuationCommand\"][\"token\"]\n\n# Path 2: In contents\nresponse[\"contents\"][\"twoColumnSearchResultsRenderer\"][\"primaryContents\"][\"sectionListRenderer\"][\"contents\"][-1][\"continuationItemRenderer\"][\"continuationEndpoint\"][\"continuationCommand\"][\"token\"]\n```\n\n#### Usage Flow:\n1. **First request**: Don't pass continuation_token\n   ```\n   GET /api/v1/youtube_web/get_shorts_search?search_query=python\n   ```\n2. **Extract token**: Find continuation_token in response\n3. **Next requests**: Pass continuation_token to get next page\n   ```\n   GET /api/v1/youtube_web/get_shorts_search?search_query=python&continuation_token=xxx\n   ```\n\n### Response Data Structure:\n```json\n{\n  \"code\": 200,\n  \"data\": {\n    \"contents\": {\n      \"twoColumnSearchResultsRenderer\": {\n        \"primaryContents\": {\n          \"sectionListRenderer\": {\n            \"contents\": [\n              {\n                \"itemSectionRenderer\": {\n                  \"contents\": [\n                    {\n                      \"gridShelfViewModel\": {\n                        // Shorts video list\n                        \"items\": [...]\n                      }\n                    }\n                  ]\n                }\n              },\n              {\n                \"continuationItemRenderer\": {\n                  \"continuationEndpoint\": {\n                    \"continuationCommand\": {\n                      \"token\": \"xxx\"  // Token for next page\n                    }\n                  }\n                }\n              }\n            ]\n          }\n        }\n      }\n    }\n  }\n}\n```\n\n### ⚠️ Recommend using V2 version:\n- This endpoint returns raw YouTube data structure that requires manual parsing\n- **For cleaned/structured data, use `/get_shorts_search_v2` endpoint**, which returns structured Shorts list and automatically filters non-Shorts content\n\n### Returns:\n- Shorts-specific search results with video list and pagination token\n\n# [示例/Examples]\n## 基础Shorts搜索（自动过滤长视频）\nGET /youtube_web/get_shorts_search?search_query=Python编程\n\n## 获取原始混合内容（包含长视频）\nGET /youtube_web/get_shorts_search?search_query=Python编程&filter_mixed_content=false\n\n## 搜索本周上传的Python相关Shorts\nGET /youtube_web/get_shorts_search?search_query=python&upload_time=week\n\n## 搜索观看次数最多的技术Shorts\nGET /youtube_web/get_shorts_search?search_query=技术&sort_by=view_count\n\n## 翻页获取更多Shorts\nGET /youtube_web/get_shorts_search?search_query=编程&continuation_token=EqcBEgPkuKzor4YybhmgGk...","operationId":"get_shorts_search_api_v1_youtube_web_v2_get_shorts_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"search_query","in":"query","required":true,"schema":{"type":"string","maxLength":200,"description":"搜索关键字/Search keyword","title":"Search Query"},"description":"搜索关键字/Search keyword","example":"Python编程"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"en-US","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"en-US"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, CN等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, CN等）/Country code","example":"US"},{"name":"time_zone","in":"query","required":false,"schema":{"type":"string","description":"时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone","default":"America/Los_Angeles","title":"Time Zone"},"description":"时区（如America/Los_Angeles, Asia/Shanghai等）/Time zone","example":"America/Los_Angeles"},{"name":"upload_time","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeUploadTimeAPI"},{"type":"null"}],"description":"上传时间过滤 | Upload time filter for Shorts","examples":{"hour":{"summary":"过去1小时","value":"hour"},"today":{"summary":"今天","value":"today"},"week":{"summary":"本周","value":"week"},"month":{"summary":"本月","value":"month"},"year":{"summary":"今年","value":"year"}},"title":"Upload Time"},"description":"上传时间过滤 | Upload time filter for Shorts"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/YouTubeSearchSortAPI"},{"type":"null"}],"description":"排序方式 | Sort by for Shorts","examples":{"relevance":{"summary":"相关性","value":"relevance"},"upload_date":{"summary":"上传日期","value":"upload_date"},"view_count":{"summary":"观看次数","value":"view_count"},"rating":{"summary":"评分","value":"rating"}},"title":"Sort By"},"description":"排序方式 | Sort by for Shorts"},{"name":"continuation_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"翻页令牌/Pagination token","title":"Continuation Token"},"description":"翻页令牌/Pagination token","example":""},{"name":"filter_mixed_content","in":"query","required":false,"schema":{"type":"boolean","description":"是否过滤混合内容（长视频），默认True / Filter mixed content (long videos), default True","default":true,"title":"Filter Mixed Content"},"description":"是否过滤混合内容（长视频），默认True / Filter mixed content (long videos), default True","example":true}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_shorts_search_v2":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"Shorts搜索V2/Shorts search V2","description":"# [中文]\n### 用途:\n- 专门搜索 YouTube Shorts 短视频\n- 返回清洗后的结构化数据（相比 get_shorts_search 返回原始数据）\n- 自动过滤非 Shorts 内容，仅返回短视频结果\n- 支持分页加载更多\n\n### 参数:\n- keyword: 搜索关键词（首次请求必填）\n- continuation_token: 分页token（从上一次返回结果获取）\n- upload_date: 上传时间过滤 - last_hour/today/this_week/this_month/this_year\n- sort_by: 排序方式 - relevance/upload_date/view_count/rating\n\n### 返回数据:\n- shorts: Shorts 列表（video_id、标题、播放量、作者、频道ID、缩略图、URL）\n- continuation_token: 下一页 token\n\n# [English]\n### Purpose:\n- Search specifically for YouTube Shorts\n- Returns cleaned structured data (compared to get_shorts_search which returns raw data)\n- Automatically filters non-Shorts content, returns only short videos\n- Supports pagination\n\n### Parameters:\n- keyword: Search keyword (required for first request)\n- continuation_token: Pagination token (from previous response)\n- upload_date: Upload date filter - last_hour/today/this_week/this_month/this_year\n- sort_by: Sort by - relevance/upload_date/view_count/rating\n\n### Returns:\n- shorts: Shorts list (video_id, title, views, author, channel_id, thumbnails, URL)\n- continuation_token: Next page token\n\n# [示例/Example]\n#### 基础搜索: GET /get_shorts_search_v2?keyword=coding tips\n#### 带过滤: GET /get_shorts_search_v2?keyword=coding tips&upload_date=this_week&sort_by=view_count","operationId":"get_shorts_search_v2_api_v1_youtube_web_v2_get_shorts_search_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"搜索关键词（首次请求必填）/Search keyword (required for first request)","title":"Keyword"},"description":"搜索关键词（首次请求必填）/Search keyword (required for first request)","example":"coding tips"},{"name":"continuation_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"分页token，用于获取下一页/Continuation token for next page","title":"Continuation Token"},"description":"分页token，用于获取下一页/Continuation token for next page"},{"name":"upload_date","in":"query","required":false,"schema":{"anyOf":[{"enum":["last_hour","today","this_week","this_month","this_year"],"type":"string"},{"type":"null"}],"description":"上传时间过滤/Upload date filter","title":"Upload Date"},"description":"上传时间过滤/Upload date filter"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"enum":["relevance","upload_date","view_count","rating"],"type":"string"},{"type":"null"}],"description":"排序方式/Sort by","title":"Sort By"},"description":"排序方式/Sort by"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_channel_id":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"从频道URL获取频道ID /Get channel ID from URL","description":"# [中文]\n### 用途:\n- 从YouTube频道URL转换获取频道ID（channel_id）。\n- 支持多种URL格式，包括@用户名格式、/channel/格式、/c/格式、/user/格式。\n### 参数:\n- channel_url: 频道URL。\n### 返回:\n- channel_id: 频道ID（如：UCeu6U67OzJhV1KwBansH3Dg）\n- channel_url: 标准化的频道URL\n- source: 数据来源（url_parse表示直接从URL解析，page_parse表示从页面解析）\n\n# [English]\n### Purpose:\n- Convert YouTube channel URL to channel ID.\n- Supports multiple URL formats including @username, /channel/, /c/, /user/ formats.\n### Parameters:\n- channel_url: Channel URL.\n### Returns:\n- channel_id: Channel ID (e.g., UCeu6U67OzJhV1KwBansH3Dg)\n- channel_url: Normalized channel URL\n- source: Data source (url_parse means parsed from URL directly, page_parse means parsed from page)\n\n# [示例/Example]\nchannel_url = \"https://www.youtube.com/@CozyCraftYT\"","operationId":"get_channel_id_api_v1_youtube_web_v2_get_channel_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_url","in":"query","required":true,"schema":{"type":"string","description":"频道URL/Channel URL，支持多种格式如：https://www.youtube.com/@username, https://www.youtube.com/channel/UCxxxxxx, https://www.youtube.com/c/channelname","title":"Channel Url"},"description":"频道URL/Channel URL，支持多种格式如：https://www.youtube.com/@username, https://www.youtube.com/channel/UCxxxxxx, https://www.youtube.com/c/channelname","example":"https://www.youtube.com/@CozyCraftYT"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_channel_url":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"从频道ID获取频道URL/Get channel URL from channel ID","description":"# [中文]\n### 用途:\n- 从YouTube频道ID转换获取频道Handle (@用户名)\n- 与 get_channel_id 接口互为反向操作\n\n### 参数:\n- channel_id: 频道ID（如：UCeu6U67OzJhV1KwBansH3Dg）\n\n### 返回:\n- channel_id: 频道ID\n- handle: 频道Handle（如：CozyCraftYT）\n- title: 频道名称\n- channel_url: 标准频道URL（/channel/格式）\n- vanity_url: 个性化URL（/@用户名格式）\n\n### 使用场景:\n- 当你有频道ID但需要获取@用户名格式的URL时\n- 需要展示用户友好的频道链接时\n\n# [English]\n### Purpose:\n- Convert YouTube channel ID to channel handle (@username)\n- Reverse operation of get_channel_id endpoint\n\n### Parameters:\n- channel_id: Channel ID (e.g., UCeu6U67OzJhV1KwBansH3Dg)\n\n### Returns:\n- channel_id: Channel ID\n- handle: Channel handle (e.g., CozyCraftYT)\n- title: Channel name\n- channel_url: Standard channel URL (/channel/ format)\n- vanity_url: Vanity URL (/@username format)\n\n### Use Cases:\n- When you have channel ID but need @username format URL\n- When you need to display user-friendly channel links\n\n# [示例/Example]\nchannel_id = \"UCeu6U67OzJhV1KwBansH3Dg\"","operationId":"get_channel_url_api_v1_youtube_web_v2_get_channel_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","description":"频道ID/Channel ID (格式如：UCeu6U67OzJhV1KwBansH3Dg)","title":"Channel Id"},"description":"频道ID/Channel ID (格式如：UCeu6U67OzJhV1KwBansH3Dg)","example":"UCeu6U67OzJhV1KwBansH3Dg"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_channel_videos":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取频道视频 /Get channel videos","description":"# [中文]\n### 用途:\n- 获取YouTube频道的视频列表\n- 支持分页获取，可通过 continuation_token 获取更多视频\n\n### 参数详解:\n\n#### 📌 必选参数:\n**channel_id** (string)\n- **作用**: 频道ID\n- **获取方式**:\n  - 从频道URL中提取，例如 `https://www.youtube.com/channel/UCJHBJ7F-nAIlMGolm0Hu4vg`\n  - 或从 `@用户名` 格式的URL中，先访问频道页面获取真实的频道ID\n- **示例**: `\"UCJHBJ7F-nAIlMGolm0Hu4vg\"`\n\n#### ⚙️ 可选参数:\n**language_code** (string, 可选)\n- **作用**: 设置语言偏好\n- **默认值**: `\"zh-CN\"`\n- **可用值**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"` 等\n\n**country_code** (string, 可选)\n- **作用**: 设置地区代码\n- **默认值**: `\"US\"`\n- **可用值**: `\"US\"`, `\"JP\"`, `\"GB\"` 等\n\n**continuation_token** (string, 可选)\n- **作用**: 分页token，用于获取下一页视频\n- **获取方式**: 从上一次请求的响应中提取\n- **首次请求**: 不传此参数或传 `null`\n\n**need_format** (boolean, 可选)\n- **作用**: 是否返回清洗后的精简数据\n- **默认值**: `true`\n- **可用值**:\n  - `false` - 返回原始完整数据\n  - `true` - 返回清洗后的精简数据（推荐，默认）\n\n### 返回数据结构 (need_format=true):\n```json\n{\n  \"videos\": [\n    {\n      \"video_id\": \"zd3yCa1bJCM\",\n      \"title\": \"Minecraft: DREAM! - Asleep Custom Map\",\n      \"thumbnail\": \"https://i.ytimg.com/vi/zd3yCa1bJCM/hqdefault.jpg\",\n      \"thumbnails\": [\n        {\"url\": \"...\", \"width\": 168, \"height\": 94},\n        {\"url\": \"...\", \"width\": 336, \"height\": 188}\n      ],\n      \"moving_thumbnail\": \"https://i.ytimg.com/an_webp/zd3yCa1bJCM/mqdefault_6s.webp?...\",\n      \"duration\": \"16:57\",\n      \"duration_accessibility\": \"16分钟57秒钟\",\n      \"view_count\": \"343,369次观看\",\n      \"short_view_count\": \"34万次观看\",\n      \"published_time\": \"18小时前\",\n      \"description\": \"Today, we're trapped in a super weird dream...\",\n      \"is_live\": false,\n      \"is_verified\": true,\n      \"url\": \"https://www.youtube.com/watch?v=zd3yCa1bJCM\",\n      \"playback_url\": \"https://rr5---sn-ogueln67.googlevideo.com/initplayback?...\"\n    }\n  ],\n  \"continuation_token\": \"下一页token\"\n}\n```\n\n### 清洗后的字段说明:\n- `video_id`: 视频ID\n- `title`: 视频标题\n- `thumbnail`: 最高清晰度缩略图URL\n- `thumbnails`: 所有分辨率的缩略图列表\n- `moving_thumbnail`: 动态缩略图URL（webp格式，鼠标悬停预览）\n- `duration`: 视频时长（如\"16:57\"）\n- `duration_accessibility`: 时长无障碍文本（如\"16分钟57秒钟\"）\n- `view_count`: 完整观看次数（如\"343,369次观看\"）\n- `short_view_count`: 简短观看次数（如\"34万次观看\"）\n- `published_time`: 发布时间（如\"18小时前\"）\n- `description`: 视频描述片段\n- `is_live`: 是否为直播\n- `is_verified`: 频道是否已认证\n- `url`: 视频播放页URL\n- `playback_url`: 视频播放初始化URL（googlevideo.com，可能为空）\n- `continuation_token`: 下一页的分页token\n\n# [English]\n### Purpose:\n- Get YouTube channel video list\n- Supports pagination via continuation_token\n\n### Parameters:\n\n#### 📌 Required:\n**channel_id** (string)\n- **Purpose**: Channel ID\n- **How to get**:\n  - Extract from channel URL, e.g., `https://www.youtube.com/channel/UCJHBJ7F-nAIlMGolm0Hu4vg`\n  - Or visit the channel page to get the real channel ID from `@username` format URLs\n- **Example**: `\"UCJHBJ7F-nAIlMGolm0Hu4vg\"`\n\n#### ⚙️ Optional:\n**language_code** (string, optional)\n- **Purpose**: Set language preference\n- **Default**: `\"zh-CN\"`\n- **Values**: `\"zh-CN\"`, `\"en-US\"`, `\"ja-JP\"`, `\"ko-KR\"`, etc.\n\n**country_code** (string, optional)\n- **Purpose**: Set region code\n- **Default**: `\"US\"`\n- **Values**: `\"US\"`, `\"JP\"`, `\"GB\"`, etc.\n\n**continuation_token** (string, optional)\n- **Purpose**: Pagination token for next page\n- **How to get**: Extract from previous response\n- **First request**: Omit or set to `null`\n\n**need_format** (boolean, optional)\n- **Purpose**: Whether to return cleaned simplified data\n- **Default**: `true`\n- **Values**:\n  - `false` - Return raw complete data\n  - `true` - Return cleaned simplified data (recommended, default)\n\n### Response Structure (need_format=true):\n```json\n{\n  \"videos\": [\n    {\n      \"video_id\": \"zd3yCa1bJCM\",\n      \"title\": \"Minecraft: DREAM! - Asleep Custom Map\",\n      \"thumbnail\": \"https://i.ytimg.com/vi/zd3yCa1bJCM/hqdefault.jpg\",\n      \"thumbnails\": [\n        {\"url\": \"...\", \"width\": 168, \"height\": 94},\n        {\"url\": \"...\", \"width\": 336, \"height\": 188}\n      ],\n      \"moving_thumbnail\": \"https://i.ytimg.com/an_webp/zd3yCa1bJCM/mqdefault_6s.webp?...\",\n      \"duration\": \"16:57\",\n      \"duration_accessibility\": \"16 minutes, 57 seconds\",\n      \"view_count\": \"343,369 views\",\n      \"short_view_count\": \"343K views\",\n      \"published_time\": \"18 hours ago\",\n      \"description\": \"Today, we're trapped in a super weird dream...\",\n      \"is_live\": false,\n      \"is_verified\": true,\n      \"url\": \"https://www.youtube.com/watch?v=zd3yCa1bJCM\",\n      \"playback_url\": \"https://rr5---sn-ogueln67.googlevideo.com/initplayback?...\"\n    }\n  ],\n  \"continuation_token\": \"next page token\"\n}\n```\n\n### Cleaned Data Field Descriptions:\n- `video_id`: Video ID\n- `title`: Video title\n- `thumbnail`: Highest resolution thumbnail URL\n- `thumbnails`: List of all resolution thumbnails\n- `moving_thumbnail`: Moving thumbnail URL (webp format, hover preview)\n- `duration`: Video duration (e.g., \"16:57\")\n- `duration_accessibility`: Duration accessibility text (e.g., \"16 minutes, 57 seconds\")\n- `view_count`: Full view count (e.g., \"343,369 views\")\n- `short_view_count`: Short view count (e.g., \"343K views\")\n- `published_time`: Published time (e.g., \"18 hours ago\")\n- `description`: Video description snippet\n- `is_live`: Whether it's a live stream\n- `is_verified`: Whether the channel is verified\n- `url`: Video playback page URL\n- `playback_url`: Video playback initialization URL (googlevideo.com, may be empty)\n- `continuation_token`: Pagination token for next page\n\n# [示例/Examples]\n## 获取频道首页视频 / Get first page of channel videos\nGET /youtube_web/get_channel_videos?channel_id=UCJHBJ7F-nAIlMGolm0Hu4vg\n\n## 获取清洗后的数据（推荐）/ Get cleaned data (recommended)\nGET /youtube_web/get_channel_videos?channel_id=UCJHBJ7F-nAIlMGolm0Hu4vg&need_format=true\n\n## 获取下一页 / Get next page\nGET /youtube_web/get_channel_videos?channel_id=UCJHBJ7F-nAIlMGolm0Hu4vg&continuation_token=xxxxx&need_format=true","operationId":"get_channel_videos_api_v1_youtube_web_v2_get_channel_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":true,"schema":{"type":"string","description":"频道ID/Channel ID","title":"Channel Id"},"description":"频道ID/Channel ID","example":"UCJHBJ7F-nAIlMGolm0Hu4vg"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码（如zh-CN, en-US等）/Language code","default":"zh-CN","title":"Language Code"},"description":"语言代码（如zh-CN, en-US等）/Language code","example":"zh-CN"},{"name":"country_code","in":"query","required":false,"schema":{"type":"string","description":"国家代码（如US, JP等）/Country code","default":"US","title":"Country Code"},"description":"国家代码（如US, JP等）/Country code","example":"US"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"分页token，用于获取下一页/Pagination token for next page","title":"Continuation Token"},"description":"分页token，用于获取下一页/Pagination token for next page"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data","default":true,"title":"Need Format"},"description":"是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_video_streams":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取视频流信息/Get video streams info","description":"# [中文]\n### ⚠️ 重要说明:\n- **此接口仅返回格式信息，URL 字段为 null**\n- **必须搭配 get_signed_stream_url 接口获取播放地址**\n- 如需一次性获取所有 URL，请使用 get_video_streams_v2 接口\n\n### 用途:\n- 获取YouTube视频所有清晰度的格式信息\n- 返回标准格式（音视频合并）和自适应格式（音视频分离）\n\n### 参数:\n- video_id: 视频ID（推荐）\n- video_url: 完整的视频URL（可选，如果提供video_id则忽略）\n\n### 返回数据包含:\n- 视频基本信息（标题、作者、时长、观看次数等）\n- formats: 标准格式流（包含音频和视频）\n- adaptive_formats: 自适应格式流（仅视频或仅音频）\n  - 每个格式包含: itag、mime_type、质量标签、分辨率、比特率等\n  - ⚠️ **url 字段为 null**（YouTube 需要签名解密才能获取真实播放地址）\n  - has_signature 为 true 表示需要使用 get_signed_stream_url 接口\n- hls_manifest_url: HLS流地址（如果有）\n- dash_manifest_url: DASH流地址（如果有）\n- available_qualities: 所有可用的清晰度列表\n\n### 使用流程（两步法）:\n1. **第一步**: 调用此接口获取所有可用格式信息（URL 为 null）\n2. **第二步**: 从返回的 formats 或 adaptive_formats 中选择需要的 itag\n3. **第三步**: 调用 get_signed_stream_url 接口，传入 video_id 和 itag，获取真实播放地址\n\n### 注意事项:\n- YouTube 视频播放地址需要签名解密，原始 API 返回的 URL 字段为 null 是正常现象\n- 播放地址必须通过 get_signed_stream_url 接口单独获取\n- 高清视频（720p+）通常需要分别下载音视频流并合并\n\n### 价格:\n- $0.001 USD/请求\n\n# [English]\n### ⚠️ Important Notice:\n- **This endpoint ONLY returns format information, URL fields are null**\n- **MUST use get_signed_stream_url endpoint to get playback URLs**\n- For getting all URLs at once, use get_video_streams_v2 endpoint\n\n### Purpose:\n- Get all quality format information for YouTube video\n- Returns standard formats (merged audio/video) and adaptive formats (separate audio/video)\n\n### Parameters:\n- video_id: Video ID (recommended)\n- video_url: Full video URL (optional, ignored if video_id is provided)\n\n### Returns:\n- Basic video info (title, author, duration, view count, etc.)\n- formats: Standard format streams (audio and video combined)\n- adaptive_formats: Adaptive format streams (video-only or audio-only)\n  - Each format contains: itag, mime_type, quality label, resolution, bitrate, etc.\n  - ⚠️ **url field is null** (YouTube requires signature decryption to get actual playback URL)\n  - has_signature=true means need to use get_signed_stream_url endpoint\n- hls_manifest_url: HLS manifest URL (if available)\n- dash_manifest_url: DASH manifest URL (if available)\n- available_qualities: List of all available quality levels\n\n### Usage Flow (Two-Step Method):\n1. **Step 1**: Call this endpoint to get all available format information (URLs are null)\n2. **Step 2**: Select the desired itag from returned formats or adaptive_formats\n3. **Step 3**: Call get_signed_stream_url endpoint with video_id and itag to get actual playback URL\n\n### Notes:\n- YouTube video playback URLs require signature decryption, null URL fields in raw API response is normal\n- Playback URLs must be obtained separately via get_signed_stream_url endpoint\n- High-quality videos (720p+) usually require separate download and merge of audio/video streams\n\n### Price:\n- $0.001 USD/request\n\n### [示例/Example]\n#### Step 1 - 获取格式信息: video_id = \"dQw4w9WgXcQ\"\n#### Step 2 - 获取播放地址: use get_signed_stream_url with selected itag","operationId":"get_video_streams_api_v1_youtube_web_v2_get_video_streams_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":false,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"dQw4w9WgXcQ"},{"name":"video_url","in":"query","required":false,"schema":{"type":"string","description":"视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided)","title":"Video Url"},"description":"视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided)","example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_video_streams_v2":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取视频流信息 V2/Get video streams info V2","description":"# [中文]\n### ✅ 特性:\n- **自动返回所有格式的已解密播放地址**\n- 无需额外调用 get_signed_stream_url 接口\n- 一次性获取所有清晰度的可用链接\n\n### 用途:\n- 获取YouTube视频所有清晰度的格式信息和播放地址\n- 返回标准格式（音视频合并）和自适应格式（音视频分离）\n- 适合需要展示所有清晰度选项的场景\n\n### 参数:\n- video_id: 视频ID（推荐）\n- video_url: 完整的视频URL（可选，如果提供video_id则忽略）\n\n### 返回数据包含:\n- 视频基本信息（标题、作者、时长、观看次数等）\n- formats: 标准格式流（包含音频和视频）\n- adaptive_formats: 自适应格式流（仅视频或仅音频）\n  - 每个格式包含: itag、mime_type、质量标签、分辨率、比特率等\n  - ✅ **url 字段包含已解密的播放地址，可直接使用**\n  - has_signature 为 false 表示 URL 已解密，可直接播放\n- hls_manifest_url: HLS流地址（如果有）\n- dash_manifest_url: DASH流地址（如果有）\n- available_qualities: 所有可用的清晰度列表\n- expires_in_seconds: URL 过期时间（约 6 小时 = 21600 秒）\n\n### 与 get_video_streams 的区别:\n- **get_video_streams**: URL 为 null，需要搭配 get_signed_stream_url 使用（两步法）\n- **get_video_streams_v2 (本接口)**: 自动返回所有已解密的 URL（一步到位）\n\n### 注意事项:\n- 播放地址有时效性（约6小时），建议获取后尽快使用\n- 高清视频（720p+）通常需要分别下载音视频流并合并\n- 响应时间较长（约10秒），因为需要为所有格式解密 URL\n\n### 价格:\n- $0.003 USD/请求\n\n# [English]\n### ✅ Features:\n- **Automatically returns decrypted playback URLs for all formats**\n- No need to call get_signed_stream_url endpoint separately\n- Get all quality URLs in one request\n\n### Purpose:\n- Get all quality format information and playback URLs for YouTube video\n- Returns standard formats (merged audio/video) and adaptive formats (separate audio/video)\n- Suitable for scenarios that need to display all quality options\n\n### Parameters:\n- video_id: Video ID (recommended)\n- video_url: Full video URL (optional, ignored if video_id is provided)\n\n### Returns:\n- Basic video info (title, author, duration, view count, etc.)\n- formats: Standard format streams (audio and video combined)\n- adaptive_formats: Adaptive format streams (video-only or audio-only)\n  - Each format contains: itag, mime_type, quality label, resolution, bitrate, etc.\n  - ✅ **url field contains decrypted playback URL, ready to use**\n  - has_signature=false means URL is decrypted and ready to play\n- hls_manifest_url: HLS manifest URL (if available)\n- dash_manifest_url: DASH manifest URL (if available)\n- available_qualities: List of all available quality levels\n- expires_in_seconds: URL expiration time (about 6 hours = 21600 seconds)\n\n### Difference from get_video_streams:\n- **get_video_streams**: URLs are null, need to use get_signed_stream_url (two-step method)\n- **get_video_streams_v2 (this endpoint)**: Automatically returns all decrypted URLs (one-step solution)\n\n### Notes:\n- Playback URLs expire after ~6 hours, use them promptly\n- High-quality videos (720p+) usually require separate download and merge of audio/video streams\n- Longer response time (~10 seconds) as it needs to decrypt URLs for all formats\n\n### Price:\n- $0.003 USD/request\n\n### [示例/Example]\n#### 获取所有格式和URL: video_id = \"dQw4w9WgXcQ\"","operationId":"get_video_streams_v2_api_v1_youtube_web_v2_get_video_streams_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":false,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"dQw4w9WgXcQ"},{"name":"video_url","in":"query","required":false,"schema":{"type":"string","description":"视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided)","title":"Video Url"},"description":"视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided)","example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_signed_stream_url":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取已签名的视频流URL/Get signed video stream URL","description":"# [中文]\n### 用途:\n- 获取指定 itag 的已签名播放地址（可直接播放）\n- 配合 get_video_streams 接口使用，先获取所有格式，再选择 itag 获取播放地址\n\n### 参数:\n- video_id: 视频ID（推荐）\n- video_url: 完整的视频URL（可选）\n- itag: 格式标识符，从 get_video_streams 接口返回的格式列表中选择\n\n### 返回数据:\n- itag: 格式标识符\n- url: 已签名的播放地址（可直接使用）\n- expires_in_seconds: URL有效期（通常为6小时 = 21600秒）\n\n### 注意事项:\n- 播放地址有时效性（约6小时），过期后需重新获取\n- URL 长度较长（约1000-2000字符）\n- 某些视频可能受地区限制\n\n# [English]\n### Purpose:\n- Get signed playback URL for specific itag (ready to play)\n- Use with get_video_streams endpoint: first get all formats, then select itag to get playback URL\n\n### Parameters:\n- video_id: Video ID (recommended)\n- video_url: Full video URL (optional)\n- itag: Format identifier, selected from formats list returned by get_video_streams\n\n### Returns:\n- itag: Format identifier\n- url: Signed playback URL (ready to use)\n- expires_in_seconds: URL validity period (typically 6 hours = 21600 seconds)\n\n### Notes:\n- Playback URLs expire after approximately 6 hours, need to regenerate after expiration\n- URL length is long (approximately 1000-2000 characters)\n- Some videos may have regional restrictions\n\n# [示例/Example]\nvideo_id = \"dQw4w9WgXcQ\"\nitag = 18  # 360p mp4 with audio","operationId":"get_signed_stream_url_api_v1_youtube_web_v2_get_signed_stream_url_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":false,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"dQw4w9WgXcQ"},{"name":"video_url","in":"query","required":false,"schema":{"type":"string","description":"视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided)","title":"Video Url"},"description":"视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided)","example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"},{"name":"itag","in":"query","required":true,"schema":{"type":"integer","description":"格式标识符 itag (从 get_video_streams 接口获取)/Format identifier itag (obtained from get_video_streams endpoint)","title":"Itag"},"description":"格式标识符 itag (从 get_video_streams 接口获取)/Format identifier itag (obtained from get_video_streams endpoint)","example":18}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_video_captions":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取视频字幕/Get video captions","description":"# [中文]\n### 用途:\n- 获取视频的字幕列表或指定语言的字幕内容\n- 支持多种字幕格式输出\n\n### 参数:\n- video_id: 视频ID（推荐）\n- video_url: 完整的视频URL（可选）\n- language_code: 语言代码（如 en, zh-Hans, a.en），为空时返回可用字幕列表\n- format: 字幕格式\n  - srt: SubRip 字幕格式（带时间轴）\n  - xml: 原始 XML 格式\n  - json3: JSON 格式（YouTube 原始结构）\n  - txt: 纯文本（无时间轴）\n\n### 使用流程:\n1. 不传 language_code，获取字幕列表\n2. 从列表中选择 language_code，获取字幕内容\n\n### 返回数据:\n#### 不传 language_code 时（字幕列表）:\n```json\n{\n  \"captions\": [\n    {\n      \"language_code\": \"en\",\n      \"language_name\": \"English\",\n      \"kind\": \"\",\n      \"is_translatable\": true,\n      \"base_url\": \"xxxx\"\n    },\n    {\n      \"language_code\": \"a.en\",\n      \"language_name\": \"English (auto-generated)\",\n      \"kind\": \"asr\",\n      \"is_translatable\": true,\n      \"base_url\": \"xxxx\"\n    }\n  ]\n}\n```\n\n#### 传 language_code 时（字幕内容）:\n- format=srt: 标准 SRT 字幕文件内容（含序号、时间轴、文本）\n- format=txt: 纯文本（仅文字，无时间轴）\n- format=xml: YouTube 原始 XML 字幕\n- format=json3: YouTube JSON 格式字幕\n\n### 注意事项:\n- kind 为 \"asr\" 表示自动生成的字幕\n- 并非所有视频都有字幕\n- video_id 和 video_url 至少提供一个\n\n### 价格:\n- $0.001 USD / 请求\n\n# [English]\n### Purpose:\n- Get video caption list or caption content for a specific language\n- Supports multiple caption format outputs\n\n### Parameters:\n- video_id: Video ID (recommended)\n- video_url: Full video URL (optional)\n- language_code: Language code (e.g. en, zh-Hans, a.en), returns available caption list if empty\n- format: Caption format\n  - srt: SubRip subtitle format (with timestamps)\n  - xml: Raw XML format\n  - json3: JSON format (YouTube raw structure)\n  - txt: Plain text (no timestamps)\n\n### Returns:\n#### Without language_code (caption list):\n```json\n{\n  \"captions\": [\n    {\n      \"language_code\": \"en\",\n      \"language_name\": \"English\",\n      \"kind\": \"\",\n      \"is_translatable\": true,\n      \"base_url\": \"xxxx\"\n    },\n    {\n      \"language_code\": \"a.en\",\n      \"language_name\": \"English (auto-generated)\",\n      \"kind\": \"asr\",\n      \"is_translatable\": true,\n      \"base_url\": \"xxxx\"\n    }\n  ]\n}\n```\n\n#### With language_code (caption content):\n- format=srt: Standard SRT subtitle content (with sequence numbers, timestamps, text)\n- format=txt: Plain text (text only, no timestamps)\n- format=xml: YouTube raw XML captions\n- format=json3: YouTube JSON format captions\n\n### Usage flow:\n1. Call without language_code to get available caption list\n2. Select language_code from the list to get caption content\n\n### Notes:\n- kind=\"asr\" indicates auto-generated captions\n- Not all videos have captions\n- At least one of video_id or video_url is required\n\n### Price:\n- $0.001 USD / request\n\n# [示例/Example]\n#### Step 1 - 获取字幕列表: GET /get_video_captions?video_id=dQw4w9WgXcQ\n#### Step 2 - 获取字幕内容: GET /get_video_captions?video_id=dQw4w9WgXcQ&language_code=en&format=srt","operationId":"get_video_captions_api_v1_youtube_web_v2_get_video_captions_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":false,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"dQw4w9WgXcQ"},{"name":"video_url","in":"query","required":false,"schema":{"type":"string","description":"视频URL/Video URL","title":"Video Url"},"description":"视频URL/Video URL","example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"},{"name":"language_code","in":"query","required":false,"schema":{"type":"string","description":"语言代码，为空时返回可用字幕列表/Language code, returns available caption list if empty","title":"Language Code"},"description":"语言代码，为空时返回可用字幕列表/Language code, returns available caption list if empty","example":"en"},{"name":"format","in":"query","required":false,"schema":{"enum":["srt","xml","json3","txt"],"type":"string","description":"字幕格式/Caption format","default":"srt","title":"Format"},"description":"字幕格式/Caption format","example":"srt"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_related_videos":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取视频相似内容/Get related videos","description":"# [中文]\n### 用途:\n- 获取YouTube视频的相似内容推荐（推荐视频列表）\n- 类似于视频播放页面右侧的相关视频\n- 一次性返回所有推荐视频（通常20-30个）\n\n### 参数:\n- video_id: 视频ID（推荐）\n- video_url: 完整的视频URL（可选，如果提供video_id则忽略）\n- need_format: 是否格式化数据（默认 true）\n  - true: 返回格式化的结构化数据（推荐）\n  - false: 返回原始的 YouTube API 结构（用于调试或自定义解析）\n\n### 返回数据包含:\n#### 当 need_format=true 时:\n- video_id: 当前视频ID\n- related_videos: 相关视频列表（格式化后的数据）\n  - video_id: 相关视频的ID\n  - title: 视频标题\n  - author: 作者名称\n  - author_id: 作者频道ID\n  - author_url: 作者频道链接\n  - length_text: 视频时长文本（如 \"3:45\"）\n  - length_seconds: 视频时长（秒数）\n  - view_count_text: 观看次数文本（如 \"1.2M views\"）\n  - short_view_count_text: 简短观看次数文本（如 \"1.2M\"）\n  - published_time_text: 发布时间文本（如 \"2 days ago\"）\n  - thumbnails: 所有分辨率的缩略图列表\n  - rich_thumbnail: 动态缩略图（如果有）\n  - badges: 视频徽章（如 NEW、LIVE 等）\n  - owner_badges: 作者徽章（如验证标识）\n  - video_url: 视频链接\n  - navigation_endpoint: 导航端点\n- total_count: 推荐视频总数\n\n#### 当 need_format=false 时:\n- video_id: 当前视频ID\n- related_videos: 原始的 lockupViewModel 对象列表\n- total_count: 推荐视频总数\n\n### 注意事项:\n- 每个视频的推荐内容由 YouTube 算法生成，可能会变化\n- 推荐列表通常包含 20-30 个视频\n- ⚠️ **此接口不支持分页**，一次性返回所有推荐视频\n\n### 价格:\n- $0.001 USD / 请求\n\n# [English]\n### Purpose:\n- Get YouTube video's related content recommendations (recommended videos list)\n- Similar to the related videos shown on the right side of video playback page\n- Returns all recommended videos at once (typically 20-30 videos)\n\n### Parameters:\n- video_id: Video ID (recommended)\n- video_url: Full video URL (optional, ignored if video_id is provided)\n- need_format: Whether to format data (default true)\n  - true: Return formatted structured data (recommended)\n  - false: Return raw YouTube API structure (for debugging or custom parsing)\n\n### Returns:\n#### When need_format=true:\n- video_id: Current video ID\n- related_videos: Related videos list\n  - video_id: Related video's ID\n  - title: Video title\n  - author: Author name\n  - author_id: Author channel ID\n  - author_url: Author channel URL\n  - length_text: Video duration text (e.g., \"3:45\")\n  - length_seconds: Video duration in seconds\n  - view_count_text: View count text (e.g., \"1.2M views\")\n  - short_view_count_text: Short view count text (e.g., \"1.2M\")\n  - published_time_text: Published time text (e.g., \"2 days ago\")\n  - thumbnails: All resolution thumbnails\n  - rich_thumbnail: Moving thumbnail (if available)\n  - badges: Video badges (e.g., NEW, LIVE)\n  - owner_badges: Channel verification badges\n  - video_url: Video URL\n  - navigation_endpoint: Navigation endpoint\n- total_count: Total number of recommended videos\n\n#### When need_format=false:\n- video_id: Current video ID\n- related_videos: Raw lockupViewModel object list\n- total_count: Total number of recommended videos\n\n### Notes:\n- Each video's recommendations are generated by YouTube's algorithm and may change\n- Recommendation list typically contains 20-30 videos\n- ⚠️ **This API does not support pagination**, returns all recommendations at once\n\n### Price:\n- $0.001 USD / request\n\n### [示例/Example]\n#### 获取推荐视频: video_id = \"dQw4w9WgXcQ\"","operationId":"get_related_videos_api_v1_youtube_web_v2_get_related_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"video_id","in":"query","required":false,"schema":{"type":"string","description":"视频ID/Video ID","title":"Video Id"},"description":"视频ID/Video ID","example":"dQw4w9WgXcQ"},{"name":"video_url","in":"query","required":false,"schema":{"type":"string","description":"视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided)","title":"Video Url"},"description":"视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided)","example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否格式化数据。true: 返回格式化的结构化数据，false: 返回原始API结构/Whether to format data. true: return formatted structured data, false: return raw API structure","default":true,"title":"Need Format"},"description":"是否格式化数据。true: 返回格式化的结构化数据，false: 返回原始API结构/Whether to format data. true: return formatted structured data, false: return raw API structure"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_channel_shorts":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取频道短视频列表/Get channel shorts","description":"# [中文]\n### 用途:\n- 获取YouTube频道的短视频(Shorts)列表\n- 支持分页获取更多短视频\n\n### 参数:\n- channel_id: 频道ID（推荐，如 UCuAXFkgsw1L7xaCfnd5JJOw）\n- channel_url: 频道URL（可选，如果提供channel_id则忽略）\n- continuation_token: 分页token（可选，用于获取下一页）\n- need_format: 是否格式化数据（默认 true）\n  - true: 返回格式化的结构化数据（推荐）\n  - false: 返回原始的 YouTube API 结构（用于调试）\n\n### 返回数据包含:\n#### 当 need_format=true 时:\n- channel_id: 频道ID\n- shorts: 短视频列表\n  - video_id: 短视频的ID\n  - title: 标题\n  - view_count_text: 观看次数文本（如 \"1.2M views\"）\n  - thumbnails: 缩略图列表\n  - accessibility_text: 无障碍文本描述\n  - video_url: 短视频链接\n- continuation_token: 下一页的分页token\n- has_more: 是否还有更多短视频\n- total_count: 当前页短视频数量\n\n#### 当 need_format=false 时:\n- channel_id: 频道ID\n- shorts: 原始的 reelItemRenderer 对象列表\n- continuation_token: 下一页的分页token\n- has_more: 是否还有更多短视频\n- total_count: 当前页短视频数量\n\n### 使用流程:\n1. 首次请求：只传 channel_id 参数\n2. 获取响应中的 continuation_token\n3. 下次请求：传入 channel_id 和 continuation_token\n4. 重复步骤 2-3 直到 has_more 为 false\n\n### 注意事项:\n- 每页通常返回 30 个左右的短视频\n- ⚠️ 目前暂不支持 @username 格式，请使用频道ID（UCxxxx 格式）\n\n### 价格:\n- $0.001 USD / 请求\n\n# [English]\n### Purpose:\n- Get YouTube channel's Shorts (short videos) list\n- Supports pagination to get more shorts\n\n### Parameters:\n- channel_id: Channel ID (recommended, e.g., UCuAXFkgsw1L7xaCfnd5JJOw)\n- channel_url: Channel URL (optional, ignored if channel_id is provided)\n- continuation_token: Pagination token (optional, for next page)\n- need_format: Whether to format data (default true)\n  - true: Return formatted structured data (recommended)\n  - false: Return raw YouTube API structure (for debugging)\n\n### Returns:\n#### When need_format=true:\n- channel_id: Channel ID\n- shorts: Shorts list\n  - video_id: Short video ID\n  - title: Title\n  - view_count_text: View count text (e.g., \"1.2M views\")\n  - thumbnails: Thumbnail list\n  - accessibility_text: Accessibility description text\n  - video_url: Short video URL\n- continuation_token: Next page pagination token\n- has_more: Whether there are more shorts\n- total_count: Current page shorts count\n\n#### When need_format=false:\n- channel_id: Channel ID\n- shorts: Raw reelItemRenderer object list\n- continuation_token: Next page pagination token\n- has_more: Whether there are more shorts\n- total_count: Current page shorts count\n\n### Usage Flow:\n1. First request: Only pass channel_id parameter\n2. Get continuation_token from response\n3. Next request: Pass channel_id and continuation_token\n4. Repeat steps 2-3 until has_more is false\n\n### Notes:\n- Each page typically returns around 30 shorts\n- ⚠️ Currently does not support @username format, please use channel ID (UCxxxx format)\n\n### Price:\n- $0.001 USD / request\n\n### [示例/Example]\n#### 获取短视频列表: channel_id = \"UCuAXFkgsw1L7xaCfnd5JJOw\"","operationId":"get_channel_shorts_api_v1_youtube_web_v2_get_channel_shorts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"channel_id","in":"query","required":false,"schema":{"type":"string","description":"频道ID/Channel ID (e.g., UCuAXFkgsw1L7xaCfnd5JJOw)","title":"Channel Id"},"description":"频道ID/Channel ID (e.g., UCuAXFkgsw1L7xaCfnd5JJOw)","example":"UCuAXFkgsw1L7xaCfnd5JJOw"},{"name":"channel_url","in":"query","required":false,"schema":{"type":"string","description":"频道URL/Channel URL (如果提供channel_id则忽略/Ignored if channel_id is provided)","title":"Channel Url"},"description":"频道URL/Channel URL (如果提供channel_id则忽略/Ignored if channel_id is provided)","example":"https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Continuation Token"},"description":"分页token/Pagination token"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否格式化数据/Whether to format data","default":true,"title":"Need Format"},"description":"是否格式化数据/Whether to format data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/get_search_suggestions":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"获取搜索推荐词/Get search suggestions","description":"# [中文]\n### 用途:\n- 获取YouTube搜索推荐词（自动补全）\n- 类似于在YouTube搜索框输入时显示的推荐词\n\n### 参数:\n- keyword: 搜索关键词（必填）\n- language: 语言代码（可选，默认 en）\n  - en: 英语\n  - zh-cn: 简体中文\n  - ja: 日语\n  - ko: 韩语\n- region: 地区代码（可选，默认 US）\n  - US: 美国\n  - SG: 新加坡\n  - CN: 中国\n  - JP: 日本\n  - KR: 韩国\n\n### 返回数据包含:\n- keyword: 搜索关键词\n- suggestions: 推荐词列表（字符串数组）\n- total_count: 推荐词数量\n\n### 注意事项:\n- 推荐词会根据语言和地区有所不同\n- 通常返回 10-20 个推荐词\n- 响应速度非常快（< 1秒）\n\n### 价格:\n- $0.0001 USD / 请求\n\n# [English]\n### Purpose:\n- Get YouTube search suggestions (autocomplete)\n- Similar to suggestions shown when typing in YouTube search box\n\n### Parameters:\n- keyword: Search keyword (required)\n- language: Language code (optional, default en)\n  - en: English\n  - zh-cn: Simplified Chinese\n  - ja: Japanese\n  - ko: Korean\n- region: Region code (optional, default US)\n  - US: United States\n  - SG: Singapore\n  - CN: China\n  - JP: Japan\n  - KR: Korea\n\n### Returns:\n- keyword: Search keyword\n- suggestions: Suggestions list (array of strings)\n- total_count: Number of suggestions\n\n### Notes:\n- Suggestions vary by language and region\n- Typically returns 10-20 suggestions\n- Very fast response (< 1 second)\n\n### Price:\n- $0.0001 USD / request\n\n### [示例/Example]\n#### 获取推荐词: keyword = \"Rick Astley\"","operationId":"get_search_suggestions_api_v1_youtube_web_v2_get_search_suggestions_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","maxLength":200,"description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"Rick Astley"},{"name":"language","in":"query","required":false,"schema":{"type":"string","description":"语言代码/Language code (e.g., en, zh-cn, ja)","default":"en","title":"Language"},"description":"语言代码/Language code (e.g., en, zh-cn, ja)","example":"en"},{"name":"region","in":"query","required":false,"schema":{"type":"string","description":"地区代码/Region code (e.g., US, SG, CN, JP)","default":"US","title":"Region"},"description":"地区代码/Region code (e.g., US, SG, CN, JP)","example":"US"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/youtube/web_v2/search_channels":{"get":{"tags":["YouTube-Web-V2-API"],"summary":"搜索频道/Search channels","description":"# [中文]\n### 用途:\n- 搜索YouTube频道\n- 只返回频道类型的搜索结果（过滤掉视频、播放列表等）\n- 支持分页获取更多频道\n\n### 参数:\n- keyword: 搜索关键词（首次请求必填）\n- continuation_token: 分页token（可选，用于获取下一页）\n- need_format: 是否格式化数据（默认 true）\n  - true: 返回格式化的结构化数据（推荐）\n  - false: 返回原始的 YouTube API 结构（用于调试）\n\n### 返回数据包含:\n#### 当 need_format=true 时:\n- keyword: 搜索关键词\n- channels: 频道列表\n  - channel_id: 频道ID（如 \"UCjuNibFJ21MiSNpu8LZyV4w\"）\n  - title: 频道名称\n  - handle: 频道自定义handle（如 \"@chaijing2023\"）\n  - subscriber_count_text: 订阅者数量文本（如 \"1.11M subscribers\"）\n  - description: 频道描述片段\n  - thumbnails: 缩略图列表（包含不同尺寸）\n  - is_subscribed: 当前用户是否已订阅该频道（布尔值）\n  - canonical_url: 频道规范URL路径（如 \"/@chaijing2023\"）\n  - channel_url: 频道完整URL（优先使用自定义URL）\n- continuation_token: 下一页的分页token\n- has_more: 是否还有更多频道\n- total_count: 当前页频道数量\n\n#### 当 need_format=false 时:\n- keyword: 搜索关键词\n- channels: 原始的 channelRenderer 对象列表\n- continuation_token: 下一页的分页token\n- has_more: 是否还有更多频道\n- total_count: 当前页频道数量\n\n### 使用流程:\n1. 首次请求：只传 keyword 参数\n2. 获取响应中的 continuation_token\n3. 下次请求：传入 continuation_token（keyword 可选）\n4. 重复步骤 2-3 直到 has_more 为 false\n\n### 注意事项:\n- 每页通常返回 10-20 个频道\n- 搜索结果只包含频道，不包含视频、播放列表等\n- 搜索结果的顺序和数量由 YouTube 算法决定\n\n### 价格:\n- $0.001 USD / 请求\n\n# [English]\n### Purpose:\n- Search YouTube channels\n- Only returns channel-type search results (filters out videos, playlists, etc.)\n- Supports pagination to get more channels\n\n### Parameters:\n- keyword: Search keyword (required for first request)\n- continuation_token: Pagination token (optional, for next page)\n- need_format: Whether to format data (default true)\n  - true: Return formatted structured data (recommended)\n  - false: Return raw YouTube API structure (for debugging)\n\n### Returns:\n#### When need_format=true:\n- keyword: Search keyword\n- channels: Channels list\n  - channel_id: Channel ID (e.g., \"UCjuNibFJ21MiSNpu8LZyV4w\")\n  - title: Channel name\n  - handle: Channel custom handle (e.g., \"@chaijing2023\")\n  - subscriber_count_text: Subscriber count text (e.g., \"1.11M subscribers\")\n  - description: Channel description snippet\n  - thumbnails: Thumbnail list (multiple sizes)\n  - is_subscribed: Whether current user is subscribed to this channel (boolean)\n  - canonical_url: Channel canonical URL path (e.g., \"/@chaijing2023\")\n  - channel_url: Full channel URL (prefers custom URL)\n- continuation_token: Next page pagination token\n- has_more: Whether there are more channels\n- total_count: Current page channel count\n\n#### When need_format=false:\n- keyword: Search keyword\n- channels: Raw channelRenderer object list\n- continuation_token: Next page pagination token\n- has_more: Whether there are more channels\n- total_count: Current page channel count\n\n### Usage Flow:\n1. First request: Only pass keyword parameter\n2. Get continuation_token from response\n3. Next request: Pass continuation_token (keyword optional)\n4. Repeat steps 2-3 until has_more is false\n\n### Notes:\n- Each page typically returns 10-20 channels\n- Search results only include channels, not videos, playlists, etc.\n- Order and quantity of results determined by YouTube algorithm\n\n### Price:\n- $0.001 USD / request\n\n### [示例/Example]\n#### 搜索频道: keyword = \"Rick Astley\"","operationId":"search_channels_api_v1_youtube_web_v2_search_channels_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"Rick Astley"},{"name":"continuation_token","in":"query","required":false,"schema":{"type":"string","description":"分页token/Pagination token","title":"Continuation Token"},"description":"分页token/Pagination token"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否格式化数据/Whether to format data","default":true,"title":"Need Format"},"description":"是否格式化数据/Whether to format data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_profile":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户资料/Get user profile","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户资料信息\n\n### 参数:\n- username: LinkedIn用户名（必填），可以从个人资料URL中获取，例如：https://www.linkedin.com/in/jack 则用户名为 jack\n- include_follower_and_connection: 包含粉丝和连接数（可选，额外消耗1次请求）\n- include_experiences: 包含工作经历（可选，额外消耗1次请求）\n- include_skills: 包含技能（可选，额外消耗1次请求）\n- include_certifications: 包含认证（可选，额外消耗1次请求）\n- include_publications: 包含出版物（可选，额外消耗1次请求）\n- include_educations: 包含教育背景（可选，额外消耗1次请求）\n- include_volunteers: 包含志愿者经历（可选，额外消耗1次请求）\n- include_honors: 包含荣誉奖项（可选，额外消耗1次请求）\n- include_interests: 包含兴趣（可选，额外消耗1次请求）\n- include_bio: 包含个人简介（可选，额外消耗1次请求）\n\n### 返回:\n- 用户资料数据，包含：\n    - id: 用户ID\n    - urn: 用户URN\n    - public_identifier: 公开标识符\n    - first_name: 名\n    - last_name: 姓\n    - full_name: 全名\n    - headline: 头衔/职位描述\n    - is_premium: 是否高级会员\n    - is_open_to_work: 是否开放工作机会\n    - is_hiring: 是否在招聘\n    - location: 位置信息\n    - cover: 封面图片\n    - 以及根据参数选择的其他信息\n\n# [English]\n### Purpose:\n- Get LinkedIn user profile information\n\n### Parameters:\n- username: LinkedIn username (required), can be obtained from profile URL, e.g., for https://www.linkedin.com/in/jack, the username is jack\n- include_follower_and_connection: Include follower and connection count (optional, +1 request)\n- include_experiences: Include work experiences (optional, +1 request)\n- include_skills: Include skills (optional, +1 request)\n- include_certifications: Include certifications (optional, +1 request)\n- include_publications: Include publications (optional, +1 request)\n- include_educations: Include educational background (optional, +1 request)\n- include_volunteers: Include volunteer experiences (optional, +1 request)\n- include_honors: Include honors and awards (optional, +1 request)\n- include_interests: Include interests (optional, +1 request)\n- include_bio: Include bio/about (optional, +1 request)\n\n### Returns:\n- User profile data including:\n    - id: User ID\n    - urn: User URN\n    - public_identifier: Public identifier\n    - first_name: First name\n    - last_name: Last name\n    - full_name: Full name\n    - headline: Headline/job description\n    - is_premium: Premium member status\n    - is_open_to_work: Open to work status\n    - is_hiring: Hiring status\n    - location: Location information\n    - cover: Cover images\n    - And other information based on selected parameters\n\n# [示例/Example]\nusername = \"jack\"","operationId":"get_user_profile_api_v1_linkedin_web_get_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"LinkedIn用户名/LinkedIn username","title":"Username"},"description":"LinkedIn用户名/LinkedIn username","example":"jack"},{"name":"include_follower_and_connection","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含粉丝和连接数（额外消耗1次请求）/Include follower and connection count (+1 request)","title":"Include Follower And Connection"},"description":"包含粉丝和连接数（额外消耗1次请求）/Include follower and connection count (+1 request)"},{"name":"include_experiences","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含工作经历（额外消耗1次请求）/Include work experiences (+1 request)","title":"Include Experiences"},"description":"包含工作经历（额外消耗1次请求）/Include work experiences (+1 request)"},{"name":"include_skills","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含技能（额外消耗1次请求）/Include skills (+1 request)","title":"Include Skills"},"description":"包含技能（额外消耗1次请求）/Include skills (+1 request)"},{"name":"include_certifications","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含认证（额外消耗1次请求）/Include certifications (+1 request)","title":"Include Certifications"},"description":"包含认证（额外消耗1次请求）/Include certifications (+1 request)"},{"name":"include_publications","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含出版物（额外消耗1次请求）/Include publications (+1 request)","title":"Include Publications"},"description":"包含出版物（额外消耗1次请求）/Include publications (+1 request)"},{"name":"include_educations","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含教育背景（额外消耗1次请求）/Include educational background (+1 request)","title":"Include Educations"},"description":"包含教育背景（额外消耗1次请求）/Include educational background (+1 request)"},{"name":"include_volunteers","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含志愿者经历（额外消耗1次请求）/Include volunteer experiences (+1 request)","title":"Include Volunteers"},"description":"包含志愿者经历（额外消耗1次请求）/Include volunteer experiences (+1 request)"},{"name":"include_honors","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含荣誉奖项（额外消耗1次请求）/Include honors and awards (+1 request)","title":"Include Honors"},"description":"包含荣誉奖项（额外消耗1次请求）/Include honors and awards (+1 request)"},{"name":"include_interests","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含兴趣（额外消耗1次请求）/Include interests (+1 request)","title":"Include Interests"},"description":"包含兴趣（额外消耗1次请求）/Include interests (+1 request)"},{"name":"include_bio","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含个人简介（额外消耗1次请求）/Include bio/about (+1 request)","title":"Include Bio"},"description":"包含个人简介（额外消耗1次请求）/Include bio/about (+1 request)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_posts":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户帖子/Get user posts","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户发布的帖子\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n- pagination_token: 分页令牌（可选）\n\n### 返回:\n- 用户帖子列表数据\n\n# [English]\n### Purpose:\n- Get posts published by LinkedIn user\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n- pagination_token: Pagination token (optional)\n\n### Returns:\n- User posts list data\n\n# [示例/Example]\nurn = \"ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8\"\npage = 1","operationId":"get_user_posts_api_v1_linkedin_web_get_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"pagination_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"分页令牌/Pagination token","title":"Pagination Token"},"description":"分页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_comments":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户评论/Get user comments","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户的评论\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n- pagination_token: 分页令牌（可选）\n\n### 返回:\n- 用户评论列表数据\n\n# [English]\n### Purpose:\n- Get comments made by LinkedIn user\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n- pagination_token: Pagination token (optional)\n\n### Returns:\n- User comments list data\n\n# [示例/Example]\nurn = \"ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8\"\npage = 1","operationId":"get_user_comments_api_v1_linkedin_web_get_user_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"pagination_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"分页令牌/Pagination token","title":"Pagination Token"},"description":"分页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_contact":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户联系信息/Get user contact information","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户的联系信息\n\n### 参数:\n- username: LinkedIn用户名（必填）\n\n### 返回:\n- 用户联系信息数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user contact information\n\n### Parameters:\n- username: LinkedIn username (required)\n\n### Returns:\n- User contact information data\n\n# [示例/Example]\nusername = \"shubhangi-shrivastava-39161bb7\"","operationId":"get_user_contact_api_v1_linkedin_web_get_user_contact_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"LinkedIn用户名/LinkedIn username","title":"Username"},"description":"LinkedIn用户名/LinkedIn username","example":"shubhangi-shrivastava-39161bb7"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_recommendations":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户推荐信/Get user recommendations","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户的推荐信\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n- type: 推荐类型（可选），默认为received\n    - received: 收到的推荐信\n    - given: 给出的推荐信\n- pagination_token: 分页令牌（可选）\n\n### 返回:\n- 用户推荐信列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user recommendations\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n- type: Recommendation type (optional), default is received\n    - received: Recommendations received\n    - given: Recommendations given\n- pagination_token: Pagination token (optional)\n\n### Returns:\n- User recommendations list data\n\n# [示例/Example]\nurn = \"ACoAAC3iNKcB3qbWJrP7K5Z3i89AF5c1snr8bhc\"\npage = 1\ntype = \"received\"","operationId":"get_user_recommendations_api_v1_linkedin_web_get_user_recommendations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAAC3iNKcB3qbWJrP7K5Z3i89AF5c1snr8bhc"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"推荐类型：received(收到的)或given(给出的)/Type: received or given","default":"received","title":"Type"},"description":"推荐类型：received(收到的)或given(给出的)/Type: received or given","example":"received"},{"name":"pagination_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"分页令牌/Pagination token","title":"Pagination Token"},"description":"分页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_videos":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户视频/Get user videos","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户发布的视频\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n- pagination_token: 分页令牌（可选）\n\n### 返回:\n- 用户视频列表数据\n\n# [English]\n### Purpose:\n- Get videos published by LinkedIn user\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n- pagination_token: Pagination token (optional)\n\n### Returns:\n- User videos list data\n\n# [示例/Example]\nurn = \"ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8\"\npage = 1","operationId":"get_user_videos_api_v1_linkedin_web_get_user_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"pagination_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"分页令牌/Pagination token","title":"Pagination Token"},"description":"分页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_images":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户图片/Get user images","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户发布的图片\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n- pagination_token: 分页令牌（可选）\n\n### 返回:\n- 用户图片列表数据\n\n# [English]\n### Purpose:\n- Get images published by LinkedIn user\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n- pagination_token: Pagination token (optional)\n\n### Returns:\n- User images list data\n\n# [示例/Example]\nurn = \"ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8\"\npage = 1","operationId":"get_user_images_api_v1_linkedin_web_get_user_images_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAABCtiL8B26nfi3Nbpo_AM8ngg4LeClT1Wh8"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"pagination_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"分页令牌/Pagination token","title":"Pagination Token"},"description":"分页令牌/Pagination token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_company_profile":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取公司资料/Get company profile","description":"# [中文]\n### 用途:\n- 获取LinkedIn公司资料信息\n\n### 参数:\n- company: 公司名称（可选）\n- company_id: 公司ID（可选，额外消耗1次请求）\n\n### 注意:\n- company和company_id至少需要提供一个\n\n### 返回:\n- 公司资料数据\n\n# [English]\n### Purpose:\n- Get LinkedIn company profile information\n\n### Parameters:\n- company: Company name (optional)\n- company_id: Company ID (optional, +1 request)\n\n### Note:\n- At least one of company or company_id must be provided\n\n### Returns:\n- Company profile data\n\n# [示例/Example]\ncompany = \"rapidapi\"","operationId":"get_company_profile_api_v1_linkedin_web_get_company_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"公司名称/Company name","title":"Company"},"description":"公司名称/Company name","example":"rapidapi"},{"name":"company_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"公司ID（额外消耗1次请求）/Company ID (+1 request)","title":"Company Id"},"description":"公司ID（额外消耗1次请求）/Company ID (+1 request)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_company_people":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取公司员工/Get company people","description":"# [中文]\n### 用途:\n- 获取LinkedIn公司员工列表\n\n### 参数:\n- company_id: 公司ID（必填）\n- page: 页码（可选），默认为1\n\n### 返回:\n- 公司员工列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn company people/employees list\n\n### Parameters:\n- company_id: Company ID (required)\n- page: Page number (optional), default is 1\n\n### Returns:\n- Company people list data\n\n# [示例/Example]\ncompany_id = \"1066442\"\npage = 1","operationId":"get_company_people_api_v1_linkedin_web_get_company_people_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string","description":"公司ID/Company ID","title":"Company Id"},"description":"公司ID/Company ID","example":"1066442"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_company_posts":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取公司帖子/Get company posts","description":"# [中文]\n### 用途:\n- 获取LinkedIn公司发布的帖子\n\n### 参数:\n- company_id: 公司ID（必填）\n- page: 页码（可选），默认为1\n- sort_by: 排序方式（可选），默认为top\n    - top: 热门帖子\n    - recent: 最新帖子\n\n### 返回:\n- 公司帖子列表数据\n\n# [English]\n### Purpose:\n- Get posts published by LinkedIn company\n\n### Parameters:\n- company_id: Company ID (required)\n- page: Page number (optional), default is 1\n- sort_by: Sort by (optional), default is top\n    - top: Top posts\n    - recent: Recent posts\n\n### Returns:\n- Company posts list data\n\n# [示例/Example]\ncompany_id = \"10649600\"\npage = 1\nsort_by = \"top\"","operationId":"get_company_posts_api_v1_linkedin_web_get_company_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string","description":"公司ID/Company ID","title":"Company Id"},"description":"公司ID/Company ID","example":"10649600"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"排序方式：top(热门)或recent(最新)/Sort by: top or recent","default":"top","title":"Sort By"},"description":"排序方式：top(热门)或recent(最新)/Sort by: top or recent","example":"top"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_company_jobs":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取公司职位/Get company jobs","description":"# [中文]\n### 用途:\n- 获取LinkedIn公司职位列表\n\n### 参数:\n- company_id: 公司ID（必填）\n- page: 页码（可选），默认为1\n- sort_by: 排序方式（可选）：recent(最新), relevant(相关)\n- date_posted: 发布时间过滤（可选）：anytime, past_month, past_week, past_24_hours\n- experience_level: 经验级别（可选）：internship, entry_level, associate, mid_senior, director, executive\n- remote: 工作地点类型（可选）：onsite, remote, hybrid\n- job_type: 工作类型（可选）：full_time, part_time, contract, temporary, volunteer, internship, other\n- easy_apply: 是否易申请（可选）\n- under_10_applicants: 是否少于10个申请者（可选）\n- fair_chance_employer: 是否公平机会雇主（可选）\n\n### 返回:\n- 公司职位列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn company jobs list\n\n### Parameters:\n- company_id: Company ID (required)\n- page: Page number (optional), default is 1\n- sort_by: Sort by (optional): recent, relevant\n- date_posted: Date posted filter (optional): anytime, past_month, past_week, past_24_hours\n- experience_level: Experience level (optional): internship, entry_level, associate, mid_senior, director, executive\n- remote: Remote filter (optional): onsite, remote, hybrid\n- job_type: Job type (optional): full_time, part_time, contract, temporary, volunteer, internship, other\n- easy_apply: Easy apply filter (optional)\n- under_10_applicants: Under 10 applicants filter (optional)\n- fair_chance_employer: Fair chance employer filter (optional)\n\n### Returns:\n- Company jobs list data\n\n# [示例/Example]\ncompany_id = \"783611\"\npage = 1","operationId":"get_company_jobs_api_v1_linkedin_web_get_company_jobs_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string","description":"公司ID/Company ID","title":"Company Id"},"description":"公司ID/Company ID","example":"783611"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"排序方式：recent(最新)或relevant(相关)/Sort by: recent or relevant","title":"Sort By"},"description":"排序方式：recent(最新)或relevant(相关)/Sort by: recent or relevant"},{"name":"date_posted","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"发布时间过滤：anytime, past_month, past_week, past_24_hours","title":"Date Posted"},"description":"发布时间过滤：anytime, past_month, past_week, past_24_hours"},{"name":"experience_level","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"经验级别：internship, entry_level, associate, mid_senior, director, executive","title":"Experience Level"},"description":"经验级别：internship, entry_level, associate, mid_senior, director, executive"},{"name":"remote","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"工作地点类型：onsite, remote, hybrid","title":"Remote"},"description":"工作地点类型：onsite, remote, hybrid"},{"name":"job_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"工作类型：full_time, part_time, contract, temporary, volunteer, internship, other","title":"Job Type"},"description":"工作类型：full_time, part_time, contract, temporary, volunteer, internship, other"},{"name":"easy_apply","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"是否易申请/Filter easy apply jobs","title":"Easy Apply"},"description":"是否易申请/Filter easy apply jobs"},{"name":"under_10_applicants","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"是否少于10个申请者/Filter jobs with under 10 applicants","title":"Under 10 Applicants"},"description":"是否少于10个申请者/Filter jobs with under 10 applicants"},{"name":"fair_chance_employer","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"是否公平机会雇主/Filter fair chance employer jobs","title":"Fair Chance Employer"},"description":"是否公平机会雇主/Filter fair chance employer jobs"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_company_job_count":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取公司职位数量/Get company job count","description":"# [中文]\n### 用途:\n- 获取LinkedIn公司职位数量\n\n### 参数:\n- company_id: 公司ID（必填）\n\n### 返回:\n- 公司职位数量数据\n\n# [English]\n### Purpose:\n- Get LinkedIn company job count\n\n### Parameters:\n- company_id: Company ID (required)\n\n### Returns:\n- Company job count data\n\n# [示例/Example]\ncompany_id = \"783611\"","operationId":"get_company_job_count_api_v1_linkedin_web_get_company_job_count_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string","description":"公司ID/Company ID","title":"Company Id"},"description":"公司ID/Company ID","example":"783611"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_about":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户简介/Get user about","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户简介/关于信息\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n\n### 返回:\n- 用户简介数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user about/bio information\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n\n### Returns:\n- User about data\n\n# [示例/Example]\nurn = \"ACoAAA8BYqEBCGLg_vT_ca6mMEqkpp9nVffJ3hc\"","operationId":"get_user_about_api_v1_linkedin_web_get_user_about_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAAA8BYqEBCGLg_vT_ca6mMEqkpp9nVffJ3hc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_follower_and_connection":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户粉丝和连接数/Get user follower and connection","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户粉丝和连接数\n\n### 参数:\n- username: LinkedIn用户名（必填）\n\n### 返回:\n- 用户粉丝和连接数数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user follower and connection count\n\n### Parameters:\n- username: LinkedIn username (required)\n\n### Returns:\n- User follower and connection data\n\n# [示例/Example]\nusername = \"zoranmilosevic\"","operationId":"get_user_follower_and_connection_api_v1_linkedin_web_get_user_follower_and_connection_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"LinkedIn用户名/LinkedIn username","title":"Username"},"description":"LinkedIn用户名/LinkedIn username","example":"zoranmilosevic"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_experience":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户工作经历/Get user experience","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户工作经历\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n\n### 返回:\n- 用户工作经历列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user work experience\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n\n### Returns:\n- User experience list data\n\n# [示例/Example]\nurn = \"ACoAAAjpjWIBMh1iBR4OgSPK5GXetlQ6dYUT-qo\"\npage = 1","operationId":"get_user_experience_api_v1_linkedin_web_get_user_experience_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAAAjpjWIBMh1iBR4OgSPK5GXetlQ6dYUT-qo"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_skills":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户技能/Get user skills","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户技能\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n\n### 返回:\n- 用户技能列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user skills\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n\n### Returns:\n- User skills list data\n\n# [示例/Example]\nurn = \"ACoAACkphDcBDruPBdXiAnqyc834jkTkd_4kRnU\"\npage = 1","operationId":"get_user_skills_api_v1_linkedin_web_get_user_skills_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAACkphDcBDruPBdXiAnqyc834jkTkd_4kRnU"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_educations":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户教育背景/Get user educations","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户教育背景\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n\n### 返回:\n- 用户教育背景列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user educations\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n\n### Returns:\n- User educations list data\n\n# [示例/Example]\nurn = \"ACoAAARpiwIBp_SzoeHPlUfOvmtibe08Ea1iCh4\"\npage = 1","operationId":"get_user_educations_api_v1_linkedin_web_get_user_educations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAAARpiwIBp_SzoeHPlUfOvmtibe08Ea1iCh4"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_publications":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户出版物/Get user publications","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户出版物\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n\n### 返回:\n- 用户出版物列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user publications\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n\n### Returns:\n- User publications list data\n\n# [示例/Example]\nurn = \"ACoAAB8rG_UB7cstjC__gk5318uYsZOIVkyysi4\"\npage = 1","operationId":"get_user_publications_api_v1_linkedin_web_get_user_publications_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAAB8rG_UB7cstjC__gk5318uYsZOIVkyysi4"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_certifications":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户认证/Get user certifications","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户认证\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n\n### 返回:\n- 用户认证列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user certifications\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n\n### Returns:\n- User certifications list data\n\n# [示例/Example]\nurn = \"ACoAAARpiwIBp_SzoeHPlUfOvmtibe08Ea1iCh4\"\npage = 1","operationId":"get_user_certifications_api_v1_linkedin_web_get_user_certifications_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAAARpiwIBp_SzoeHPlUfOvmtibe08Ea1iCh4"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_honors":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户荣誉奖项/Get user honors","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户荣誉奖项\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n\n### 返回:\n- 用户荣誉奖项列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user honors and awards\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n\n### Returns:\n- User honors list data\n\n# [示例/Example]\nurn = \"ACoAAC41xVEBx77koDz3k1eJ5E9t8UZ7g0IVGj4\"\npage = 1","operationId":"get_user_honors_api_v1_linkedin_web_get_user_honors_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAAC41xVEBx77koDz3k1eJ5E9t8UZ7g0IVGj4"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_interests_groups":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户感兴趣的群组/Get user interests groups","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户感兴趣的群组\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n\n### 返回:\n- 用户感兴趣的群组列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user interests - groups\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n\n### Returns:\n- User interests groups list data\n\n# [示例/Example]\nurn = \"ACoAAAjpjWIBMh1iBR4OgSPK5GXetlQ6dYUT-qo\"\npage = 1","operationId":"get_user_interests_groups_api_v1_linkedin_web_get_user_interests_groups_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAAAjpjWIBMh1iBR4OgSPK5GXetlQ6dYUT-qo"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_user_interests_companies":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取用户感兴趣的公司/Get user interests companies","description":"# [中文]\n### 用途:\n- 获取LinkedIn用户感兴趣的公司\n\n### 参数:\n- urn: 用户URN（必填），可通过get_user_profile接口获取\n- page: 页码（可选），默认为1\n\n### 返回:\n- 用户感兴趣的公司列表数据\n\n# [English]\n### Purpose:\n- Get LinkedIn user interests - companies\n\n### Parameters:\n- urn: User URN (required), can be obtained from get_user_profile endpoint\n- page: Page number (optional), default is 1\n\n### Returns:\n- User interests companies list data\n\n# [示例/Example]\nurn = \"ACoAAEDH77YBEVIYXAaEwTicp5CcB_hR7DfFL9o\"\npage = 1","operationId":"get_user_interests_companies_api_v1_linkedin_web_get_user_interests_companies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"urn","in":"query","required":true,"schema":{"type":"string","description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","title":"Urn"},"description":"用户URN，可通过get_user_profile接口获取/User URN, can be obtained from get_user_profile endpoint","example":"ACoAAEDH77YBEVIYXAaEwTicp5CcB_hR7DfFL9o"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/get_job_detail":{"get":{"tags":["LinkedIn-Web-API"],"summary":"获取职位详情/Get job detail","description":"# [中文]\n### 用途:\n- 获取LinkedIn职位详情\n\n### 参数:\n- job_id: 职位ID（必填）\n- include_skills: 包含职位技能要求（可选，额外消耗1次请求）\n\n### 返回:\n- 职位详情数据\n\n# [English]\n### Purpose:\n- Get LinkedIn job detail\n\n### Parameters:\n- job_id: Job ID (required)\n- include_skills: Include job skills (optional, +1 request)\n\n### Returns:\n- Job detail data\n\n# [示例/Example]\njob_id = \"4172815660\"","operationId":"get_job_detail_api_v1_linkedin_web_get_job_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"job_id","in":"query","required":true,"schema":{"type":"string","description":"职位ID/Job ID","title":"Job Id"},"description":"职位ID/Job ID","example":"4172815660"},{"name":"include_skills","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"包含职位技能要求（额外消耗1次请求）/Include job skills (+1 request)","title":"Include Skills"},"description":"包含职位技能要求（额外消耗1次请求）/Include job skills (+1 request)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/search_jobs":{"get":{"tags":["LinkedIn-Web-API"],"summary":"搜索职位/Search jobs","description":"# [中文]\n### 用途:\n- 搜索LinkedIn职位\n\n### 参数:\n- keyword: 搜索关键词（必填）\n- page: 页码（可选），默认为1\n- sort_by: 排序方式（可选）：recent(最新), relevant(相关)\n- date_posted: 发布时间过滤（可选）：anytime, past_month, past_week, past_24_hours\n- geocode: 地理位置代码（可选）\n- company: 公司ID过滤（可选）\n- experience_level: 经验级别（可选）：internship, entry_level, associate, mid_senior, director, executive\n- remote: 工作地点类型（可选）：onsite, remote, hybrid\n- job_type: 工作类型（可选）：full_time, part_time, contract, temporary, volunteer, internship, other\n- easy_apply: 是否易申请（可选）\n- has_verifications: 是否有公司认证（可选）\n- under_10_applicants: 是否少于10个申请者（可选）\n- fair_chance_employer: 是否公平机会雇主（可选）\n\n### 返回:\n- 职位搜索结果列表数据\n\n# [English]\n### Purpose:\n- Search LinkedIn jobs\n\n### Parameters:\n- keyword: Search keyword (required)\n- page: Page number (optional), default is 1\n- sort_by: Sort by (optional): recent, relevant\n- date_posted: Date posted filter (optional): anytime, past_month, past_week, past_24_hours\n- geocode: Geocode for location (optional)\n- company: Company ID filter (optional)\n- experience_level: Experience level (optional): internship, entry_level, associate, mid_senior, director, executive\n- remote: Remote filter (optional): onsite, remote, hybrid\n- job_type: Job type (optional): full_time, part_time, contract, temporary, volunteer, internship, other\n- easy_apply: Easy apply filter (optional)\n- has_verifications: Has verifications filter (optional)\n- under_10_applicants: Under 10 applicants filter (optional)\n- fair_chance_employer: Fair chance employer filter (optional)\n\n### Returns:\n- Job search results list data\n\n# [示例/Example]\nkeyword = \"backend\"\npage = 1","operationId":"search_jobs_api_v1_linkedin_web_search_jobs_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"backend"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"排序方式：recent(最新)或relevant(相关)/Sort by: recent or relevant","title":"Sort By"},"description":"排序方式：recent(最新)或relevant(相关)/Sort by: recent or relevant"},{"name":"date_posted","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"发布时间过滤：anytime, past_month, past_week, past_24_hours","title":"Date Posted"},"description":"发布时间过滤：anytime, past_month, past_week, past_24_hours"},{"name":"geocode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"地理位置代码，可通过Search Geocode Location获取/Geocode for location","title":"Geocode"},"description":"地理位置代码，可通过Search Geocode Location获取/Geocode for location","example":"103644278"},{"name":"company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"公司ID过滤/Company ID filter (e.g., 1441 for Google)","title":"Company"},"description":"公司ID过滤/Company ID filter (e.g., 1441 for Google)","example":"1441"},{"name":"experience_level","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"经验级别：internship, entry_level, associate, mid_senior, director, executive","title":"Experience Level"},"description":"经验级别：internship, entry_level, associate, mid_senior, director, executive"},{"name":"remote","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"工作地点类型：onsite, remote, hybrid","title":"Remote"},"description":"工作地点类型：onsite, remote, hybrid"},{"name":"job_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"工作类型：full_time, part_time, contract, temporary, volunteer, internship, other","title":"Job Type"},"description":"工作类型：full_time, part_time, contract, temporary, volunteer, internship, other"},{"name":"easy_apply","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"是否易申请/Filter easy apply jobs","title":"Easy Apply"},"description":"是否易申请/Filter easy apply jobs"},{"name":"has_verifications","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"是否有公司认证/Filter jobs with company verifications","title":"Has Verifications"},"description":"是否有公司认证/Filter jobs with company verifications"},{"name":"under_10_applicants","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"是否少于10个申请者/Filter jobs with under 10 applicants","title":"Under 10 Applicants"},"description":"是否少于10个申请者/Filter jobs with under 10 applicants"},{"name":"fair_chance_employer","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"是否公平机会雇主/Filter fair chance employer jobs","title":"Fair Chance Employer"},"description":"是否公平机会雇主/Filter fair chance employer jobs"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/linkedin/web/search_people":{"get":{"tags":["LinkedIn-Web-API"],"summary":"搜索用户/Search people","description":"# [中文]\n### 用途:\n- 搜索LinkedIn用户\n\n### 参数:\n- name: 搜索关键词（可选）\n- first_name: 名（可选）\n- last_name: 姓（可选）\n- title: 职位（可选）\n- company: 公司（可选）\n- school: 学校（可选）\n- page: 页码（可选），默认为1\n- geocode_location: 地理位置代码（可选）\n- current_company: 当前公司ID（可选）\n- profile_language: 个人资料语言（可选）\n- industry: 行业ID（可选）\n- service_category: 服务类别ID（可选）\n\n### 返回:\n- 用户搜索结果列表数据\n\n# [English]\n### Purpose:\n- Search LinkedIn people\n\n### Parameters:\n- name: Search keyword (optional)\n- first_name: First name (optional)\n- last_name: Last name (optional)\n- title: Title (optional)\n- company: Company (optional)\n- school: School (optional)\n- page: Page number (optional), default is 1\n- geocode_location: Geocode for location (optional)\n- current_company: Current company ID (optional)\n- profile_language: Profile language (optional)\n- industry: Industry ID (optional)\n- service_category: Service category ID (optional)\n\n### Returns:\n- People search results list data\n\n# [示例/Example]\nname = \"john\"\nfirst_name = \"john\"\nlast_name = \"oliver\"\ntitle = \"manager\"\npage = 1","operationId":"search_people_api_v1_linkedin_web_search_people_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"搜索关键词/Search keyword for people","title":"Name"},"description":"搜索关键词/Search keyword for people","example":"john"},{"name":"first_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"名/First name","title":"First Name"},"description":"名/First name","example":"john"},{"name":"last_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"姓/Last name","title":"Last Name"},"description":"姓/Last name","example":"oliver"},{"name":"title","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"职位/Title","title":"Title"},"description":"职位/Title","example":"manager"},{"name":"company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"公司/Company","title":"Company"},"description":"公司/Company"},{"name":"school","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"学校/School","title":"School"},"description":"学校/School"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number","example":1},{"name":"geocode_location","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"地理位置代码/Geocode for location (e.g., 103644278 for United States)","title":"Geocode Location"},"description":"地理位置代码/Geocode for location (e.g., 103644278 for United States)","example":"103644278"},{"name":"current_company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"当前公司ID/Current company ID","title":"Current Company"},"description":"当前公司ID/Current company ID"},{"name":"profile_language","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"个人资料语言/Profile language","title":"Profile Language"},"description":"个人资料语言/Profile language"},{"name":"industry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"行业ID/Industry ID","title":"Industry"},"description":"行业ID/Industry ID"},{"name":"service_category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"服务类别ID/Service category ID","title":"Service Category"},"description":"服务类别ID/Service category ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_one_video":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取单个视频详情信息/Get single video data","description":"# [中文]\n### 用途:\n- 获取单个视频详情信息\n### 参数:\n- bv_id: 作品id\n### 返回:\n- 视频详情信息\n\n# [English]\n### Purpose:\n- Get single video data\n### Parameters:\n- bv_id: Video id\n### Return:\n- Video data\n\n# [示例/Example]\nbv_id = \"BV1M1421t7hT\"","operationId":"fetch_one_video_api_v1_bilibili_web_fetch_one_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"bv_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Bv Id"},"description":"作品id/Video id","example":"BV1M1421t7hT"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_one_video_v2":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取单个视频详情信息V2/Get single video data V2","description":"# [中文]\n### 用途:\n- 获取单个视频详情信息V2\n### 参数:\n- a_id: 作品id\n- c_id: 作品cid\n### 返回:\n- 视频详情信息V2\n\n# [English]\n### Purpose:\n- Get single video data V2\n### Parameters:\n- a_id: Video id\n- c_id: Video cid\n### Return:\n- Video data V2\n\n# [示例/Example]\na_id = \"114006081739452\"\nc_id = \"28400484458\"","operationId":"fetch_one_video_v2_api_v1_bilibili_web_fetch_one_video_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"a_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"A Id"},"description":"作品id/Video id","example":"114006081739452"},{"name":"c_id","in":"query","required":true,"schema":{"type":"string","description":"作品cid/Video cid","title":"C Id"},"description":"作品cid/Video cid","example":"28400484458"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_one_video_v3":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取单个视频详情信息V3/Get single video data V3","description":"# [中文]\n### 用途:\n- 获取单个视频详情信息V3\n### 参数:\n- url: 视频链接\n### 返回:\n- 视频详情信息V3\n\n# [English]\n### Purpose:\n- Get single video data V3\n### Parameters:\n- url: Video URL\n### Return:\n- Video data V3\n\n# [示例/Example]\nurl = \"https://www.bilibili.com/video/BV1S5uKzzE4r\"","operationId":"fetch_one_video_v3_api_v1_bilibili_web_fetch_one_video_v3_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"视频链接/Video URL","title":"Url"},"description":"视频链接/Video URL","example":"https://www.bilibili.com/video/BV1S5uKzzE4r"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_video_detail":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取单个视频详情/Get single video detail","description":"# [中文]\n### 用途:\n- 获取单个视频详情\n### 参数:\n- aid: 作品id\n### 返回:\n- 视频详情\n\n# [English]\n### Purpose:\n- Get single video detail\n### Parameters:\n- aid: Video id\n### Return:\n- Video detail\n\n# [示例/Example]\naid = \"114902186396822\"","operationId":"fetch_video_detail_api_v1_bilibili_web_fetch_video_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"aid","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Aid"},"description":"作品id/Video id","example":"114902186396822"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_video_play_info":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取单个视频播放信息/Get single video play info","description":"# [中文]\n### 用途:\n- 获取单个视频播放信息\n### 参数:\n- url: 视频链接\n### 返回:\n- 视频播放信息\n\n# [English]\n### Purpose:\n- Get single video play info\n### Parameters:\n- url: Video URL\n### Return:\n- Video data\n\n# [示例/Example]\nurl = \"https://www.bilibili.com/video/BV1S5uKzzE4r\"","operationId":"fetch_video_play_info_api_v1_bilibili_web_fetch_video_play_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","description":"视频链接/Video URL","title":"Url"},"description":"视频链接/Video URL","example":"https://www.bilibili.com/video/BV1S5uKzzE4r"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_video_subtitle":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取视频字幕信息/Get video subtitle info","description":"# [中文]\n### 用途:\n- 获取视频字幕信息\n### 参数:\n- a_id: 作品id\n- c_id: 作品cid\n### 返回:\n- 视频字幕信息\n\n# [English]\n### Purpose:\n- Get video subtitle info\n### Parameters:\n- a_id: Video id\n- c_id: Video cid\n### Return:\n- Video subtitle info\n\n# [示例/Example]\na_id = \"114006081739452\"\nc_id = \"28400484458\"","operationId":"fetch_video_subtitle_api_v1_bilibili_web_fetch_video_subtitle_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"a_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"A Id"},"description":"作品id/Video id","example":"114006081739452"},{"name":"c_id","in":"query","required":true,"schema":{"type":"string","description":"作品cid/Video cid","title":"C Id"},"description":"作品cid/Video cid","example":"28400484458"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_hot_search":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取热门搜索信息/Get hot search data","description":"# [中文]\n### 用途:\n- 获取热门搜索信息\n### 参数:\n- limit: 返回数量\n### 返回:\n- 热门搜索信息\n### 说明:\n- limit默认为10，上限为50\n\n# [English]\n### Purpose:\n- Get hot search data\n### Parameters:\n- limit: Return number\n### Return:\n- Hot search data\n### Note:\n- limit default is 10, maximum is 50\n\n# [示例/Example]\nlimit = 10","operationId":"fetch_hot_search_api_v1_bilibili_web_fetch_hot_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"limit","in":"query","required":true,"schema":{"description":"返回数量/Return number","title":"Limit"},"description":"返回数量/Return number","example":10}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_general_search":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取综合搜索信息/Get general search data","description":"# [中文]\n### 用途:\n- 获取综合搜索信息\n### 参数:\n- keyword: 搜索关键词\n- order: 排序方式\n    - totalrank 综合排序\n    - click 最多播放\n    - pubdate 最新发布\n    - dm 最多弹幕\n    - stow 最多收藏\n- page: 页码\n- page_size: 每页数量\n- duration: 时长筛选\n    - 0 全部时长\n    - 1 10分钟以下\n    - 2 10-30分钟\n    - 3 30分钟-60分钟\n    - 4 60分钟以上\n- pubtime_begin_s: 开始日期，10位时间戳，需要小于结束日期\n- pubtime_end_s: 结束日期，10位时间戳，需要大于开始日期\n### 返回:\n- 综合搜索信息\n\n# [English]\n### Purpose:\n- Get general search data\n### Parameters:\n- keyword: Search keyword\n- order: Order method\n    - totalrank Comprehensive sorting\n    - click Most played\n    - pubdate Latest release\n    - dm Most barrage\n    - stow Most collection\n- page: Page number\n- page_size: Number per page\n- duration: Duration filter\n    - 0 All durations\n    - 1 Under 10 minutes\n    - 2 10-30 minutes\n    - 3 30-60 minutes\n    - 4 Over 60 minutes\n- pubtime_begin_s: Start date, 10-digit timestamp, must be less than end date\n- pubtime_end_s: End date, 10-digit timestamp, must be greater than start date\n### Return:\n- General search data\n\n# [示例/Example]\nkeyword = \"火影忍者\"\norder = \"totalrank\"\npage = 1\npage_size = 42\nduration = 0\npubtime_begin_s = 0\npubtime_end_s = 0","operationId":"fetch_general_search_api_v1_bilibili_web_fetch_general_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"火影忍者"},{"name":"order","in":"query","required":true,"schema":{"type":"string","description":"排序方式/Order method","title":"Order"},"description":"排序方式/Order method","example":"totalrank"},{"name":"page","in":"query","required":true,"schema":{"type":"integer","description":"页码/Page number","title":"Page"},"description":"页码/Page number","example":1},{"name":"page_size","in":"query","required":true,"schema":{"type":"integer","description":"每页数量/Number per page","title":"Page Size"},"description":"每页数量/Number per page","example":42},{"name":"duration","in":"query","required":false,"schema":{"type":"integer","description":"时长筛选/Duration filter","default":0,"title":"Duration"},"description":"时长筛选/Duration filter"},{"name":"pubtime_begin_s","in":"query","required":false,"schema":{"type":"integer","description":"开始日期/Start date (10-digit timestamp)","default":0,"title":"Pubtime Begin S"},"description":"开始日期/Start date (10-digit timestamp)"},{"name":"pubtime_end_s","in":"query","required":false,"schema":{"type":"integer","description":"结束日期/End date (10-digit timestamp)","default":0,"title":"Pubtime End S"},"description":"结束日期/End date (10-digit timestamp)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_video_playurl":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取视频流地址/Get video playurl","description":"# [中文]\n### 用途:\n- 获取视频流地址\n### 参数:\n- bv_id: 作品id\n- cid: 作品cid\n### 返回:\n- 视频流地址\n\n# [English]\n### Purpose:\n- Get video playurl\n### Parameters:\n- bv_id: Video id\n- cid: Video cid\n### Return:\n- Video playurl\n\n# [示例/Example]\nbv_id = \"BV1y7411Q7Eq\"\ncid = \"171776208\"","operationId":"fetch_one_video_api_v1_bilibili_web_fetch_video_playurl_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"bv_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Bv Id"},"description":"作品id/Video id","example":"BV1y7411Q7Eq"},{"name":"cid","in":"query","required":true,"schema":{"type":"string","description":"作品cid/Video cid","title":"Cid"},"description":"作品cid/Video cid","example":"171776208"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_vip_video_playurl":{"post":{"tags":["Bilibili-Web-API"],"summary":"获取大会员清晰度视频流地址/Get VIP video playurl","description":"# [中文]\n### 用途:\n- 获取大会员清晰度视频流地址\n### 参数:\n- bv_id: 作品id\n- cid: 作品cid\n- cookie: 大会员用户Cookie\n### 返回:\n- 大会员清晰度视频流地址\n\n# [English]\n### Purpose:\n- Get VIP video playurl\n### Parameters:\n- bv_id: Video id\n- cid: Video cid\n- cookie: VIP User Cookie\n### Return:\n- VIP video playurl\n\n# [示例/Example]\nbv_id = \"BV1y7411Q7Eq\"\ncid = \"171776208\"\ncookie = \"your_vip_bilibili_cookie\"","operationId":"fetch_vip_video_playurl_api_v1_bilibili_web_fetch_vip_video_playurl_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VIPVideoModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/bilibili/web/fetch_user_post_videos":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取用户主页作品数据/Get user homepage video data","description":"# [中文]\n### 用途:\n- 获取用户发布的视频数据\n### 参数:\n- uid: 用户UID\n- pn: 页码\n- order: 排序方式\n    - pubdate 最新发布\n    - click 最多播放\n    - stow 最多收藏\n### 返回:\n- 用户发布的视频数据\n\n# [English]\n### Purpose:\n- Get user post video data\n### Parameters:\n- uid: User UID\n- pn: Page number\n- order: Order method\n    - pubdate Latest release\n    - click Most played\n    - stow Most collection\n### Return:\n- User posted video data\n\n# [示例/Example]\nuid = \"178360345\"\npn = 1\norder = \"pubdate\"","operationId":"fetch_user_post_videos_api_v1_bilibili_web_fetch_user_post_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户UID","title":"Uid"},"description":"用户UID","example":"178360345"},{"name":"pn","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Pn"},"description":"页码/Page number"},{"name":"order","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Order method","default":"pubdate","title":"Order"},"description":"排序方式/Order method"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_collect_folders":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取用户所有收藏夹信息/Get user collection folders","description":"# [中文]\n### 用途:\n- 获取用户收藏作品数据\n### 参数:\n- uid: 用户UID\n### 返回:\n- 用户收藏夹信息\n\n# [English]\n### Purpose:\n- Get user collection folders\n### Parameters:\n- uid: User UID\n### Return:\n- user collection folders\n\n# [示例/Example]\nuid = \"178360345\"","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_collect_folders_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户UID","title":"Uid"},"description":"用户UID","example":"178360345"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_user_collection_videos":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取指定收藏夹内视频数据/Gets video data from a collection folder","description":"# [中文]\n### 用途:\n- 获取指定收藏夹内视频数据\n### 参数:\n- folder_id: 用户UID\n- pn: 页码\n### 返回:\n- 指定收藏夹内视频数据\n\n# [English]\n### Purpose:\n- Gets video data from a collection folder\n### Parameters:\n- folder_id: collection folder id\n- pn: Page number\n### Return:\n- video data from collection folder\n\n# [示例/Example]\nfolder_id = \"1756059545\"\npn = 1","operationId":"fetch_user_collection_videos_api_v1_bilibili_web_fetch_user_collection_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"folder_id","in":"query","required":true,"schema":{"type":"string","description":"收藏夹id/collection folder id","title":"Folder Id"},"description":"收藏夹id/collection folder id","example":"1756059545"},{"name":"pn","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Pn"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_user_profile":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取指定用户的信息/Get information of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户的信息\n### 参数:\n- uid: 用户UID\n### 返回:\n- 指定用户的个人信息\n\n# [English]\n### Purpose:\n- Get information of specified user\n### Parameters:\n- uid: User UID\n### Return:\n- information of specified user\n\n# [示例/Example]\nuid = \"178360345\"","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户UID","title":"Uid"},"description":"用户UID","example":"178360345"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_user_up_stat":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取UP主状态统计/Get UP stat (total likes and views)","description":"# [中文]\n### 用途:\n- 获取UP主状态统计信息（总获赞数、总播放数）\n### 参数:\n- uid: 用户UID\n### 返回:\n- UP主状态统计数据\n    - archive: 视频相关统计\n        - view: 总播放数\n    - likes: 总获赞数\n\n# [English]\n### Purpose:\n- Get UP stat (total likes and total views)\n### Parameters:\n- uid: User UID\n### Return:\n- UP stat data\n    - archive: Video statistics\n        - view: Total views\n    - likes: Total likes\n\n# [示例/Example]\nuid = \"178360345\"","operationId":"fetch_user_up_stat_api_v1_bilibili_web_fetch_user_up_stat_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户UID/User UID","title":"Uid"},"description":"用户UID/User UID","example":"178360345"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_user_relation_stat":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取用户关系状态统计/Get user relation stat (following and followers)","description":"# [中文]\n### 用途:\n- 获取用户关系状态统计信息（关注数、粉丝数）\n### 参数:\n- uid: 用户UID\n### 返回:\n- 用户关系状态统计数据\n    - following: 关注数\n    - follower: 粉丝数\n\n# [English]\n### Purpose:\n- Get user relation stat (following count and follower count)\n### Parameters:\n- uid: User UID\n### Return:\n- User relation stat data\n    - following: Following count\n    - follower: Follower count\n\n# [示例/Example]\nuid = \"178360345\"","operationId":"fetch_user_relation_stat_api_v1_bilibili_web_fetch_user_relation_stat_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户UID/User UID","title":"Uid"},"description":"用户UID/User UID","example":"178360345"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_com_popular":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取综合热门视频信息/Get comprehensive popular video information","description":"# [中文]\n### 用途:\n- 获取综合热门视频信息\n### 参数:\n- pn: 页码\n### 返回:\n- 综合热门视频信息\n\n# [English]\n### Purpose:\n- Get comprehensive popular video information\n### Parameters:\n- pn: Page number\n### Return:\n- comprehensive popular video information\n\n# [示例/Example]\npn = 1","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_com_popular_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"pn","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Pn"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_video_comments":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取指定视频的评论/Get comments on the specified video","description":"# [中文]\n### 用途:\n- 获取指定视频的评论\n### 参数:\n- bv_id: 作品id\n- pn: 页码\n### 返回:\n- 指定视频的评论数据\n\n# [English]\n### Purpose:\n- Get comments on the specified video\n### Parameters:\n- bv_id: Video id\n- pn: Page number\n### Return:\n- comments of the specified video\n\n# [示例/Example]\nbv_id = \"BV1M1421t7hT\"\npn = 1","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_video_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"bv_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Bv Id"},"description":"作品id/Video id","example":"BV1M1421t7hT"},{"name":"pn","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Pn"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_comment_reply":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取视频下指定评论的回复/Get reply to the specified comment","description":"# [中文]\n### 用途:\n- 获取视频下指定评论的回复\n### 参数:\n- bv_id: 作品id\n- pn: 页码\n- rpid: 回复id\n### 返回:\n- 指定评论的回复数据\n\n# [English]\n### Purpose:\n- Get reply to the specified comment\n### Parameters:\n- bv_id: Video id\n- pn: Page number\n- rpid: Reply id\n### Return:\n- Reply of the specified comment\n\n# [示例/Example]\nbv_id = \"BV1M1421t7hT\"\npn = 1\nrpid = \"237109455120\"","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_comment_reply_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"bv_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Bv Id"},"description":"作品id/Video id","example":"BV1M1421t7hT"},{"name":"pn","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Pn"},"description":"页码/Page number"},{"name":"rpid","in":"query","required":true,"schema":{"type":"string","description":"回复id/Reply id","title":"Rpid"},"description":"回复id/Reply id","example":"237109455120"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_user_dynamic":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取指定用户动态/Get dynamic information of specified user","description":"# [中文]\n### 用途:\n- 获取指定用户动态\n### 参数:\n- uid: 用户UID\n- offset: 开始索引\n### 返回:\n- 指定用户动态数据\n\n# [English]\n### Purpose:\n- Get dynamic information of specified user\n### Parameters:\n- uid: User UID\n- offset: offset\n### Return:\n- dynamic information of specified user\n\n# [示例/Example]\nuid = \"178360345\"\noffset = \"953154282154098691\"","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_user_dynamic_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"uid","in":"query","required":true,"schema":{"type":"string","description":"用户UID","title":"Uid"},"description":"用户UID","example":"16015678"},{"name":"offset","in":"query","required":false,"schema":{"type":"string","description":"开始索引/offset","default":"","title":"Offset"},"description":"开始索引/offset","example":"953154282154098691"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_dynamic_detail":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取动态详情/Get dynamic detail","description":"# [中文]\n### 用途:\n- 获取指定动态的详情信息（v1接口）\n### 参数:\n- dynamic_id: 动态id\n### 返回:\n- 动态详情数据\n\n# [English]\n### Purpose:\n- Get detail information of specified dynamic (v1 API)\n### Parameters:\n- dynamic_id: Dynamic id\n### Return:\n- Dynamic detail data\n\n# [示例/Example]\ndynamic_id = \"1172584638000922630\"","operationId":"fetch_dynamic_detail_api_v1_bilibili_web_fetch_dynamic_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"dynamic_id","in":"query","required":true,"schema":{"type":"string","description":"动态id/Dynamic id","title":"Dynamic Id"},"description":"动态id/Dynamic id","example":"1172584638000922630"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_dynamic_detail_v2":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取动态详情v2/Get dynamic detail v2","description":"# [中文]\n### 用途:\n- 获取指定动态的详情信息（v2接口）\n### 参数:\n- dynamic_id: 动态id\n### 返回:\n- 动态详情数据\n\n# [English]\n### Purpose:\n- Get detail information of specified dynamic (v2 API)\n### Parameters:\n- dynamic_id: Dynamic id\n### Return:\n- Dynamic detail data\n\n# [示例/Example]\ndynamic_id = \"1172584638000922630\"","operationId":"fetch_dynamic_detail_v2_api_v1_bilibili_web_fetch_dynamic_detail_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"dynamic_id","in":"query","required":true,"schema":{"type":"string","description":"动态id/Dynamic id","title":"Dynamic Id"},"description":"动态id/Dynamic id","example":"1172584638000922630"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_video_danmaku":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取视频实时弹幕/Get Video Danmaku","description":"# [中文]\n### 用途:\n- 获取视频实时弹幕\n### 参数:\n- cid: 作品cid\n### 返回:\n- 视频实时弹幕\n\n# [English]\n### Purpose:\n- Get Video Danmaku\n### Parameters:\n- cid: Video cid\n### Return:\n- Video Danmaku\n\n# [示例/Example]\ncid = \"1639235405\"","operationId":"fetch_one_video_api_v1_bilibili_web_fetch_video_danmaku_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cid","in":"query","required":true,"schema":{"type":"string","description":"作品cid/Video cid","title":"Cid"},"description":"作品cid/Video cid","example":"1639235405"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_live_room_detail":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取指定直播间信息/Get information of specified live room","description":"# [中文]\n### 用途:\n- 获取指定直播间信息\n### 参数:\n- room_id: 直播间ID\n### 返回:\n- 指定直播间信息\n\n# [English]\n### Purpose:\n- Get information of specified live room\n### Parameters:\n- room_id: Live room ID\n### Return:\n- information of specified live room\n\n# [示例/Example]\nroom_id = \"22816111\"","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_live_room_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间ID/Live room ID","title":"Room Id"},"description":"直播间ID/Live room ID","example":"22816111"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_live_videos":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取直播间视频流/Get live video data of specified room","description":"# [中文]\n### 用途:\n- 获取指定直播间视频流\n### 参数:\n- room_id: 直播间ID\n### 返回:\n- 指定直播间视频流\n\n# [English]\n### Purpose:\n- Get live video data of specified room\n### Parameters:\n- room_id: Live room ID\n### Return:\n- live video data of specified room\n\n# [示例/Example]\nroom_id = \"1815229528\"","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_live_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"room_id","in":"query","required":true,"schema":{"type":"string","description":"直播间ID/Live room ID","title":"Room Id"},"description":"直播间ID/Live room ID","example":"1815229528"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_live_streamers":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取指定分区正在直播的主播/Get live streamers of specified live area","description":"# [中文]\n### 用途:\n- 获取指定分区正在直播的主播\n### 参数:\n- area_id: 直播分区id\n- pn: 页码\n### 返回:\n- 指定分区正在直播的主播\n\n# [English]\n### Purpose:\n- Get live streamers of specified live area\n### Parameters:\n- area_id: Live area ID\n- pn: Page number\n### Return:\n- live streamers of specified live area\n\n# [示例/Example]\narea_id = \"9\"\npn = 1","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_live_streamers_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"area_id","in":"query","required":true,"schema":{"type":"string","description":"直播分区id/Live area ID","title":"Area Id"},"description":"直播分区id/Live area ID","example":"9"},{"name":"pn","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Pn"},"description":"页码/Page number"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_all_live_areas":{"get":{"tags":["Bilibili-Web-API"],"summary":"获取所有直播分区列表/Get a list of all live areas","description":"# [中文]\n### 用途:\n- 获取所有直播分区列表\n### 参数:\n### 返回:\n- 所有直播分区列表\n\n# [English]\n### Purpose:\n- Get a list of all live areas\n### Parameters:\n### Return:\n- list of all live areas\n\n# [示例/Example]","operationId":"fetch_collect_folders_api_v1_bilibili_web_fetch_all_live_areas_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/bilibili/web/bv_to_aid":{"get":{"tags":["Bilibili-Web-API"],"summary":"通过bv号获得视频aid号/Generate aid by bvid","description":"# [中文]\n### 用途:\n- 通过bv号获得视频aid号\n### 参数:\n- bv_id: 作品id\n### 返回:\n- 视频aid号\n\n# [English]\n### Purpose:\n- Generate aid by bvid\n### Parameters:\n- bv_id: Video id\n### Return:\n- Video aid\n\n# [示例/Example]\nbv_id = \"BV1M1421t7hT\"","operationId":"fetch_one_video_api_v1_bilibili_web_bv_to_aid_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"bv_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Bv Id"},"description":"作品id/Video id","example":"BV1M1421t7hT"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_video_parts":{"get":{"tags":["Bilibili-Web-API"],"summary":"通过bv号获得视频分p信息/Get Video Parts By bvid","description":"# [中文]\n### 用途:\n- 通过bv号获得视频分p信息\n### 参数:\n- bv_id: 作品id\n### 返回:\n- 视频分p信息\n\n# [English]\n### Purpose:\n- Get Video Parts By bvid\n### Parameters:\n- bv_id: Video id\n### Return:\n- Video Parts\n\n# [示例/Example]\nbv_id = \"BV1vf421i7hV\"","operationId":"fetch_one_video_api_v1_bilibili_web_fetch_video_parts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"bv_id","in":"query","required":true,"schema":{"type":"string","description":"作品id/Video id","title":"Bv Id"},"description":"作品id/Video id","example":"BV1vf421i7hV"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/web/fetch_get_user_id":{"get":{"tags":["Bilibili-Web-API"],"summary":"提取用户ID/Extract user ID","description":"# [中文]\n### 用途:\n- 提取用户ID\n### 参数:\n- share_link: 用户分享链接\n### 返回:\n- 用户ID\n\n# [English]\n### Purpose:\n- Extract user ID\n### Parameters:\n- share_link: User share link\n### Return:\n- User ID","operationId":"fetch_get_user_id_api_v1_bilibili_web_fetch_get_user_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"share_link","in":"query","required":true,"schema":{"type":"string","description":"用户分享链接/User share link","title":"Share Link"},"description":"用户分享链接/User share link","example":"https://b23.tv/1ZuB5NC"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_one_video":{"get":{"tags":["Bilibili-App-API"],"summary":"获取单个视频详情信息/Get single video data","description":"# [中文]\n### 用途:\n- 获取单个视频详情信息（APP接口）\n### 参数:\n- av_id: AV号（与bv_id二选一）\n- bv_id: BV号（与av_id二选一）\n### 返回:\n- 视频详情信息\n\n# [English]\n### Purpose:\n- Get single video data (APP API)\n### Parameters:\n- av_id: AV ID (choose one of av_id or bv_id)\n- bv_id: BV ID (choose one of av_id or bv_id)\n### Return:\n- Video data\n\n# [示例/Example]\nav_id = \"115568241811221\"\nbv_id = \"BV18SCrBGE9E\"","operationId":"fetch_one_video_api_v1_bilibili_app_fetch_one_video_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"av_id","in":"query","required":false,"schema":{"type":"string","description":"AV号/AV ID","title":"Av Id"},"description":"AV号/AV ID","example":"115568241811221"},{"name":"bv_id","in":"query","required":false,"schema":{"type":"string","description":"BV号/BV ID","title":"Bv Id"},"description":"BV号/BV ID","example":"BV18SCrBGE9E"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_video_comments":{"get":{"tags":["Bilibili-App-API"],"summary":"获取视频评论列表/Get video comments","description":"# [中文]\n### 用途:\n- 获取视频评论列表\n### 参数:\n- av_id: AV号（与bv_id二选一）\n- bv_id: BV号（与av_id二选一）\n- mode: 排序模式（3=热门, 2=时间）\n- next_offset: 分页游标\n### 返回:\n- 评论列表数据\n\n# [English]\n### Purpose:\n- Get video comments\n### Parameters:\n- av_id: AV ID (choose one of av_id or bv_id)\n- bv_id: BV ID (choose one of av_id or bv_id)\n- mode: Sort mode (3=hot, 2=time)\n- next_offset: Pagination cursor\n### Return:\n- Comments data\n\n# [示例/Example]\nbv_id = \"BV18SCrBGE9E\"\nmode = 3\nnext_offset = 1","operationId":"fetch_video_comments_api_v1_bilibili_app_fetch_video_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"av_id","in":"query","required":false,"schema":{"type":"string","description":"AV号/AV ID","title":"Av Id"},"description":"AV号/AV ID","example":"115568241811221"},{"name":"bv_id","in":"query","required":false,"schema":{"type":"string","description":"BV号/BV ID","title":"Bv Id"},"description":"BV号/BV ID","example":"BV18SCrBGE9E"},{"name":"mode","in":"query","required":false,"schema":{"type":"integer","description":"排序模式/Sort mode (3=热门/hot, 2=时间/time)","default":3,"title":"Mode"},"description":"排序模式/Sort mode (3=热门/hot, 2=时间/time)"},{"name":"next_offset","in":"query","required":false,"schema":{"type":"integer","description":"分页游标/Pagination cursor","default":1,"title":"Next Offset"},"description":"分页游标/Pagination cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_reply_detail":{"get":{"tags":["Bilibili-App-API"],"summary":"获取二级评论回复/Get reply detail","description":"# [中文]\n### 用途:\n- 获取二级评论回复\n### 参数:\n- root: 一级评论ID（必填）\n- av_id: AV号（与bv_id二选一）\n- bv_id: BV号（与av_id二选一）\n- next_offset: 下一页游标\n- ps: 每页数量\n### 返回:\n- 二级评论列表数据\n\n# [English]\n### Purpose:\n- Get reply detail (second level comments)\n### Parameters:\n- root: Root comment ID (required)\n- av_id: AV ID (choose one of av_id or bv_id)\n- bv_id: BV ID (choose one of av_id or bv_id)\n- next_offset: Next page cursor\n- ps: Page size\n### Return:\n- Reply data\n\n# [示例/Example]\nroot = \"241743663521\"\nav_id = \"113100682434775\"","operationId":"fetch_reply_detail_api_v1_bilibili_app_fetch_reply_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"root","in":"query","required":true,"schema":{"type":"string","description":"一级评论ID/Root comment ID","title":"Root"},"description":"一级评论ID/Root comment ID","example":"241743663521"},{"name":"av_id","in":"query","required":false,"schema":{"type":"string","description":"AV号/AV ID","title":"Av Id"},"description":"AV号/AV ID","example":"113100682434775"},{"name":"bv_id","in":"query","required":false,"schema":{"type":"string","description":"BV号/BV ID","title":"Bv Id"},"description":"BV号/BV ID","example":"BV18SCrBGE9E"},{"name":"next_offset","in":"query","required":false,"schema":{"type":"integer","description":"下一页游标/Next page cursor","default":0,"title":"Next Offset"},"description":"下一页游标/Next page cursor"},{"name":"ps","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Page size","default":20,"title":"Ps"},"description":"每页数量/Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_user_videos":{"get":{"tags":["Bilibili-App-API"],"summary":"获取用户投稿视频/Get user videos","description":"# [中文]\n### 用途:\n- 获取用户投稿视频列表\n### 参数:\n- user_id: 用户ID（必填）\n- post_filter: 过滤类型（archive=投稿, season=合集, contribute=贡献）\n- page: 页码\n- ps: 每页数量\n### 返回:\n- 用户投稿视频列表\n\n# [English]\n### Purpose:\n- Get user uploaded videos\n### Parameters:\n- user_id: User ID (required)\n- post_filter: Filter type (archive/season/contribute)\n- page: Page number\n- ps: Page size\n### Return:\n- User videos data\n\n# [示例/Example]\nuser_id = \"203680252\"\npost_filter = \"archive\"","operationId":"fetch_user_videos_api_v1_bilibili_app_fetch_user_videos_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"203680252"},{"name":"post_filter","in":"query","required":false,"schema":{"type":"string","description":"过滤类型/Filter type (archive/season/contribute)","default":"archive","title":"Post Filter"},"description":"过滤类型/Filter type (archive/season/contribute)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"ps","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Page size","default":20,"title":"Ps"},"description":"每页数量/Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_user_info":{"get":{"tags":["Bilibili-App-API"],"summary":"获取用户信息/Get user info","description":"# [中文]\n### 用途:\n- 获取用户信息\n### 参数:\n- user_id: 用户ID（必填）\n### 返回:\n- 用户信息（包含粉丝数、关注数、投稿数等）\n\n# [English]\n### Purpose:\n- Get user info\n### Parameters:\n- user_id: User ID (required)\n### Return:\n- User info (including followers, following, videos count, etc.)\n\n# [示例/Example]\nuser_id = \"203680252\"","operationId":"fetch_user_info_api_v1_bilibili_app_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"203680252"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_home_feed":{"get":{"tags":["Bilibili-App-API"],"summary":"获取主页推荐视频流/Get home feed","description":"# [中文]\n### 用途:\n- 获取主页推荐视频流\n### 参数:\n- idx: 页面索引，默认使用当前时间戳\n- flush: 刷新标记（0=普通加载, 1=刷新）\n- pull: 是否下拉刷新\n### 返回:\n- 推荐视频流数据\n\n# [English]\n### Purpose:\n- Get home feed (recommended videos)\n### Parameters:\n- idx: Page index, defaults to current timestamp\n- flush: Flush flag (0=normal load, 1=refresh)\n- pull: Pull to refresh\n### Return:\n- Home feed data","operationId":"fetch_home_feed_api_v1_bilibili_app_fetch_home_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"idx","in":"query","required":false,"schema":{"type":"integer","description":"页面索引/Page index","title":"Idx"},"description":"页面索引/Page index"},{"name":"flush","in":"query","required":false,"schema":{"type":"integer","description":"刷新标记/Flush flag (0=普通加载, 1=刷新)","default":0,"title":"Flush"},"description":"刷新标记/Flush flag (0=普通加载, 1=刷新)"},{"name":"pull","in":"query","required":false,"schema":{"type":"boolean","description":"是否下拉刷新/Pull to refresh","default":true,"title":"Pull"},"description":"是否下拉刷新/Pull to refresh"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_popular_feed":{"get":{"tags":["Bilibili-App-API"],"summary":"获取热门推荐/Get popular feed","description":"# [中文]\n### 用途:\n- 获取热门推荐视频\n### 参数:\n- idx: 页面索引（从1开始）\n- last_param: 上一页最后一个视频的ID（用于分页）\n### 返回:\n- 热门推荐视频数据\n\n# [English]\n### Purpose:\n- Get popular feed\n### Parameters:\n- idx: Page index (starting from 1)\n- last_param: Last video ID from previous page (for pagination)\n### Return:\n- Popular feed data\n\n# [示例/Example]\nidx = 1","operationId":"fetch_popular_feed_api_v1_bilibili_app_fetch_popular_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"idx","in":"query","required":false,"schema":{"type":"integer","description":"页面索引/Page index","default":1,"title":"Idx"},"description":"页面索引/Page index"},{"name":"last_param","in":"query","required":false,"schema":{"type":"string","description":"上一页最后一个视频ID/Last video ID","title":"Last Param"},"description":"上一页最后一个视频ID/Last video ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_search_all":{"get":{"tags":["Bilibili-App-API"],"summary":"综合搜索/search all","description":"# [中文]\n### 用途:\n- 综合搜索（返回所有类型的搜索结果）\n### 参数:\n- keyword: 搜索关键词（必填）\n- page: 页码，从1开始\n- page_size: 每页结果数量\n- order: 排序方式（0=综合排序）\n### 返回:\n- 搜索结果，包含nav（分类导航）、item（搜索结果）、pagination（分页信息）等\n\n# [English]\n### Purpose:\n-  search all (returns all types of search results)\n### Parameters:\n- keyword: Search keyword (required)\n- page: Page number, starting from 1\n- page_size: Results per page\n- order: Sort order (0=comprehensive)\n### Return:\n- Search results including nav (category navigation), item (results), pagination, etc.\n\n# [示例/Example]\nkeyword = \"原神\"\npage = 1\npage_size = 20","operationId":"fetch_search_all_api_v1_bilibili_app_fetch_search_all_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"原神"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Page size","default":20,"title":"Page Size"},"description":"每页数量/Page size"},{"name":"order","in":"query","required":false,"schema":{"type":"integer","description":"排序方式/Sort order (0=综合排序)","default":0,"title":"Order"},"description":"排序方式/Sort order (0=综合排序)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_search_by_type":{"get":{"tags":["Bilibili-App-API"],"summary":"分类搜索/ search by type","description":"# [中文]\n### 用途:\n- 分类搜索（按类型搜索）\n### 参数:\n- keyword: 搜索关键词（必填）\n- search_type: 搜索类型\n    - video: 视频\n    - bangumi: 番剧\n    - pgc: 影视\n    - live: 直播\n    - article: 专栏\n    - user: 用户\n- page: 页码，从1开始\n- page_size: 每页结果数量\n- order: 排序方式\n    - 0: 综合排序\n    - 1: 最新发布\n    - 2: 播放量\n    - 3: 弹幕数\n### 返回:\n- 搜索结果\n\n# [English]\n### Purpose:\n-  search by type\n### Parameters:\n- keyword: Search keyword (required)\n- search_type: Search type\n    - video: Videos\n    - bangumi: Anime\n    - pgc: Movies/TV\n    - live: Live streams\n    - article: Articles\n    - user: Users\n- page: Page number, starting from 1\n- page_size: Results per page\n- order: Sort order\n    - 0: Comprehensive\n    - 1: Latest\n    - 2: Play count\n    - 3: Danmaku count\n### Return:\n- Search results\n\n# [示例/Example]\nkeyword = \"原神\"\nsearch_type = \"video\"","operationId":"fetch_search_by_type_api_v1_bilibili_app_fetch_search_by_type_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search keyword","title":"Keyword"},"description":"搜索关键词/Search keyword","example":"原神"},{"name":"search_type","in":"query","required":false,"schema":{"type":"string","description":"搜索类型/Search type (video/bangumi/pgc/live/article/user)","default":"video","title":"Search Type"},"description":"搜索类型/Search type (video/bangumi/pgc/live/article/user)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"页码/Page number","default":1,"title":"Page"},"description":"页码/Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Page size","default":20,"title":"Page Size"},"description":"每页数量/Page size"},{"name":"order","in":"query","required":false,"schema":{"type":"integer","description":"排序方式/Sort order (0=综合, 1=最新, 2=播放量, 3=弹幕数)","default":0,"title":"Order"},"description":"排序方式/Sort order (0=综合, 1=最新, 2=播放量, 3=弹幕数)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/bilibili/app/fetch_cinema_tab":{"get":{"tags":["Bilibili-App-API"],"summary":"获取影视推荐/Get cinema tab","description":"# [中文]\n### 用途:\n- 获取主页影视推荐\n### 返回:\n- 影视推荐数据\n\n# [English]\n### Purpose:\n- Get cinema tab (movies/TV recommendations)\n### Return:\n- Cinema tab data","operationId":"fetch_cinema_tab_api_v1_bilibili_app_fetch_cinema_tab_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/bilibili/app/fetch_bangumi_tab":{"get":{"tags":["Bilibili-App-API"],"summary":"获取番剧推荐/Get bangumi tab","description":"# [中文]\n### 用途:\n- 获取主页番剧推荐\n### 返回:\n- 番剧推荐数据\n\n# [English]\n### Purpose:\n- Get bangumi tab (anime recommendations)\n### Return:\n- Bangumi tab data","operationId":"fetch_bangumi_tab_api_v1_bilibili_app_fetch_bangumi_tab_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/sora2/get_post_detail":{"get":{"tags":["Sora2-API"],"summary":"获取单一作品详情/Fetch single post detail","description":"# [中文]\n### 用途:\n- 获取 Sora 作品的完整详情信息，包括视频信息、作者信息、统计数据等\n- 支持通过作品 ID 或作品链接查询\n- 可用于数据分析、无水印视频下载等场景\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- post_id: 作品 ID（可选），格式如 `s_68e853d2ad448191b3c81e830f53c3a2`\n- post_url: 作品链接（可选），格式如 `https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2`\n- **注意**: post_id 和 post_url 至少提供一个\n\n### 返回:\n- post: 作品详细信息\n    - id: 作品 ID\n    - text: 作品描述文本\n    - attachments: 附件列表（视频信息）\n        - url: 无水印视频链接\n        - downloadable_url: 有水印视频链接\n        - width/height: 视频尺寸\n        - encodings: 不同质量的编码版本\n    - like_count: 点赞数\n    - view_count: 浏览数\n    - reply_count: 评论数\n    - remix_count: 混剪数\n    - shared_by: 作者用户 ID\n    - posted_at: 发布时间戳\n    - permalink: 作品永久链接\n- profile: 作者信息\n    - user_id: 用户 ID\n    - username: 用户名\n    - display_name: 显示名称\n    - profile_picture_url: 头像链接\n    - follower_count: 粉丝数\n\n# [English]\n### Purpose:\n- Fetch complete details of a Sora post, including video info, author info, and statistics\n- Supports querying by post ID or post URL\n- Can be used for data analysis, watermark-free video downloads, etc.\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- post_id: Post ID (optional), format like `s_68e853d2ad448191b3c81e830f53c3a2`\n- post_url: Post URL (optional), format like `https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2`\n- **Note**: At least one of post_id or post_url must be provided\n\n### Return:\n- post: Post detailed information\n    - id: Post ID\n    - text: Post description text\n    - attachments: Attachment list (video info)\n        - url: No watermark video link\n        - downloadable_url: Watermarked video link\n        - width/height: Video dimensions\n        - encodings: Different quality encoding versions\n    - like_count: Like count\n    - view_count: View count\n    - reply_count: Comment count\n    - remix_count: Remix count\n    - shared_by: Author user ID\n    - posted_at: Post timestamp\n    - permalink: Permanent link\n- profile: Author information\n    - user_id: User ID\n    - username: Username\n    - display_name: Display name\n    - profile_picture_url: Avatar URL\n    - follower_count: Follower count\n\n# [示例/Example]\n```python\n# 使用作品 ID 查询\npost_id = \"s_68e853d2ad448191b3c81e830f53c3a2\"\n\n# 或使用作品链接查询\npost_url = \"https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2\"\n```","operationId":"get_post_detail_api_v1_sora2_get_post_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":false,"schema":{"type":"string","description":"作品ID（可选）/Post ID (optional)","default":"","title":"Post Id"},"description":"作品ID（可选）/Post ID (optional)","example":"s_68e853d2ad448191b3c81e830f53c3a2"},{"name":"post_url","in":"query","required":false,"schema":{"type":"string","description":"作品链接（可选）/Post URL (optional)","default":"","title":"Post Url"},"description":"作品链接（可选）/Post URL (optional)","example":"https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_post_remix_list":{"get":{"tags":["Sora2-API"],"summary":"获取作品的 Remix 列表/Fetch post remix list","description":"# [中文]\n### 用途:\n- 获取 Sora 作品的 Remix 列表\n- 支持通过作品 ID 或作品链接查询\n- 支持分页获取更多 Remix 作品\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- post_id: 作品 ID（可选），格式如 `s_68e466aa780c8191b`\n- post_url: 作品链接（可选），格式如 `https://sora.chatgpt.com/p/s_68e466aa780c8191b2357907ce7d1a39`\n- cursor: 翻页参数（可选），从上一次响应的 cursor 字段获取\n- **注意**: post_id 和 post_url 至少提供一个\n\n### 返回:\n- items: Remix 作品列表\n    - id: 作品 ID\n    - text: 作品描述文本\n    - attachments: 附件列表（视频信息）\n    - like_count: 点赞数\n    - view_count: 浏览数\n    - reply_count: 评论数\n    - remix_count: 混剪数\n    - shared_by: 作者用户 ID\n    - posted_at: 发布时间戳\n- cursor: 下一页参数，用于获取更多数据（如果为 null 表示已到末页）\n\n# [English]\n### Purpose:\n- Fetch the Remix list of a Sora post\n- Supports querying by post ID or post URL\n- Supports pagination to get more Remix posts\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- post_id: Post ID (optional), format like `s_68e466aa780c8191b`\n- post_url: Post URL (optional), format like `https://sora.chatgpt.com/p/s_68e466aa780c8191b2357907ce7d1a39`\n- cursor: Cursor for pagination (optional), obtained from the cursor field of the previous response\n- **Note**: At least one of post_id or post_url must be provided\n\n### Return:\n- items: Remix post list\n    - id: Post ID\n    - text: Post description text\n    - attachments: Attachment list (video info)\n    - like_count: Like count\n    - view_count: View count\n    - reply_count: Comment count\n    - remix_count: Remix count\n    - shared_by: Author user ID\n    - posted_at: Post timestamp\n- cursor: Next page parameter for fetching more data (null means last page)\n\n# [示例/Example]\n```python\n# 使用作品 ID 查询第一页\npost_id = \"s_68e466aa780c8191b\"\n\n# 使用 cursor 获取下一页\ncursor = \"eyJsYXN0X3Bvc3RfaWQiOiJzXzY4ZTQ2NmFhNzgwYzgxOTFiIn0=\"\n```","operationId":"get_post_remix_list_api_v1_sora2_get_post_remix_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":false,"schema":{"type":"string","description":"作品ID（可选）/Post ID (optional)","default":"","title":"Post Id"},"description":"作品ID（可选）/Post ID (optional)","example":"s_690acc0f4fcc8191ab5a75a96b6b6caf"},{"name":"post_url","in":"query","required":false,"schema":{"type":"string","description":"作品链接（可选）/Post URL (optional)","default":"","title":"Post Url"},"description":"作品链接（可选）/Post URL (optional)","example":"https://sora.chatgpt.com/p/s_690acc0f4fcc8191ab5a75a96b6b6caf"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数（可选）/Cursor for pagination (optional)","default":"","title":"Cursor"},"description":"翻页参数（可选）/Cursor for pagination (optional)","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_video_download_info":{"get":{"tags":["Sora2-API"],"summary":"获取无水印视频下载信息/Fetch none watermark video download info","description":"# [中文]\n### 用途:\n- 获取 Sora 作品的简化下载信息，专为视频下载场景优化\n- 直接返回无水印视频链接和关键信息，无需解析复杂的完整数据\n- 适合需要快速下载视频的场景\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- post_id: 作品 ID（可选），格式如 `s_68e853d2ad448191b3c81e830f53c3a2`\n- post_url: 作品链接（可选），格式如 `https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2`\n- **注意**: post_id 和 post_url 至少提供一个\n\n### 返回:\n- post_id: 作品 ID\n- title: 作品描述文本\n- video: 视频信息\n    - no_watermark: 无水印视频链接（原始质量）\n    - watermark: 有水印视频链接\n    - width: 视频宽度\n    - height: 视频高度\n    - thumbnail: 缩略图链接\n    - preview_gif: 预览 GIF 链接\n    - medium_quality: 中等质量视频链接\n- author: 作者信息\n    - user_id: 用户 ID\n    - username: 用户名\n    - display_name: 显示名称\n    - avatar: 头像链接\n- stats: 统计数据\n    - like_count: 点赞数\n    - view_count: 浏览数\n    - comment_count: 评论数\n    - remix_count: 混剪数\n- permalink: 作品永久链接\n- created_at: 创建时间戳\n\n# [English]\n### Purpose:\n- Get simplified download information for Sora posts, optimized for video download scenarios\n- Directly returns watermark-free video links and key information without parsing complex full data\n- Suitable for quick video download scenarios\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- post_id: Post ID (optional), format like `s_68e853d2ad448191b3c81e830f53c3a2`\n- post_url: Post URL (optional), format like `https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2`\n- **Note**: At least one of post_id or post_url must be provided\n\n### Return:\n- post_id: Post ID\n- title: Post description text\n- video: Video information\n    - no_watermark: No watermark video link (original quality)\n    - watermark: Watermarked video link\n    - width: Video width\n    - height: Video height\n    - thumbnail: Thumbnail link\n    - preview_gif: Preview GIF link\n    - medium_quality: Medium quality video link\n- author: Author information\n    - user_id: User ID\n    - username: Username\n    - display_name: Display name\n    - avatar: Avatar URL\n- stats: Statistics\n    - like_count: Like count\n    - view_count: View count\n    - comment_count: Comment count\n    - remix_count: Remix count\n- permalink: Permanent link\n- created_at: Creation timestamp\n\n# [示例/Example]\n```python\n# 使用作品 ID 查询\npost_id = \"s_68e853d2ad448191b3c81e830f53c3a2\"\n\n# 返回示例\n{\n    \"video\": {\n        \"no_watermark\": \"https://cdn.openai.com/...\",  # 直接下载此链接\n        \"thumbnail\": \"https://cdn.openai.com/...\",\n        \"width\": 1920,\n        \"height\": 1080\n    },\n    \"title\": \"Amazing Sora video\",\n    \"author\": {\"username\": \"creator123\"}\n}\n```","operationId":"get_video_download_info_api_v1_sora2_get_video_download_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":false,"schema":{"type":"string","description":"作品ID（可选）/Post ID (optional)","default":"","title":"Post Id"},"description":"作品ID（可选）/Post ID (optional)","example":"s_68e853d2ad448191b3c81e830f53c3a2"},{"name":"post_url","in":"query","required":false,"schema":{"type":"string","description":"作品链接（可选）/Post URL (optional)","default":"","title":"Post Url"},"description":"作品链接（可选）/Post URL (optional)","example":"https://sora.chatgpt.com/p/s_68e853d2ad448191b3c81e830f53c3a2"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_post_comments":{"get":{"tags":["Sora2-API"],"summary":"获取作品一级评论/Fetch post comments","description":"# [中文]\n### 用途:\n- 获取 Sora 作品的一级评论列表（顶层评论）\n- 支持分页加载，每页返回 10 条评论\n- 可用于评论展示、数据分析等场景\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- post_id: 作品 ID，必填\n- cursor: 翻页参数（可选），首次请求留空，后续请求使用上一次响应中的 cursor 值\n\n### 返回:\n- children: 评论数据\n    - items: 评论列表（10条/页）\n        - id: 评论 ID\n        - text: 评论文本内容\n        - posted_by: 评论者用户 ID\n        - posted_at: 评论时间戳\n        - like_count: 点赞数\n        - reply_count: 回复数（二级评论数）\n        - profile: 评论者信息\n            - username: 用户名\n            - display_name: 显示名称\n            - profile_picture_url: 头像链接\n    - cursor: 下一页参数（用于获取更多评论，无更多时为 null）\n    - has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Fetch first-level comments (top-level comments) for a Sora post\n- Supports pagination, returns 10 comments per page\n- Can be used for comment display, data analysis, etc.\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- post_id: Post ID, required\n- cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests\n\n### Return:\n- children: Comment data\n    - items: Comment list (10 items/page)\n        - id: Comment ID\n        - text: Comment text content\n        - posted_by: Commenter user ID\n        - posted_at: Comment timestamp\n        - like_count: Like count\n        - reply_count: Reply count (second-level comments)\n        - profile: Commenter information\n            - username: Username\n            - display_name: Display name\n            - profile_picture_url: Avatar URL\n    - cursor: Next page cursor (for loading more comments, null when no more)\n    - has_more: Whether there are more data\n\n# [示例/Example]\n```python\n# 第一次请求（获取前 10 条评论）\npost_id = \"s_68e647d78e5081918cdeaf27e7edc735\"\ncursor = \"\"  # 首次请求留空\n\n# 第二次请求（获取下一页）\n# 使用上一次响应中的 cursor 值\ncursor = \"eyJwb3N0X2lkIjoiNjhlNjQ3ZDc4ZTUwODE5MThjZGVhZjI3ZTdlZGM3MzUi...\"\n```","operationId":"get_post_comments_api_v1_sora2_get_post_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":true,"schema":{"type":"string","description":"作品ID/Post ID","title":"Post Id"},"description":"作品ID/Post ID","example":"s_68e647d78e5081918cdeaf27e7edc735"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","default":"","title":"Cursor"},"description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_comment_replies":{"get":{"tags":["Sora2-API"],"summary":"获取评论的回复/Fetch comment replies","description":"# [中文]\n### 用途:\n- 获取一级评论的回复列表（二级评论）\n- 支持分页加载，每页返回 10 条回复\n- 用于展示评论的完整对话树\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- comment_id: 一级评论的 ID，必填（可从 get_post_comments 接口的返回中获取）\n- cursor: 翻页参数（可选），首次请求留空，后续请求使用上一次响应中的 cursor 值\n\n### 返回:\n- children: 回复数据\n    - items: 回复列表（10条/页）\n        - id: 回复 ID\n        - text: 回复文本内容\n        - posted_by: 回复者用户 ID\n        - posted_at: 回复时间戳\n        - like_count: 点赞数\n        - profile: 回复者信息\n            - username: 用户名\n            - display_name: 显示名称\n            - profile_picture_url: 头像链接\n    - cursor: 下一页参数（用于获取更多回复，无更多时为 null）\n    - has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Fetch replies for a first-level comment (second-level comments)\n- Supports pagination, returns 10 replies per page\n- Used to display complete comment conversation tree\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- comment_id: First-level comment ID, required (can be obtained from get_post_comments response)\n- cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests\n\n### Return:\n- children: Reply data\n    - items: Reply list (10 items/page)\n        - id: Reply ID\n        - text: Reply text content\n        - posted_by: Replier user ID\n        - posted_at: Reply timestamp\n        - like_count: Like count\n        - profile: Replier information\n            - username: Username\n            - display_name: Display name\n            - profile_picture_url: Avatar URL\n    - cursor: Next page cursor (for loading more replies, null when no more)\n    - has_more: Whether there are more data\n\n# [示例/Example]\n```python\n# 首先获取一级评论\n# post_comments = get_post_comments(\"s_68e647d78e5081918cdeaf27e7edc735\")\n# comment_id = post_comments['children']['items'][0]['id']  # 第一条评论的 ID\n\n# 然后获取该评论的回复\ncomment_id = \"68e659c5a37081919618c57baf499d0c\"\ncursor = \"\"  # 首次请求留空\n```","operationId":"get_comment_replies_api_v1_sora2_get_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"comment_id","in":"query","required":true,"schema":{"type":"string","description":"一级评论ID/First-level comment ID","title":"Comment Id"},"description":"一级评论ID/First-level comment ID","example":"68e659c5a37081919618c57baf499d0c"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","default":"","title":"Cursor"},"description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_user_profile":{"get":{"tags":["Sora2-API"],"summary":"获取用户信息档案/Fetch user profile","description":"# [中文]\n### 用途:\n- 获取 Sora 用户的个人信息档案\n- 包含用户基本信息、统计数据、社交关系等\n- 可用于用户资料展示、数据分析等场景\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- user_id: 用户 ID，必填，格式如 `user-xiCyLclE6KJcdTXyvVq3Ontc`\n\n### 返回:\n- profile: 用户信息\n    - user_id: 用户 ID\n    - username: 用户名\n    - display_name: 显示名称\n    - bio: 个人简介\n    - profile_picture_url: 头像链接\n    - banner_image_url: 横幅图片链接\n    - follower_count: 粉丝数\n    - following_count: 关注数\n    - post_count: 作品数\n    - like_count: 获赞总数\n    - view_count: 浏览总数\n    - is_verified: 是否认证用户\n    - created_at: 账号创建时间戳\n    - social_links: 社交媒体链接（如有）\n\n# [English]\n### Purpose:\n- Fetch Sora user's profile information\n- Includes user basic info, statistics, social relationships, etc.\n- Can be used for user profile display, data analysis, etc.\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- user_id: User ID, required, format like `user-xiCyLclE6KJcdTXyvVq3Ontc`\n\n### Return:\n- profile: User information\n    - user_id: User ID\n    - username: Username\n    - display_name: Display name\n    - bio: Biography\n    - profile_picture_url: Avatar URL\n    - banner_image_url: Banner image URL\n    - follower_count: Follower count\n    - following_count: Following count\n    - post_count: Post count\n    - like_count: Total likes received\n    - view_count: Total views\n    - is_verified: Whether verified user\n    - created_at: Account creation timestamp\n    - social_links: Social media links (if any)\n\n# [示例/Example]\n```python\n# 获取用户信息\nuser_id = \"user-xiCyLclE6KJcdTXyvVq3Ontc\"\n\n# 返回示例\n{\n    \"profile\": {\n        \"username\": \"creator123\",\n        \"display_name\": \"Amazing Creator\",\n        \"follower_count\": 12500,\n        \"post_count\": 45\n    }\n}\n```","operationId":"get_user_profile_api_v1_sora2_get_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"user-xiCyLclE6KJcdTXyvVq3Ontc"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_user_posts":{"get":{"tags":["Sora2-API"],"summary":"获取用户发布的帖子列表/Fetch user posts","description":"# [中文]\n### 用途:\n- 获取 Sora 用户发布的作品列表\n- 支持分页加载，每页返回 30 条作品\n- 可用于用户主页展示、作品数据采集等场景\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- user_id: 用户 ID，必填\n- cursor: 翻页参数（可选），首次请求留空，后续请求使用上一次响应中的 cursor 值\n\n### 返回:\n- items: 作品列表（30条/页）\n    - post: 作品信息\n        - id: 作品 ID\n        - text: 作品描述\n        - attachments: 视频附件信息\n        - like_count: 点赞数\n        - view_count: 浏览数\n        - reply_count: 评论数\n        - posted_at: 发布时间戳\n    - profile: 作者信息\n- cursor: 下一页参数（用于获取更多作品，无更多时为 null）\n- has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Fetch list of posts published by a Sora user\n- Supports pagination, returns 30 posts per page\n- Can be used for user homepage display, post data collection, etc.\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- user_id: User ID, required\n- cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests\n\n### Return:\n- items: Post list (30 items/page)\n    - post: Post information\n        - id: Post ID\n        - text: Post description\n        - attachments: Video attachment info\n        - like_count: Like count\n        - view_count: View count\n        - reply_count: Comment count\n        - posted_at: Post timestamp\n    - profile: Author information\n- cursor: Next page cursor (for loading more posts, null when no more)\n- has_more: Whether there are more data\n\n# [示例/Example]\n```python\n# 第一次请求（获取前 30 条作品）\nuser_id = \"user-xiCyLclE6KJcdTXyvVq3Ontc\"\ncursor = \"\"  # 首次请求留空\n\n# 第二次请求（获取下一页）\ncursor = \"eyJ1c2VyX2lkIjoidXNlci14aUN5TGNsRTZLSmNkVFh5dlZxM09udGMi...\"\n```","operationId":"get_user_posts_api_v1_sora2_get_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"user-xiCyLclE6KJcdTXyvVq3Ontc"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","default":"","title":"Cursor"},"description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_cameo_leaderboard":{"get":{"tags":["Sora2-API"],"summary":"获取 Cameo 出镜秀达人排行榜/Fetch Cameo leaderboard","description":"# [中文]\n### 用途:\n- 获取 Sora Cameo 出镜秀达人排行榜\n- 展示在 Cameo 功能中被使用最多的用户\n- 支持分页获取更多排行榜数据\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- cursor: 翻页参数（可选），从上一次响应的 cursor 字段获取，每页返回 10 个用户\n\n### 返回:\n- items: 用户排行榜列表（每页 10 个用户）\n    - user_id: 用户 ID\n    - username: 用户名\n    - display_name: 显示名称\n    - profile_picture_url: 头像链接\n    - follower_count: 粉丝数\n    - cameo_count: 被使用次数\n- cursor: 下一页参数，用于获取更多数据（如果为 null 表示已到末页）\n\n# [English]\n### Purpose:\n- Fetch Sora Cameo leaderboard\n- Shows the most featured users in the Cameo function\n- Supports pagination to get more leaderboard data\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- cursor: Cursor for pagination (optional), obtained from the cursor field of the previous response, returns 10 users per page\n\n### Return:\n- items: User leaderboard list (10 users per page)\n    - user_id: User ID\n    - username: Username\n    - display_name: Display name\n    - profile_picture_url: Profile picture URL\n    - follower_count: Follower count\n    - cameo_count: Feature count\n- cursor: Next page parameter for fetching more data (null means last page)\n\n# [示例/Example]\n```python\n# 获取第一页排行榜\n# Get first page of leaderboard\nresponse = await get_cameo_leaderboard()\n\n# 使用 cursor 获取下一页\n# Use cursor to get next page\ncursor = response['cursor']\nnext_page = await get_cameo_leaderboard(cursor=cursor)\n```","operationId":"get_cameo_leaderboard_api_v1_sora2_get_cameo_leaderboard_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数（可选）/Cursor for pagination (optional)","default":"","title":"Cursor"},"description":"翻页参数（可选）/Cursor for pagination (optional)","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_user_cameo_appearances":{"get":{"tags":["Sora2-API"],"summary":"获取用户Cameo出镜秀列表/Fetch user cameo appearances","description":"# [中文]\n### 用途:\n- 获取 Sora 用户的 Cameo 出镜秀列表\n- Cameo 出镜秀指该用户在其他创作者作品中的出镜视频\n- 支持分页加载，每页返回 30 条记录\n- 可用于展示用户的协作作品、出镜记录等\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- user_id: 用户 ID，必填\n- cursor: 翻页参数（可选），首次请求留空，后续请求使用上一次响应中的 cursor 值\n\n### 返回:\n- items: Cameo 出镜秀列表（30条/页）\n    - post: 作品信息（该用户出镜的作品）\n        - id: 作品 ID\n        - text: 作品描述\n        - attachments: 视频附件信息\n        - like_count: 点赞数\n        - view_count: 浏览数\n        - shared_by: 原创作者 ID\n        - posted_at: 发布时间戳\n    - profile: 原创作者信息\n- cursor: 下一页参数（用于获取更多记录，无更多时为 null）\n- has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Fetch Sora user's Cameo appearance list\n- Cameo appearances refer to videos where the user appears in other creators' works\n- Supports pagination, returns 30 records per page\n- Can be used to display user's collaborative works, appearance records, etc.\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- user_id: User ID, required\n- cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests\n\n### Return:\n- items: Cameo appearance list (30 items/page)\n    - post: Post information (works where the user appears)\n        - id: Post ID\n        - text: Post description\n        - attachments: Video attachment info\n        - like_count: Like count\n        - view_count: View count\n        - shared_by: Original creator ID\n        - posted_at: Post timestamp\n    - profile: Original creator information\n- cursor: Next page cursor (for loading more records, null when no more)\n- has_more: Whether there are more data\n\n# [示例/Example]\n```python\n# 获取用户的 Cameo 出镜秀\nuser_id = \"user-xiCyLclE6KJcdTXyvVq3Ontc\"\ncursor = \"\"  # 首次请求留空\n\n# 返回该用户在其他人作品中的出镜记录\n```","operationId":"get_user_cameo_appearances_api_v1_sora2_get_user_cameo_appearances_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"user-xiCyLclE6KJcdTXyvVq3Ontc"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","default":"","title":"Cursor"},"description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_user_followers":{"get":{"tags":["Sora2-API"],"summary":"获取用户粉丝列表/Fetch user followers","description":"# [中文]\n### 用途:\n- 获取 Sora 用户的粉丝列表\n- 支持分页加载，每页返回 50 个粉丝\n- 可用于粉丝关系分析、社交网络研究等场景\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- user_id: 用户 ID，必填\n- cursor: 翻页参数（可选），首次请求留空，后续请求使用上一次响应中的 cursor 值\n\n### 返回:\n- items: 粉丝列表（50个/页）\n    - user_id: 粉丝用户 ID\n    - username: 粉丝用户名\n    - display_name: 粉丝显示名称\n    - profile_picture_url: 粉丝头像链接\n    - follower_count: 粉丝的粉丝数\n    - following_count: 粉丝的关注数\n    - bio: 粉丝个人简介\n    - is_verified: 是否认证用户\n- cursor: 下一页参数（用于获取更多粉丝，无更多时为 null）\n- has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Fetch Sora user's follower list\n- Supports pagination, returns 50 followers per page\n- Can be used for follower relationship analysis, social network research, etc.\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- user_id: User ID, required\n- cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests\n\n### Return:\n- items: Follower list (50 items/page)\n    - user_id: Follower user ID\n    - username: Follower username\n    - display_name: Follower display name\n    - profile_picture_url: Follower avatar URL\n    - follower_count: Follower's follower count\n    - following_count: Follower's following count\n    - bio: Follower biography\n    - is_verified: Whether verified user\n- cursor: Next page cursor (for loading more followers, null when no more)\n- has_more: Whether there are more data\n\n# [示例/Example]\n```python\n# 第一次请求（获取前 50 个粉丝）\nuser_id = \"user-xiCyLclE6KJcdTXyvVq3Ontc\"\ncursor = \"\"  # 首次请求留空\n\n# 第二次请求（获取下一页）\ncursor = \"eyJ1c2VyX2lkIjoidXNlci14aUN5TGNsRTZLSmNkVFh5dlZxM09udGMi...\"\n```","operationId":"get_user_followers_api_v1_sora2_get_user_followers_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"user-xiCyLclE6KJcdTXyvVq3Ontc"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","default":"","title":"Cursor"},"description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_user_following":{"get":{"tags":["Sora2-API"],"summary":"获取用户关注列表/Fetch user following","description":"# [中文]\n### 用途:\n- 获取 Sora 用户的关注列表（用户关注的其他人）\n- 支持分页加载，每页返回 50 个关注对象\n- 可用于关注关系分析、推荐算法等场景\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- user_id: 用户 ID，必填\n- cursor: 翻页参数（可选），首次请求留空，后续请求使用上一次响应中的 cursor 值\n\n### 返回:\n- items: 关注列表（50个/页）\n    - user_id: 被关注用户 ID\n    - username: 被关注用户名\n    - display_name: 被关注用户显示名称\n    - profile_picture_url: 被关注用户头像链接\n    - follower_count: 被关注用户的粉丝数\n    - following_count: 被关注用户的关注数\n    - bio: 被关注用户个人简介\n    - is_verified: 是否认证用户\n- cursor: 下一页参数（用于获取更多关注，无更多时为 null）\n- has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Fetch Sora user's following list (users that the user follows)\n- Supports pagination, returns 50 following per page\n- Can be used for following relationship analysis, recommendation algorithms, etc.\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- user_id: User ID, required\n- cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests\n\n### Return:\n- items: Following list (50 items/page)\n    - user_id: Followed user ID\n    - username: Followed username\n    - display_name: Followed display name\n    - profile_picture_url: Followed avatar URL\n    - follower_count: Followed user's follower count\n    - following_count: Followed user's following count\n    - bio: Followed user biography\n    - is_verified: Whether verified user\n- cursor: Next page cursor (for loading more following, null when no more)\n- has_more: Whether there are more data\n\n# [示例/Example]\n```python\n# 第一次请求（获取前 50 个关注）\nuser_id = \"user-BOXD64QrAyZVybLCeXTqJWm3\"\ncursor = \"\"  # 首次请求留空\n\n# 第二次请求（获取下一页）\ncursor = \"eyJ1c2VyX2lkIjoidXNlci1CT1hENjRRckF5WlZ5YkxDZVhUcUpXbTMi...\"\n```","operationId":"get_user_following_api_v1_sora2_get_user_following_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"user-BOXD64QrAyZVybLCeXTqJWm3"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","default":"","title":"Cursor"},"description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","example":""}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_feed":{"get":{"tags":["Sora2-API"],"summary":"获取Feed流（热门/推荐视频）/Fetch feed","description":"# [中文]\n### 用途:\n- 获取 Sora 的 Feed 流（热门或推荐视频列表）\n- 默认返回过去 7 天的热门视频\n- 支持分页加载，每页返回约 15 条视频\n- 可通过 eager_views 参数提供观看记录来获得个性化推荐\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- cursor: 翻页参数（可选），首次请求留空，后续请求使用上一次响应中的 cursor 值\n- eager_views: 观看记录（可选），JSON 字符串格式\n    - 默认值：`{\"views\":[]}`（空观看记录，返回通用热门）\n    - 包含观看记录示例：`{\"views\":[{\"id\":\"s_xxx\",\"watch_time\":0.24,\"dwell_time\":3.94}]}`\n    - 提供观看记录可获得更个性化的推荐结果\n\n### 返回:\n- items: 视频列表（约15条/页）\n    - post: 作品信息\n        - id: 作品 ID\n        - text: 作品描述\n        - attachments: 视频附件信息\n        - like_count: 点赞数\n        - view_count: 浏览数\n        - reply_count: 评论数\n        - posted_at: 发布时间戳\n    - profile: 作者信息\n- cursor: 下一页参数（用于获取更多视频，无更多时为 null）\n- has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Fetch Sora's feed stream (trending or recommended video list)\n- Returns trending videos from the past 7 days by default\n- Supports pagination, returns approximately 15 videos per page\n- Can provide watch history via eager_views parameter for personalized recommendations\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- cursor: Pagination cursor (optional), leave empty for first request, use cursor from previous response for subsequent requests\n- eager_views: Watch history (optional), JSON string format\n    - Default value: `{\"views\":[]}` (empty watch history, returns general trending)\n    - With watch history example: `{\"views\":[{\"id\":\"s_xxx\",\"watch_time\":0.24,\"dwell_time\":3.94}]}`\n    - Providing watch history enables more personalized recommendation results\n\n### Return:\n- items: Video list (approx. 15 items/page)\n    - post: Post information\n        - id: Post ID\n        - text: Post description\n        - attachments: Video attachment info\n        - like_count: Like count\n        - view_count: View count\n        - reply_count: Comment count\n        - posted_at: Post timestamp\n    - profile: Author information\n- cursor: Next page cursor (for loading more videos, null when no more)\n- has_more: Whether there are more data\n\n# [示例/Example]\n```python\n# 第一次请求（获取热门视频，无观看记录）\ncursor = \"\"\neager_views = '{\"views\":[]}'\n\n# 第二次请求（带观看记录，获得个性化推荐）\neager_views = '{\"views\":[{\"id\":\"s_68e853d2ad448191b3c81e830f53c3a2\",\"watch_time\":0.24,\"dwell_time\":3.94}]}'\n\n# 第三次请求（获取下一页）\ncursor = \"eyJjdXQiOiJuZjJfdG9wXzdkIiwibGltaXQiOjE1LCJvZmZzZXQiOjE1fQ==\"\n```","operationId":"get_feed_api_v1_sora2_get_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","default":"","title":"Cursor"},"description":"翻页参数，从上一次响应中获取/Pagination cursor from previous response","example":""},{"name":"eager_views","in":"query","required":false,"schema":{"type":"string","description":"观看记录JSON字符串（可选），用于个性化推荐/Watch history JSON string (optional), for personalized recommendations","default":"","title":"Eager Views"},"description":"观看记录JSON字符串（可选），用于个性化推荐/Watch history JSON string (optional), for personalized recommendations","example":"{\"views\":[]}"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/search_users":{"get":{"tags":["Sora2-API"],"summary":"搜索用户/Search users","description":"# [中文]\n### 用途:\n- 搜索 Sora 用户（主要用于 @ 提及功能）\n- 根据用户名关键词搜索匹配的用户\n- 返回用户信息和提及 Token（用于在评论中 @ 用户）\n- 注意：实际返回结果可能超过 20 个，比预期的更多\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- username: 搜索关键词，必填，支持部分匹配\n\n### 返回:\n- items: 用户搜索结果列表\n    - profile: 用户信息\n        - user_id: 用户 ID\n        - username: 用户名\n        - display_name: 显示名称\n        - profile_picture_url: 头像链接\n        - follower_count: 粉丝数\n        - following_count: 关注数\n        - bio: 个人简介\n        - is_verified: 是否认证用户\n    - token: 提及 Token（用于 @ 提及功能）\n        - 格式：`<@user-xxxxxxxx>`\n        - 在评论中使用此 Token 可以提及该用户\n\n# [English]\n### Purpose:\n- Search Sora users (mainly for @ mention functionality)\n- Search for matching users based on username keywords\n- Returns user information and mention tokens (for @mentioning users in comments)\n- Note: Actual results may exceed 20 users, more than expected\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- username: Search keyword, required, supports partial matching\n\n### Return:\n- items: User search result list\n    - profile: User information\n        - user_id: User ID\n        - username: Username\n        - display_name: Display name\n        - profile_picture_url: Avatar URL\n        - follower_count: Follower count\n        - following_count: Following count\n        - bio: Biography\n        - is_verified: Whether verified user\n    - token: Mention token (for @ mention functionality)\n        - Format: `<@user-xxxxxxxx>`\n        - Use this token in comments to mention the user\n\n# [示例/Example]\n```python\n# 搜索用户名包含 \"sam\" 的用户\nusername = \"sam\"\n\n# 返回示例\n{\n    \"items\": [\n        {\n            \"profile\": {\n                \"username\": \"samuel\",\n                \"display_name\": \"Samuel Creator\",\n                \"follower_count\": 20000\n            },\n            \"token\": \"<@user-abc123xyz>\"\n        },\n        {\n            \"profile\": {\n                \"username\": \"samantha\",\n                \"display_name\": \"Samantha Artist\"\n            },\n            \"token\": \"<@user-def456uvw>\"\n        }\n    ]\n}\n\n# 在评论中使用 token 提及用户\n# comment_text = \"Great work <@user-abc123xyz>!\"\n```","operationId":"search_users_api_v1_sora2_search_users_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词（用户名）/Search keyword (username)","title":"Username"},"description":"搜索关键词（用户名）/Search keyword (username)","example":"sam"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/upload_image":{"post":{"tags":["Sora2-API"],"summary":"上传图片获取media_id/Upload image to get media_id","description":"# [中文]\n### 用途:\n- 上传图片到 Sora 服务器获取 media_id\n- 获取的 media_id 可用于后续的 AI 视频生成功能\n- 支持 PNG、JPG、JPEG 格式的图片文件\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.001 美元 （防止恶意请求）\n- 速率限制：每秒最多请求 1 次（1 request/second）\n- 如果请求过快可能会被限流，建议间隔至少 1 秒\n\n### 参数说明:\n- **file** (必填): 图片文件\n  - 支持格式: PNG, JPG, JPEG\n  - 文件大小: 最大 10MB\n\n### 返回数据:\n- **id**: Media ID（用于视频生成）\n- **url**: 图片访问链接\n- **kind**: 资源类型（通常为 \"image\"）\n- **width**: 图片宽度（像素）\n- **height**: 图片高度（像素）\n- **file_name**: 文件名\n\n### 注意事项:\n- 上传的图片会存储在服务器上\n- 返回的 media_id 有效期通常为 24 小时\n- 建议在获取 media_id 后及时使用\n- 文件名会自动清理特殊字符以确保安全\n\n---\n\n# [English]\n### Purpose:\n- Upload image to Sora server to get media_id\n- The obtained media_id can be used for subsequent AI video generation\n- Supports PNG, JPG, JPEG format image files\n\n### Pricing:\n- This API costs $0.001 per request (to prevent abuse requests)\n- Rate limit: Maximum 1 request per second\n- If requests are too frequent, you may be rate limited; it is recommended to wait at least 1 second between requests\n\n### Parameters:\n- **file** (required): Image file\n  - Supported formats: PNG, JPG, JPEG\n  - File size: Maximum 10MB\n\n### Response Data:\n- **id**: Media ID (for video generation)\n- **url**: Image access link\n- **kind**: Resource type (usually \"image\")\n- **width**: Image width (pixels)\n- **height**: Image height (pixels)\n- **file_name**: File name\n\n### Notes:\n- Uploaded images are stored on the server\n- The returned media_id is usually valid for 24 hours\n- Recommend using media_id promptly after obtaining\n- File names are automatically sanitized for security\n\n---\n\n# [示例/Example]\n```python\n{\n   \"id\":\"media_01k7edmn2ge988d9x6g5zg1hhw\",\n   \"type\":\"image\",\n   \"created_at\":\"2025-10-13T09:15:20.063403Z\",\n   \"filename\":\"20760448.jpeg\",\n   \"extension\":\"jpeg\",\n   \"mime_type\":\"image/jpeg\",\n   \"url\":\"https://videos.openai.com/vg-assets/assets%2Fclient_upload%2Fmedia%2F084bcb820761572154494edb38c9ff2b4a3254fd%2Fmedia_01k7edmn2ge988d9x6g5zg1hhw.jpeg?se=2025-10-13T10%3A15%3A20Z&sp=r&sv=2024-08-04&sr=b&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skt=2025-10-13T08%3A24%3A12Z&ske=2025-10-13T12%3A29%3A12Z&sks=b&skv=2024-08-04&sig=3xnRz6u%2BJcO3Db7EAvDXkw08xDttCc5xSvvL2k2nEN8%3D&az=oaivgprodscus\",\n   \"width\":460,\n   \"height\":460,\n   \"duration_sec\":null,\n   \"n_frames\":1,\n   \"size_bytes\":51902,\n   \"thumbnail_url\":\"https://videos.openai.com/vg-assets/assets%2Fclient_upload%2Fmedia%2F084bcb820761572154494edb38c9ff2b4a3254fd%2Fmedia_01k7edmn2ge988d9x6g5zg1hhw.jpg?se=2025-10-13T10%3A15%3A20Z&sp=r&sv=2024-08-04&sr=b&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skt=2025-10-13T08%3A24%3A12Z&ske=2025-10-13T12%3A29%3A12Z&sks=b&skv=2024-08-04&sig=chcnDmB%2BKipH%2BOAPHQGmZv8zCldny/U0HDtsvjuZoqA%3D&az=oaivgprodscus\"\n}\n```","operationId":"upload_image_api_v1_sora2_upload_image_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_image_api_v1_sora2_upload_image_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/sora2/create_video":{"post":{"tags":["Sora2-API"],"summary":"[已弃用/Deprecated] 文本/图片生成视频/Create video from text or image","description":"# [中文]\n## ⚠️ 此接口已弃用。AI 相关接口已迁移至独立的 TikHub AI API 服务，与 TikHub 社交媒体 API 分离部署。请访问：https://ai.tikhub.io\n### 用途:\n- 通过文本描述生成 Sora 视频（支持纯文本生成或图片+文本生成）\n- 支持两种生成模式：\n    - **纯文本生成**：AI 根据文本描述自动生成视频内容\n    - **图生视频**：基于上传的图片和文本描述生成视频（需要先调用 upload_image 接口）\n- 支持两种视频比例：\n    - **portrait（竖屏）**: 9:16 比例，适合移动端、社交媒体短视频\n    - **landscape（横屏）**: 16:9 比例，适合桌面端、宽屏展示、电影风格\n- 返回生成任务 ID，需要通过其他接口查询生成进度和结果\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 **$0.1 美元**\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数\n\n### 参数:\n- **prompt** (必填): 视频描述文本，最多 2000 字符\n    - 描述要生成的视频内容、场景、动作、情节等\n    - 建议使用清晰、具体的描述以获得更好的生成效果\n    - 示例：\"A cat is playing Minecraft\"\n- **orientation** (可选): 视频方向，默认为 portrait（竖屏）\n    - `portrait`: 竖屏（9:16 比例）\n    - `landscape`: 横屏（16:9 比例）\n- **media_id** (可选): 图片 media_id，用于图生视频\n    - 通过 `/upload_image` 接口上传图片后获取\n    - 格式：`media_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n    - 如果不提供，则为纯文本生成视频\n\n### 返回:\n- **id**: 视频生成任务 ID\n    - 格式：`task_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n    - 使用此 ID 可以查询生成进度和获取最终视频\n- **priority**: 任务优先级\n    - 通常为 1（标准优先级）\n\n### 注意:\n- 这是一个异步生成任务，不会立即返回视频\n- 视频生成通常需要几分钟时间\n- 需要使用任务 ID 通过其他接口轮询查询生成状态\n- 请自行保留任务 ID，以便后续查询，否则将无法获取生成结果\n\n# [English]\n## ⚠️ This endpoint has been deprecated. AI-related endpoints have been migrated to a dedicated TikHub AI API service, which operates separately from the TikHub Social Media API. Please visit: https://ai.tikhub.io\n### Purpose:\n- Generate Sora video from text description (supports text-only or image+text generation)\n- Supports two generation modes:\n    - **Text-only generation**: AI automatically generates video content based on text description\n    - **Image-to-video**: Generate video based on uploaded image and text description (requires calling upload_image endpoint first)\n- Supports two video ratios:\n    - **portrait**: 9:16 ratio, suitable for mobile devices, social media short videos\n    - **landscape**: 16:9 ratio, suitable for desktop viewing, widescreen display, cinematic style\n- Returns generation task ID, need to query generation progress and results through other endpoints\n\n### Pricing:\n- This API costs **$0.1 USD per request**\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard\n\n### Parameters:\n- **prompt** (required): Video description text, maximum 2000 characters\n    - Describe the video content, scenes, actions, plots, etc. to be generated\n    - Recommend using clear and specific descriptions for better generation results\n    - Example: \"A cat is playing Minecraft\"\n- **orientation** (optional): Video orientation, defaults to portrait\n    - `portrait`: Portrait (9:16 ratio)\n    - `landscape`: Landscape (16:9 ratio)\n- **media_id** (optional): Image media_id for image-to-video generation\n    - Obtained from `/upload_image` endpoint after uploading an image\n    - Format: `media_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n    - If not provided, text-only video generation will be used\n\n### Return:\n- **id**: Video generation task ID\n    - Format: `task_xxxxxxxxxxxxxxxxxxxxxxxxxx`\n    - Use this ID to query generation progress and get final video\n- **priority**: Task priority\n    - Usually 1 (standard priority)\n\n### Note:\n- This is an asynchronous generation task, will not return video immediately\n- Video generation usually takes several minutes\n- Need to use task ID to poll generation status through other endpoints\n- Please keep the task ID for future queries, otherwise you will not be able to get the generation results\n\n# [示例/Example]\n```python\nimport requests\n\n# 示例 1：纯文本生成竖屏视频/Example 1: Text-only portrait video\nurl = \"https://api.tikhub.io/api/v1/sora2/create_video\"\nheaders = {\"Authorization\": \"Bearer YOUR_API_TOKEN\"}\npayload = {\n    \"prompt\": \"A cat is playing Minecraft\",\n    \"orientation\": \"portrait\"\n}\nresponse = requests.post(url, headers=headers, json=payload)\n\n# 示例 2：图片+文本生成视频（图生视频）/Example 2: Image-to-video generation\n# 步骤1：上传图片获取 media_id/Step 1: Upload image to get media_id\nupload_url = \"https://api.tikhub.io/api/v1/sora2/upload_image\"\nwith open(\"image.png\", \"rb\") as f:\n    files = {\"file\": (\"image.png\", f, \"image/png\")}\n    upload_resp = requests.post(upload_url, headers=headers, files=files)\n    media_id = upload_resp.json()[\"data\"][\"id\"]  # 例如: \"media_01k7...\"\n\n# 步骤2：使用 media_id 生成视频/Step 2: Use media_id to generate video\npayload = {\n    \"prompt\": \"Transform this image into a dynamic video scene\",\n    \"orientation\": \"landscape\",\n    \"media_id\": media_id  # 来自 upload_image 的 media_id\n}\nresponse = requests.post(url, headers=headers, json=payload)\n\n# 返回示例/Return example\n{\n    \"code\": 200,\n    \"data\": {\n        \"id\": \"task_01k7e05chaem08va8sq5qy2een\",\n        \"priority\": 1\n    }\n}\n```","operationId":"create_video_api_v1_sora2_create_video_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVideoRequest","description":"创建视频请求参数/Create video request parameters"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"HTTPBearer":[]}]}},"/api/v1/sora2/get_task_status":{"get":{"tags":["Sora2-API"],"summary":"[已弃用/Deprecated] 查询任务状态/Get task status","description":"# [中文]\n## ⚠️ 此接口已弃用。AI 相关接口已迁移至独立的 TikHub AI API 服务，与 TikHub 社交媒体 API 分离部署。请访问：https://ai.tikhub.io\n### 用途:\n- 查询视频生成任务的当前状态和结果\n- 用于轮询检查视频生成进度\n- 任务完成后可获取生成的视频信息（包括 generation_id）\n- 配合 create_video 接口使用，用于获取异步生成的视频结果\n\n### 收费说明:\n- 本接口完全免费，不消耗任何费用\n- 速率限制：每秒最多请求 1 次（1 request/second）\n- 如果请求过快可能会被限流，建议间隔至少 1 秒\n\n### 参数:\n- task_id: 任务 ID，必填，格式如 `task_01k7dttf0xfx3t7zhhzycjq8e3`\n    - 从 create_video 接口返回的任务 ID\n    - 必须以 'task_' 开头\n\n### 返回:\n- id: 任务 ID\n- status: 任务状态\n    - queued: 排队中\n    - processing: 处理中\n    - succeeded: 已完成\n    - failed: 失败\n- prompt: 视频生成时使用的文本描述\n- title: 视频标题（如果有）\n- progress_pct: 任务进度（0.0-1.0，1.0 表示 100%）\n- generations: 生成结果数组（任务完成后才有）\n    - id: 生成 ID（generation_id，格式：gen_xxxxxx）\n    - kind: 类型（如 sora_draft）\n    - url: 视频链接（有水印）\n    - downloadable_url: 下载链接（有水印）\n    - width: 视频宽度\n    - height: 视频高度\n    - created_at: 创建时间戳\n    - prompt: 生成提示词\n    - encodings: 不同质量的编码版本\n        - source: 源文件\n        - source_wm: 带水印的源文件\n        - thumbnail: 缩略图\n        - md: 中等质量视频\n        - gif: 预览 GIF\n\n### 注意:\n- **速率限制**: 本接口每秒最多请求 1 次，建议轮询间隔设置为 1-2 秒\n- 建议每 1-2 秒轮询一次，直到 status 变为 succeeded 或 failed\n- 只有 status 为 succeeded 时，generations 数组才会包含视频数据\n- **重要**: 本接口返回的视频链接**只包含有水印的版本**\n- **获取无水印视频**: 当任务成功后，需要使用 task_id 或 generation_id 调用 `get_task_detail` 接口才能获取**无水印版本**\n- 从 generations[0].id 可以获取 generation_id，用于后续调用 get_task_detail 接口\n\n# [English]\n## ⚠️ This endpoint has been deprecated. AI-related endpoints have been migrated to a dedicated TikHub AI API service, which operates separately from the TikHub Social Media API. Please visit: https://ai.tikhub.io\n### Purpose:\n- Query current status and results of video generation task\n- Used to poll and check video generation progress\n- Get generated video information (including generation_id) after task completion\n- Use with create_video endpoint to get asynchronously generated video results\n\n### Pricing:\n- This API is completely free, no charges\n- Rate limit: Maximum 1 request per second (1 request/second)\n- Requests may be throttled if too frequent, recommend at least 1 second interval\n\n### Parameters:\n- task_id: Task ID, required, format like `task_01k7dttf0xfx3t7zhhzycjq8e3`\n    - Task ID returned from create_video endpoint\n    - Must start with 'task_'\n\n### Return:\n- id: Task ID\n- status: Task status\n    - queued: Queued\n    - processing: Processing\n    - succeeded: Completed\n    - failed: Failed\n- prompt: Text description used for video generation\n- title: Video title (if any)\n- progress_pct: Task progress (0.0-1.0, 1.0 means 100%)\n- generations: Generation result array (available after task completion)\n    - id: Generation ID (generation_id, format: gen_xxxxxx)\n    - kind: Type (e.g., sora_draft)\n    - url: Video link (with watermark)\n    - downloadable_url: Download link (with watermark)\n    - width: Video width\n    - height: Video height\n    - created_at: Creation timestamp\n    - prompt: Generation prompt\n    - encodings: Different quality encoding versions\n        - source: Source file\n        - source_wm: Source file with watermark\n        - thumbnail: Thumbnail\n        - md: Medium quality video\n        - gif: Preview GIF\n\n### Note:\n- **Rate limit**: Maximum 1 request per second, recommend polling interval of 1-2 seconds\n- Recommend polling every 1-2 seconds until status becomes succeeded or failed\n- Only when status is succeeded, generations array will contain video data\n- **Important**: This endpoint returns video links **with watermark only**\n- **Get watermark-free video**: After task succeeds, use task_id or generation_id to call `get_task_detail` endpoint to get **watermark-free version**\n- Get generation_id from generations[0].id for subsequent get_task_detail API call\n\n# [示例/Example]\n```python\n# 返回示例（任务进行中）\n# Return example (task in progress)\n{\n    \"id\": \"task_01k7dttf0xfx3t7zhhzycjq8e3\",\n    \"status\": \"processing\",\n    \"prompt\": \"A cat playing Minecraft\",\n    \"progress_pct\": 0.45\n}\n\n# 返回示例（任务完成）\n# Return example (task completed)\n{\n    \"id\": \"task_01k7dttf0xfx3t7zhhzycjq8e3\",\n    \"status\": \"succeeded\",\n    \"prompt\": \"A cat playing Minecraft\",\n    \"progress_pct\": 1.0,\n    \"generations\": [\n        {\n            \"id\": \"gen_01k7e1bff9eq6rxe9pntk7xdcf\",\n            \"kind\": \"sora_draft\",\n            \"url\": \"https://videos.openai.com/...\",\n            \"width\": 640,\n            \"height\": 352,\n            \"encodings\": {\n                \"thumbnail\": {\"path\": \"https://...\"},\n                \"gif\": {\"path\": \"https://...\"}\n            }\n        }\n    ]\n}\n```","operationId":"get_task_status_api_v1_sora2_get_task_status_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"task_id","in":"query","required":true,"schema":{"type":"string","description":"任务ID（从create_video返回）/Task ID (returned from create_video)","title":"Task Id"},"description":"任务ID（从create_video返回）/Task ID (returned from create_video)","example":"task_01k7dttf0xfx3t7zhhzycjq8e3"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sora2/get_task_detail":{"get":{"tags":["Sora2-API"],"summary":"[已弃用/Deprecated] 获取任务生成的作品详情（无水印版本）/Get task-generated post detail (watermark-free)","description":"# [中文]\n## ⚠️ 此接口已弃用。AI 相关接口已迁移至独立的 TikHub AI API 服务，与 TikHub 社交媒体 API 分离部署。请访问：https://ai.tikhub.io\n### 用途:\n- **获取视频生成任务的完整作品详情，包含无水印版本的视频链接**\n\n### 收费说明:\n- 本接口请求价格为 1 次调用消耗 0.05 美元\n- 本接口支持使用免费额度，每天可通过在用户后台签到获取免费调用次数。\n\n### 参数:\n- task_id: 任务 ID（可选），格式如 `task_01k7e17rnkeh79qnrcdwf5fcfs`\n    - 从 create_video 接口返回的任务 ID\n    - 必须以 'task_' 开头\n- generation_id: 生成 ID（可选），格式如 `gen_01k7e1bff9eq6rxe9pntk7xdcf`\n    - 从 get_task_status 接口返回的 generations[0].id\n    - 必须以 'gen_' 开头\n- **注意**: task_id 和 generation_id 至少需要提供一个\n\n### 返回（无水印完整作品详情）:\n- post: 作品详细信息\n    - id: 作品 ID\n    - text: 作品描述文本\n    - attachments: 附件列表（**无水印视频信息**）\n        - **url: 无水印视频链接（原始质量）** ⭐\n        - downloadable_url: 有水印视频链接\n        - width/height: 视频尺寸\n        - encodings: 不同质量的编码版本\n            - **thumbnail: 缩略图（无水印）**\n            - **md: 中等质量视频（无水印）**\n            - **gif: 预览 GIF（无水印）**\n    - like_count: 点赞数\n    - view_count: 浏览数\n    - reply_count: 评论数\n    - remix_count: 混剪数\n    - posted_at: 发布时间戳\n    - permalink: 作品永久链接\n\n### 注意:\n- **本接口返回的视频链接是无水印的原始质量版本**\n- 只有任务状态为 succeeded 时才能成功调用\n- 如果任务未完成，会返回相应的错误信息\n- 推荐使用 generation_id 参数\n- 视频链接有时效性，建议及时下载\n\n# [English]\n## ⚠️ This endpoint has been deprecated. AI-related endpoints have been migrated to a dedicated TikHub AI API service, which operates separately from the TikHub Social Media API. Please visit: https://ai.tikhub.io\n### Purpose:\n- **Get complete post details of video generation task, including watermark-free video links**\n\n### Pricing:\n- This API costs $0.05 per request\n- This API supports free quota, you can get free requests by checking in daily at the user dashboard.\n\n### Parameters:\n- task_id: Task ID (optional), format like `task_01k7e17rnkeh79qnrcdwf5fcfs`\n    - Task ID returned from create_video endpoint\n    - Must start with 'task_'\n- generation_id: Generation ID (optional), format like `gen_01k7e1bff9eq6rxe9pntk7xdcf`\n    - Get from generations[0].id returned by get_task_status endpoint\n    - Must start with 'gen_'\n- **Note**: At least one of task_id or generation_id must be provided\n\n### Return (Watermark-free Complete Post Details):\n- post: Post detailed information\n    - id: Post ID\n    - text: Post description text\n    - attachments: Attachment list (**Watermark-free video info**)\n        - **url: Watermark-free video link (original quality)** ⭐\n        - downloadable_url: Watermarked video link\n        - width/height: Video dimensions\n        - encodings: Different quality encoding versions\n            - **thumbnail: Thumbnail (watermark-free)**\n            - **md: Medium quality video (watermark-free)**\n            - **gif: Preview GIF (watermark-free)**\n    - like_count: Like count\n    - view_count: View count\n    - reply_count: Comment count\n    - remix_count: Remix count\n    - posted_at: Post timestamp\n    - permalink: Permanent link\n\n### Note:\n- **This endpoint returns watermark-free original quality video links**\n- Can only be called successfully when task status is succeeded\n- Will return error message if task is not completed\n- Recommend using task_id parameter, will auto-fetch required generation_id\n- Video links have expiration time, recommend downloading promptly\n\n# [示例/Example]\n```python\n# 返回示例 (无水印完整信息)\n# Return example (watermark-free complete info)\n{\n   \"post\":{\n      \"id\":\"s_68ecb45b40988191b89a0af80135a33c\",\n      \"posted_to_public\":false,\n      \"posted_at\":1760343131.252443,\n      \"updated_at\":1760343140.655776,\n      \"like_count\":0,\n      \"recursive_reply_count\":0,\n      \"reply_count\":0,\n      \"view_count\":0,\n      \"unique_view_count\":0,\n      \"remix_count\":0,\n      \"user_liked\":false,\n      \"source\":\"sy\",\n      \"text\":\"A cat is playing Minecraft\",\n      \"caption\":null,\n      \"cover_photo_url\":null,\n      \"preview_image_url\":\"https://ogimg.chatgpt.com/?postId=s_68ecb45b40988191b89a0af80135a33c\",\n      \"attachments\":[\n         {\n            \"id\":\"s_68ecb45b40988191b89a0af80135a33c-attachment-0\",\n            \"tags\":[\n               \"sora\"\n            ],\n            \"kind\":\"sora\",\n            \"generation_id\":\"gen_01k7e9yzk2e4vr88ykfbtpz1ka\",\n            \"generation_type\":\"video_gen\",\n            \"url\":\"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fsrc.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=NOaGqX50rV7s4Rrmpk8s0eJoHlhS3WHagn0Cz1wuDAM%3D&az=oaivgprodscus\",\n            \"downloadable_url\":\"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000_wm%2Fsrc.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=xiYmjG29NvQi9t5BGqu0tHl2%2BnRoA8eLNssPbLzmTxI%3D&az=oaivgprodscus\",\n            \"width\":352,\n            \"height\":640,\n            \"prompt\":null,\n            \"task_id\":null,\n            \"output_blocked\":false,\n            \"title\":null,\n            \"source\":null,\n            \"encodings\":{\n               \"source\":{\n                  \"path\":\"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fsrc.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=NOaGqX50rV7s4Rrmpk8s0eJoHlhS3WHagn0Cz1wuDAM%3D&az=oaivgprodscus\"\n               },\n               \"source_wm\":{\n                  \"path\":\"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000_wm%2Fsrc.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=xiYmjG29NvQi9t5BGqu0tHl2%2BnRoA8eLNssPbLzmTxI%3D&az=oaivgprodscus\"\n               },\n               \"thumbnail\":{\n                  \"path\":\"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fthumbnail.webp?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=qKQRiyaELAV9lr5B0mJ89vvHSptRXWrAvZHvSPLfBjc%3D&az=oaivgprodscus\"\n               },\n               \"unfurl\":null,\n               \"md\":{\n                  \"path\":\"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fmd.mp4?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=%2FlBkZ6aqa8z6vwP2x%2FDezkCuM65t%2FM5vtglAEv85v5U%3D&az=oaivgprodscus\"\n               },\n               \"gif\":{\n                  \"path\":\"https://videos.openai.com/vg-assets/assets%2Ftask_01k7e9v8q3fvyaawqarkv00gpg%2Ftask_01k7e9v8q3fvyaawqarkv00gpg_genid_36b770af-8068-4bc3-b6c3-73339db3d241_25_10_13_08_10_919283%2Fvideos%2F00000%2Fpreview.gif?st=2025-10-13T06%3A42%3A42Z&se=2025-10-19T07%3A42%3A42Z&sks=b&skt=2025-10-13T06%3A42%3A42Z&ske=2025-10-19T07%3A42%3A42Z&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skoid=8ffff87a-01f1-47c9-9090-32999d4d6380&skv=2019-02-02&sv=2018-11-09&sr=b&sp=r&spr=https%2Chttp&sig=mZsaMyviqaR13sMjZ3W8GAuFPHCYQA2BcPS5jwnIaDg%3D&az=oaivgprodscus\"\n               }\n            },\n            \"asset_pointer\":null,\n            \"conversation_id\":null\n         }\n      ],\n      \"parent_post_id\":null,\n      \"root_post_id\":null,\n      \"parent_path\":null,\n      \"tombstoned_at\":null,\n      \"permalink\":\"https://sora.chatgpt.com/p/s_68ecb45b40988191b89a0af80135a33c\",\n      \"text_facets\":[\n\n      ],\n      \"cameo_profiles\":null,\n      \"disabled_cameo_user_ids\":null,\n      \"groups\":[\n\n      ],\n      \"user_disliked\":false,\n      \"verifications\":[\n\n      ],\n      \"dislike_count\":0,\n      \"remix_posts\":{\n         \"items\":[\n\n         ],\n         \"cursor\":null\n      },\n      \"ancestors\":{\n         \"items\":[\n\n         ],\n         \"cursor\":null\n      },\n      \"parent_post\":null,\n      \"emoji\":\"🐱‍💻\",\n      \"is_featured\":null\n   }\n}\n```","operationId":"get_task_detail_api_v1_sora2_get_task_detail_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"task_id","in":"query","required":false,"schema":{"type":"string","description":"任务ID（可选，与generation_id二选一）/Task ID (optional, choose one with generation_id)","default":"","title":"Task Id"},"description":"任务ID（可选，与generation_id二选一）/Task ID (optional, choose one with generation_id)","example":"task_01k7e17rnkeh79qnrcdwf5fcfs"},{"name":"generation_id","in":"query","required":false,"schema":{"type":"string","description":"生成ID（可选，与task_id二选一）/Generation ID (optional, choose one with task_id)","default":"","title":"Generation Id"},"description":"生成ID（可选，与task_id二选一）/Generation ID (optional, choose one with task_id)","example":"gen_01k7e1bff9eq6rxe9pntk7xdcf"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/temp_mail/v1/get_temp_email_address":{"get":{"tags":["Temp-Mail-API"],"summary":"Get Temp Email","description":"# [中文]\n### 用途:\n- 获取一个临时邮箱地址\n- 用于注册或者接收邮件，该邮箱地址不会被删除，也不会被其他人使用。\n- 该邮箱无法发送邮件，只能接收邮件。\n- 请自行保存邮箱地址、用户名、密码、Bearer Token，我们无法帮助您找回这些关键信息。\n### 参数:\n- 无\n### 返回:\n- domain: 邮箱域名\n- name: 邮箱用户名\n- password: 邮箱密码\n- email_address: 邮箱地址\n- token: 邮箱Bearer Token\n\n# [English]\n### Purpose:\n- Get a temporary email address\n- Used for registration or receiving emails, this email address will not be deleted or used by others.\n- This email cannot send emails, only receive emails.\n- Please save the email address, username, password, and Bearer Token yourself, we cannot help you retrieve this critical information.\n### Parameters:\n- None\n### Returns:\n- domain: Email domain\n- name: Email username\n- password: Email password\n- email_address: Email address\n- token: Email Bearer Token","operationId":"get_temp_email_api_v1_temp_mail_v1_get_temp_email_address_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/temp_mail/v1/get_emails_inbox":{"get":{"tags":["Temp-Mail-API"],"summary":"Get Emails","description":"# [中文]\n### 用途:\n- 获取邮件列表\n### 参数:\n- token: 邮箱Bearer Token\n### 返回:\n- emails: 邮件列表\n\n# [English]\n### Purpose:\n- Get a list of emails\n### Parameters:\n- token: Email Bearer Token\n### Returns:\n- emails: List of emails","operationId":"get_emails_api_v1_temp_mail_v1_get_emails_inbox_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string","description":"Bearer Token","title":"Token"},"description":"Bearer Token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/temp_mail/v1/get_email_by_id":{"get":{"tags":["Temp-Mail-API"],"summary":"Get Email By Id","description":"# [中文]\n### 用途:\n- 通过邮件ID获取邮件数据\n### 参数:\n- token: 邮箱Bearer Token\n- message_id: 邮件ID\n### 返回:\n- 邮件数据\n\n# [English]\n### Purpose:\n- Get email data by email ID\n### Parameters:\n- token: Email Bearer Token\n- message_id: Email ID\n### Returns:\n- Email data","operationId":"get_email_by_id_api_v1_temp_mail_v1_get_email_by_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string","description":"Bearer Token","title":"Token"},"description":"Bearer Token"},{"name":"message_id","in":"query","required":true,"schema":{"type":"string","description":"Message ID","title":"Message Id"},"description":"Message ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_tweet_detail":{"get":{"tags":["Twitter-Web-API"],"summary":"获取单个推文数据/Get single tweet data","description":"# [中文]\n### 用途:\n- 获取单个推文数据\n### 参数:\n- tweet_id: 推文ID，可以从推文链接中获取。例如：https://x.com/elonmusk/status/1808168603721650364 中的 1808168603721650364。\n### 返回:\n- 推文数据\n\n# [English]\n### Purpose:\n- Get single tweet data\n### Parameters:\n- tweet_id: Tweet ID, can be obtained from the tweet link. For example: 1808168603721650364 in https://x.com/elonmusk/status/1808168603721650364\n### Return:\n- Tweet data\n\n# [示例/Example]\ntweet_id = \"1808168603721650364\"","operationId":"fetch_tweet_detail_api_v1_twitter_web_fetch_tweet_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"tweet_id","in":"query","required":true,"schema":{"type":"string","description":"推文ID/Tweet ID","title":"Tweet Id"},"description":"推文ID/Tweet ID","example":"1808168603721650364"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_user_profile":{"get":{"tags":["Twitter-Web-API"],"summary":"获取用户资料/Get user profile","description":"# [中文]\n### 用途:\n- 获取用户资料\n### 参数:\n- screen_name: 用户名，例如：elonmusk，可以从用户主页链接中获取，例如：https://twitter.com/elonmusk 中的 elonmusk。\n- rest_id: 用户ID，例如：44196397，如果使用用户ID则会忽略用户名，两者只能选其一。\n### 返回:\n- 用户资料\n\n# [English]\n### Purpose:\n- Get user profile\n### Parameters:\n- screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk\n- rest_id: User ID, for example: 44196397, if the user ID is used, the username will be ignored, only one of them can be selected.\n### Return:\n- User profile\n\n# [示例/Example]\nscreen_name = \"elonmusk\"","operationId":"fetch_user_profile_api_v1_twitter_web_fetch_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"screen_name","in":"query","required":false,"schema":{"type":"string","description":"用户名/Screen Name","title":"Screen Name"},"description":"用户名/Screen Name","example":"elonmusk"},{"name":"rest_id","in":"query","required":false,"schema":{"type":"integer","description":"用户ID（如果使用用户ID则会忽略用户名）/User ID (If the user ID is used, the user name will be ignored)","title":"Rest Id"},"description":"用户ID（如果使用用户ID则会忽略用户名）/User ID (If the user ID is used, the user name will be ignored)","example":"44196397"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_user_post_tweet":{"get":{"tags":["Twitter-Web-API"],"summary":"获取用户发帖/Get user post","description":"# [中文]\n### 用途:\n- 获取用户发帖\n### 参数:\n- screen_name: 用户名，例如：elonmusk，可以从用户主页链接中获取，例如：https://twitter.com/elonmusk 中的 elonmusk。\n- rest_id: 用户ID，例如：44196397，如果使用用户ID则会忽略用户名，两者只能选其一。\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中的JSON中获取。\n### 返回:\n- 用户发帖\n\n# [English]\n### Purpose:\n- Get user post\n### Parameters:\n- screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk\n- rest_id: User ID, for example: 44196397, if the user ID is used, the username will be ignored, only one of them can be selected.\n- cursor: Cursor, default is None, used for paging, obtained from the JSON in the last request.\n\n# [示例/Example]\nscreen_name = \"elonmusk\"\nrest_id = 44196397\ncursor = None","operationId":"fetch_user_post_tweet_api_v1_twitter_web_fetch_user_post_tweet_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"screen_name","in":"query","required":false,"schema":{"type":"string","description":"用户名/Screen Name","title":"Screen Name"},"description":"用户名/Screen Name","example":"elonmusk"},{"name":"rest_id","in":"query","required":false,"schema":{"type":"integer","description":"用户ID/User ID","title":"Rest Id"},"description":"用户ID/User ID","example":"44196397"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_search_timeline":{"get":{"tags":["Twitter-Web-API"],"summary":"搜索/Search","description":"# [中文]\n### 用途:\n- 搜索\n### 参数:\n- keyword: 搜索关键字\n- search_type: 搜索类型，默认为Top，其他可选值为Latest，Media，People, Lists\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中获取\n### 返回:\n- 搜索结果\n\n# [English]\n### Purpose:\n- Search\n### Parameters:\n- keyword: Search keyword\n- search_type: Search type, default is Top, other optional values are Latest, Media, People, Lists\n- cursor: Cursor, default is None, used for paging, obtained from the last request\n### Return:\n- Search results\n\n# [示例/Example]\nkeyword = \"Elon Musk\"\nsearch_type = \"Top\"\ncursor = None","operationId":"fetch_search_timeline_api_v1_twitter_web_fetch_search_timeline_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string","description":"搜索关键字/Search Keyword","title":"Keyword"},"description":"搜索关键字/Search Keyword","example":"Elon Musk"},{"name":"search_type","in":"query","required":false,"schema":{"type":"string","description":"搜索类型/Search Type","default":"Top","title":"Search Type"},"description":"搜索类型/Search Type","example":"Top"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_post_comments":{"get":{"tags":["Twitter-Web-API"],"summary":"获取评论/Get comments","description":"# [中文]\n### 用途:\n- 获取推文下的评论\n### 参数:\n- tweet_id: 推文ID\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中获取\n### 返回:\n- 评论\n\n# [English]\n### Purpose:\n- Get comments under the tweet\n### Parameters:\n- tweet_id: Tweet ID\n- cursor: Cursor, default is None, used for paging, obtained from the last request\n### Return:\n- Comments\n\n# [示例/Example]\ntweet_id = \"1808168603721650364\"\ncursor = None","operationId":"fetch_post_comments_api_v1_twitter_web_fetch_post_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"tweet_id","in":"query","required":true,"schema":{"type":"string","description":"推文ID/Tweet ID","title":"Tweet Id"},"description":"推文ID/Tweet ID","example":"1835124037934367098"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_latest_post_comments":{"get":{"tags":["Twitter-Web-API"],"summary":"获取最新的推文评论/Get the latest tweet comments","description":"# [中文]\n### 用途:\n- 获取最新的推文评论\n### 参数:\n- tweet_id: 推文ID\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中获取\n### 返回:\n- 推文评论\n\n# [English]\n### Purpose:\n- Get the latest tweet comments\n### Parameters:\n- tweet_id: Tweet ID\n- cursor: Cursor, default is None, used for paging, obtained from the last request\n### Return:\n- Tweet comments\n\n# [示例/Example]\ntweet_id = \"1808168603721650364\"\ncursor = None","operationId":"fetch_latest_post_comments_api_v1_twitter_web_fetch_latest_post_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"tweet_id","in":"query","required":true,"schema":{"type":"string","description":"推文ID/Tweet ID","title":"Tweet Id"},"description":"推文ID/Tweet ID","example":"1808168603721650364"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_user_tweet_replies":{"get":{"tags":["Twitter-Web-API"],"summary":"获取用户推文回复/Get user tweet replies","description":"# [中文]\n### 用途:\n- 获取用户推文回复\n### 参数:\n- screen_name: 用户名，例如：elonmusk，可以从用户主页链接中获取，例如：https://twitter.com/elonmusk 中的 elonmusk。\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中获取\n### 返回:\n- 用户推文回复\n\n# [English]\n### Purpose:\n- Get user tweet replies\n### Parameters:\n- screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk\n- cursor: Cursor, default is None, used for paging, obtained from the last request\n### Return:\n- User tweet replies\n\n# [示例/Example]\nscreen_name = \"elonmusk\"\ncursor = None","operationId":"fetch_user_tweet_replies_api_v1_twitter_web_fetch_user_tweet_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"screen_name","in":"query","required":true,"schema":{"type":"string","description":"用户名/Screen Name","title":"Screen Name"},"description":"用户名/Screen Name","example":"elonmusk"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_user_highlights_tweets":{"get":{"tags":["Twitter-Web-API"],"summary":"获取用户高光推文/Get user highlights tweets","description":"# [中文]\n### 用途:\n- 获取用户高光推文\n### 参数:\n- userId: 用户ID\n- count: 数量，默认为20\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中获取\n    - JSONPath: $.data.data.user.result.timeline_v2.timeline.instructions.[1].entries.[-1].content.value\n### 返回:\n- 用户高光推文\n\n# [English]\n### Purpose:\n- Get user highlights tweets\n### Parameters:\n- userId: User ID\n- count: Count, default is 20\n- cursor: Cursor, default is None, used for paging, obtained from the last request\n    - JSONPath: $.data.data.user.result.timeline_v2.timeline.instructions.[1].entries.[-1].content.value\n### Return:\n- User highlights tweets\n\n# [示例/Example]\nuserId = \"44196397\"\ncount = 20\ncursor = None","operationId":"fetch_user_highlights_tweets_api_v1_twitter_web_fetch_user_highlights_tweets_get","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"userId","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"Userid"},"description":"用户ID/User ID","example":"44196397"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"数量/Count","default":20,"title":"Count"},"description":"数量/Count","example":20},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_user_media":{"get":{"tags":["Twitter-Web-API"],"summary":"获取用户媒体/Get user media","description":"# [中文]\n### 用途:\n- 获取用户媒体\n### 参数:\n- screen_name: 用户名，例如：elonmusk，可以从用户主页链接中获取，例如：https://twitter.com/elonmusk 中的 elonmusk。\n- rest_id: 用户ID，例如：44196397，如果使用用户ID则会忽略用户名，两者只能选其一。\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中的 `next_cursor` 获取\n### 返回:\n- 用户媒体\n\n# [English]\n### Purpose:\n- Get user media\n### Parameters:\n- screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk\n- rest_id: User ID, for example: 44196397, if the user ID is used, the username will be ignored, only one of them can be selected.\n- cursor: Cursor, default is None, used for paging, obtained from the `next_cursor` in the last request\n### Return:\n- User media\n\n# [示例/Example]\nscreen_name = \"elonmusk\"\ncursor = \"\"","operationId":"fetch_user_media_api_v1_twitter_web_fetch_user_media_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"screen_name","in":"query","required":true,"schema":{"type":"string","description":"用户名/Screen Name","title":"Screen Name"},"description":"用户名/Screen Name","example":"elonmusk"},{"name":"rest_id","in":"query","required":false,"schema":{"type":"integer","description":"用户ID/User ID","title":"Rest Id"},"description":"用户ID/User ID","example":"44196397"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"翻页游标/Page Cursor","title":"Cursor"},"description":"翻页游标/Page Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_retweet_user_list":{"get":{"tags":["Twitter-Web-API"],"summary":"转推用户列表/ReTweet User list","description":"# [中文]\n### 用途:\n- 获取转推用户列表\n### 参数:\n- tweet_id: 推文ID，可以从推文链接中获取。例如：https://x.com/elonmusk/status/1808168603721650364 中的 1808168603721650364。\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中获取\n### 返回:\n- 转推用户列表\n\n# [English]\n### Purpose:\n- Get ReTweet User list\n### Parameters:\n- tweet_id: Tweet ID, can be obtained from the tweet link. For example: 1808168603721650364 in https://x.com/elonmusk/status/1808168603721650364\n- cursor: Cursor, default is None, used for paging, obtained from the last request\n### Return:\n- ReTweet User list\n\n# [示例/Example]\ntweet_id = \"1808168603721650364\"\ncursor = None","operationId":"fetch_retweet_user_list_api_v1_twitter_web_fetch_retweet_user_list_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"tweet_id","in":"query","required":true,"schema":{"type":"string","description":"推文ID/Tweet ID","title":"Tweet Id"},"description":"推文ID/Tweet ID","example":"1835124037934367098"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_trending":{"get":{"tags":["Twitter-Web-API"],"summary":"趋势/Trending","description":"# [中文]\n### 用途:\n- 获取趋势\n### 参数:\n- country: 国家，默认为UnitedStates，其他可选值见下方\n    - China\n    - India\n    - Japan\n    - Russia\n    - Germany\n    - Indonesia\n    - Brazil\n    - France\n    - UnitedKingdom\n    - Turkey\n    - Italy\n    - Mexico\n    - SouthKorea\n    - Canada\n    - Spain\n    - SaudiArabia\n    - Egypt\n    - Australia\n    - Poland\n    - Iran\n    - Pakistan\n    - Vietnam\n    - Nigeria\n    - Bangladesh\n    - Netherlands\n    - Argentina\n    - Philippines\n    - Malaysia\n    - Colombia\n    - UniteArabEmirates\n    - Romania\n    - Belgium\n    - Switzerland\n    - Singapore\n    - Sweden\n    - Norway\n    - Austria\n    - Kazakhstan\n    - Algeria\n    - Chile\n    - Czechia\n    - Peru\n    - Iraq\n    - Israel\n    - Ukraine\n    - Denmark\n    - Portugal\n    - Hungary\n    - Greece\n    - Finland\n    - NewZealand\n    - Belarus\n    - Slovakia\n    - Serbia\n    - Lithuania\n    - Luxembourg\n    - Estonia\n\n### 返回:\n- 趋势\n\n# [English]\n### Purpose:\n- Get Trending\n### Parameters:\n- country: Country, default is UnitedStates, other optional values are as follows\n    - China\n    - India\n    - Japan\n    - Russia\n    - Germany\n    - Indonesia\n    - Brazil\n    - France\n    - UnitedKingdom\n    - Turkey\n    - Italy\n    - Mexico\n    - SouthKorea\n    - Canada\n    - Spain\n    - SaudiArabia\n    - Egypt\n    - Australia\n    - Poland\n    - Iran\n    - Pakistan\n    - Vietnam\n    - Nigeria\n    - Bangladesh\n    - Netherlands\n    - Argentina\n    - Philippines\n    - Malaysia\n    - Colombia\n    - UniteArabEmirates\n    - Romania\n    - Belgium\n    - Switzerland\n    - Singapore\n    - Sweden\n    - Norway\n    - Austria\n    - Kazakhstan\n    - Algeria\n    - Chile\n    - Czechia\n    - Peru\n\n### Return:\n- Trending\n\n# [示例/Example]\ncountry = \"UnitedStates\"","operationId":"fetch_trending_api_v1_twitter_web_fetch_trending_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"country","in":"query","required":false,"schema":{"type":"string","description":"国家/Country","default":"UnitedStates","title":"Country"},"description":"国家/Country","example":"UnitedStates"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_user_followings":{"get":{"tags":["Twitter-Web-API"],"summary":"用户关注/User Followings","description":"# [中文]\n### 用途:\n- 获取用户关注\n### 参数:\n- screen_name: 用户名，例如：elonmusk，可以从用户主页链接中获取，例如：https://twitter.com/elonmusk 中的 elonmusk。\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中获取\n### 返回:\n- 用户关注\n\n# [English]\n### Purpose:\n- Get User Followings\n### Parameters:\n- screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk\n- cursor: Cursor, default is None, used for paging, obtained from the last request\n### Return:\n- User Followings\n\n# [示例/Example]\nscreen_name = \"elonmusk\"","operationId":"fetch_user_followings_api_v1_twitter_web_fetch_user_followings_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"screen_name","in":"query","required":true,"schema":{"type":"string","description":"用户名/Screen Name","title":"Screen Name"},"description":"用户名/Screen Name","example":"elonmusk"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/twitter/web/fetch_user_followers":{"get":{"tags":["Twitter-Web-API"],"summary":"用户粉丝/User Followers","description":"# [中文]\n### 用途:\n- 获取用户粉丝\n### 参数:\n- screen_name: 用户名，例如：elonmusk，可以从用户主页链接中获取，例如：https://twitter.com/elonmusk 中的 elonmusk。\n- cursor: 游标，默认为None，用于翻页，后续从上一次请求的返回结果中获取\n### 返回:\n- 用户粉丝\n\n# [English]\n### Purpose:\n- Get User Followers\n### Parameters:\n- screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk\n- cursor: Cursor, default is None, used for paging, obtained from the last request\n### Return:\n- User Followers\n\n# [示例/Example]\nscreen_name = \"elonmusk\"","operationId":"fetch_user_followers_api_v1_twitter_web_fetch_user_followers_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"screen_name","in":"query","required":true,"schema":{"type":"string","description":"用户名/Screen Name","title":"Screen Name"},"description":"用户名/Screen Name","example":"elonmusk"},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","description":"游标/Cursor","title":"Cursor"},"description":"游标/Cursor"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/fetch_user_info":{"get":{"tags":["Threads-Web-API"],"summary":"获取用户信息/Get user info","description":"# [中文]\n### 用途:\n- 获取Threads用户信息\n- 价格：0.002$ / 次\n### 参数:\n- username: 用户名，例如：lilbieber，可以从用户主页链接中获取，例如：https://www.threads.net/@lilbieber 中的 lilbieber。\n### 返回:\n- 用户信息数据，包含:\n    - pk: 用户ID\n    - username: 用户名\n    - full_name: 全名\n    - biography: 个人简介\n    - profile_pic_url: 头像URL\n    - follower_count: 粉丝数\n    - is_verified: 是否认证\n    - 等等...\n\n# [English]\n### Purpose:\n- Get Threads user information\n- Price: 0.002$ / time\n### Parameters:\n- username: Username, for example: lilbieber, can be obtained from the user's homepage link, for example: lilbieber in https://www.threads.net/@lilbieber\n### Return:\n- User information data, including:\n    - pk: User ID\n    - username: Username\n    - full_name: Full name\n    - biography: Biography\n    - profile_pic_url: Profile picture URL\n    - follower_count: Follower count\n    - is_verified: Is verified\n    - etc...\n\n# [示例/Example]\nusername = \"lilbieber\"","operationId":"fetch_user_info_api_v1_threads_web_fetch_user_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username","example":"lilbieber"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/fetch_user_info_by_id":{"get":{"tags":["Threads-Web-API"],"summary":"根据用户ID获取用户信息/Get user info by ID","description":"# [中文]\n### 用途:\n- 根据用户ID获取Threads用户信息\n- 价格：0.002$ / 次\n### 参数:\n- user_id: 用户ID，例如：67027868801，可以从用户主页API或帖子数据中获取。\n### 返回:\n- 用户信息数据，包含:\n    - pk: 用户ID\n    - username: 用户名\n    - full_name: 全名\n    - biography: 个人简介\n    - profile_pic_url: 头像URL\n    - follower_count: 粉丝数\n    - is_verified: 是否认证\n    - 等等...\n\n# [English]\n### Purpose:\n- Get Threads user information by user ID\n- Price: 0.002$ / time\n### Parameters:\n- user_id: User ID, for example: 67027868801, can be obtained from user profile API or post data\n### Return:\n- User information data, including:\n    - pk: User ID\n    - username: Username\n    - full_name: Full name\n    - biography: Biography\n    - profile_pic_url: Profile picture URL\n    - follower_count: Follower count\n    - is_verified: Is verified\n    - etc...\n\n# [示例/Example]\nuser_id = \"67027868801\"","operationId":"fetch_user_info_by_id_api_v1_threads_web_fetch_user_info_by_id_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"67027868801"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/fetch_user_posts":{"get":{"tags":["Threads-Web-API"],"summary":"获取用户帖子列表/Get user posts","description":"# [中文]\n### 用途:\n- 获取Threads用户的帖子列表\n- 价格：0.002$ / 次\n### 参数:\n- user_id: 用户ID，例如：63625256886，可以从用户主页API获取。\n- end_cursor: 分页游标（可选），用于获取下一页数据\n### 返回:\n- 用户帖子列表数据，包含:\n    - threads: 帖子列表数组\n    - next_cursor: 下一页游标\n    - has_more: 是否有更多数据\n    - 每个帖子包含:\n        - id: 帖子ID\n        - text: 帖子文本内容\n        - user: 发布者信息\n        - image_versions2: 图片信息\n        - video_versions: 视频信息\n        - like_count: 点赞数\n        - text_post_app_info: 帖子应用信息\n        - 等等...\n\n# [English]\n### Purpose:\n- Get Threads user's post list\n- Price: 0.002$ / time\n### Parameters:\n- user_id: User ID, for example: 63625256886, can be obtained from user profile API\n- end_cursor: Pagination cursor (optional), used to get next page data\n### Return:\n- User post list data, including:\n    - threads: Post list array\n    - next_cursor: Next page cursor\n    - has_more: Has more data\n    - Each post contains:\n        - id: Post ID\n        - text: Post text content\n        - user: Publisher information\n        - image_versions2: Image information\n        - video_versions: Video information\n        - like_count: Like count\n        - text_post_app_info: Post app information\n        - etc...\n\n# [示例/Example]\nuser_id = \"63625256886\"\nend_cursor = None  # or a cursor string from previous response","operationId":"fetch_user_posts_api_v1_threads_web_fetch_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"63625256886"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor (optional)","title":"End Cursor"},"description":"分页游标/Pagination cursor (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/fetch_user_reposts":{"get":{"tags":["Threads-Web-API"],"summary":"获取用户转发列表/Get user reposts","description":"# [中文]\n### 用途:\n- 获取Threads用户的转发列表\n- 价格：0.002$ / 次\n### 参数:\n- user_id: 用户ID，例如：63625256886\n- end_cursor: 分页游标（可选），用于获取下一页数据\n### 返回:\n- 用户转发列表数据，包含:\n    - threads: 转发列表\n    - next_cursor: 下一页游标\n    - has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Get Threads user's repost list\n- Price: 0.002$ / time\n### Parameters:\n- user_id: User ID, for example: 63625256886\n- end_cursor: Pagination cursor (optional), used to get next page data\n### Return:\n- User repost list data, including:\n    - threads: Repost list\n    - next_cursor: Next page cursor\n    - has_more: Has more data\n\n# [示例/Example]\nuser_id = \"63625256886\"\nend_cursor = None  # or a cursor string from previous response","operationId":"fetch_user_reposts_api_v1_threads_web_fetch_user_reposts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"63625256886"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor (optional)","title":"End Cursor"},"description":"分页游标/Pagination cursor (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/fetch_user_replies":{"get":{"tags":["Threads-Web-API"],"summary":"获取用户回复列表/Get user replies","description":"# [中文]\n### 用途:\n- 获取Threads用户的回复列表\n- 价格：0.002$ / 次\n### 参数:\n- user_id: 用户ID，例如：63625256886\n- end_cursor: 分页游标（可选），用于获取下一页数据\n### 返回:\n- 用户回复列表数据，包含:\n    - threads: 回复列表\n    - next_cursor: 下一页游标\n    - has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Get Threads user's reply list\n- Price: 0.002$ / time\n### Parameters:\n- user_id: User ID, for example: 63625256886\n- end_cursor: Pagination cursor (optional), used to get next page data\n### Return:\n- User reply list data, including:\n    - threads: Reply list\n    - next_cursor: Next page cursor\n    - has_more: Has more data\n\n# [示例/Example]\nuser_id = \"63625256886\"\nend_cursor = None  # or a cursor string from previous response","operationId":"fetch_user_replies_api_v1_threads_web_fetch_user_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_id","in":"query","required":true,"schema":{"type":"string","description":"用户ID/User ID","title":"User Id"},"description":"用户ID/User ID","example":"63625256886"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor (optional)","title":"End Cursor"},"description":"分页游标/Pagination cursor (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/fetch_post_detail":{"get":{"tags":["Threads-Web-API"],"summary":"获取帖子详情/Get post detail","description":"# [中文]\n### 用途:\n- 获取Threads帖子详情\n- 价格：0.002$ / 次\n### 参数:\n- post_id: 帖子ID（纯数字），例如：3349029093483693129，可以从其他接口获取，如果是使用URL获取，去调用 /fetch_post_detail_v2 接口。\n### 返回:\n- 帖子详情数据，包含:\n    - id: 帖子ID\n    - text: 帖子文本内容\n    - user: 发布者信息\n    - image_versions2: 图片信息\n    - video_versions: 视频信息\n    - like_count: 点赞数\n    - text_post_app_info: 帖子应用信息\n    - 等等...\n\n# [English]\n### Purpose:\n- Get Threads post detail\n- Price: 0.002$ / time\n### Parameters:\n- post_id: Post ID (numeric only), for example: 3349029093483693129, can be obtained from other APIs. If using URL to get, call /fetch_post_detail_v2 API.\n### Return:\n- Post detail data, including:\n    - id: Post ID\n    - text: Post text content\n    - user: Publisher information\n    - image_versions2: Image information\n    - video_versions: Video information\n    - like_count: Like count\n    - text_post_app_info: Post app information\n    - etc...\n\n# [示例/Example]\npost_id = \"3349029093483693129\"","operationId":"fetch_post_detail_api_v1_threads_web_fetch_post_detail_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":true,"schema":{"type":"string","description":"帖子ID/Post ID","title":"Post Id"},"description":"帖子ID/Post ID","example":"3349029093483693129"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/fetch_post_detail_v2":{"get":{"tags":["Threads-Web-API"],"summary":"获取帖子详情 V2(支持链接)/Get post detail V2(supports URL)","description":"# [中文]\n### 用途:\n- 获取Threads帖子详情（支持短代码和完整URL）\n- 价格：0.002$ / 次\n### 参数:\n- post_id: 帖子短代码（可选），例如：DPVUglOjOUu，可以从帖子URL中提取，例如：https://www.threads.com/@taylorswift/post/DPVUglOjOUu 中的 DPVUglOjOUu\n- url: 完整的帖子URL（可选），例如：https://www.threads.com/@taylorswift/post/DPVUglOjOUu\n- 注意：post_id 和 url 至少提供一个参数\n### 返回:\n- 帖子详情数据，包含:\n    - post_id: 帖子ID\n    - text: 帖子文本内容\n    - user: 发布者信息\n    - media: 媒体信息（图片、视频）\n    - like_count: 点赞数\n    - reply_count: 回复数\n    - repost_count: 转发数\n    - timestamp: 发布时间\n    - 等等...\n\n# [English]\n### Purpose:\n- Get Threads post detail (supports short code and full URL)\n- Price: 0.002$ / time\n### Parameters:\n- post_id: Post short code (optional), for example: DPVUglOjOUu, can be extracted from post URL, e.g., DPVUglOjOUu in https://www.threads.com/@taylorswift/post/DPVUglOjOUu\n- url: Full post URL (optional), for example: https://www.threads.com/@taylorswift/post/DPVUglOjOUu\n- Note: At least one of post_id or url must be provided\n### Return:\n- Post detail data, including:\n    - post_id: Post ID\n    - text: Post text content\n    - user: Publisher information\n    - media: Media information (images, videos)\n    - like_count: Like count\n    - reply_count: Reply count\n    - repost_count: Repost count\n    - timestamp: Publish timestamp\n    - etc...\n\n# [示例/Example]\npost_id = \"DPVUglOjOUu\"\n# or\nurl = \"https://www.threads.com/@taylorswift/post/DPVUglOjOUu\"","operationId":"fetch_post_detail_v2_api_v1_threads_web_fetch_post_detail_v2_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":false,"schema":{"type":"string","description":"帖子短代码/Post short code","title":"Post Id"},"description":"帖子短代码/Post short code","example":"DPVUglOjOUu"},{"name":"url","in":"query","required":false,"schema":{"type":"string","description":"完整帖子URL/Full post URL","title":"Url"},"description":"完整帖子URL/Full post URL","example":"https://www.threads.com/@taylorswift/post/DPVUglOjOUu"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/fetch_post_comments":{"get":{"tags":["Threads-Web-API"],"summary":"获取帖子评论/Get post comments","description":"# [中文]\n### 用途:\n- 获取Threads帖子评论列表\n- 价格：0.002$ / 次\n### 参数:\n- post_id: 帖子ID，例如：3390920896561588969\n- end_cursor: 分页游标（可选），用于获取下一页数据\n### 返回:\n- 帖子评论列表数据，包含:\n    - comments: 评论列表\n    - next_cursor: 下一页游标\n    - has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Get Threads post comments list\n- Price: 0.002$ / time\n### Parameters:\n- post_id: Post ID, for example: 3390920896561588969\n- end_cursor: Pagination cursor (optional), used to get next page data\n### Return:\n- Post comments list data, including:\n    - comments: Comment list\n    - next_cursor: Next page cursor\n    - has_more: Has more data\n\n# [示例/Example]\npost_id = \"3390920896561588969\"\nend_cursor = None  # or a cursor string from previous response","operationId":"fetch_post_comments_api_v1_threads_web_fetch_post_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":true,"schema":{"type":"string","description":"帖子ID/Post ID","title":"Post Id"},"description":"帖子ID/Post ID","example":"3390920896561588969"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor (optional)","title":"End Cursor"},"description":"分页游标/Pagination cursor (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/search_top":{"get":{"tags":["Threads-Web-API"],"summary":"搜索热门内容/Search top content","description":"# [中文]\n### 用途:\n- 搜索Threads热门内容\n- 价格：0.002$ / 次\n### 参数:\n- query: 搜索关键词，例如：bitcoin\n- end_cursor: 分页游标（可选），用于获取下一页数据\n### 返回:\n- 搜索结果数据，包含:\n    - threads: 帖子列表\n    - next_cursor: 下一页游标\n    - has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Search Threads top content\n- Price: 0.002$ / time\n### Parameters:\n- query: Search query, for example: bitcoin\n- end_cursor: Pagination cursor (optional), used to get next page data\n### Return:\n- Search result data, including:\n    - threads: Post list\n    - next_cursor: Next page cursor\n    - has_more: Has more data\n\n# [示例/Example]\nquery = \"bitcoin\"\nend_cursor = None  # or a cursor string from previous response","operationId":"search_top_api_v1_threads_web_search_top_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search query","title":"Query"},"description":"搜索关键词/Search query","example":"bitcoin"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor (optional)","title":"End Cursor"},"description":"分页游标/Pagination cursor (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/search_recent":{"get":{"tags":["Threads-Web-API"],"summary":"搜索最新内容/Search recent content","description":"# [中文]\n### 用途:\n- 搜索Threads最新内容\n- 价格：0.002$ / 次\n### 参数:\n- query: 搜索关键词，例如：bitcoin\n- end_cursor: 分页游标（可选），用于获取下一页数据\n### 返回:\n- 搜索结果数据，包含:\n    - threads: 帖子列表\n    - next_cursor: 下一页游标\n    - has_more: 是否有更多数据\n\n# [English]\n### Purpose:\n- Search Threads recent content\n- Price: 0.002$ / time\n### Parameters:\n- query: Search query, for example: bitcoin\n- end_cursor: Pagination cursor (optional), used to get next page data\n### Return:\n- Search result data, including:\n    - threads: Post list\n    - next_cursor: Next page cursor\n    - has_more: Has more data\n\n# [示例/Example]\nquery = \"bitcoin\"\nend_cursor = None  # or a cursor string from previous response","operationId":"search_recent_api_v1_threads_web_search_recent_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search query","title":"Query"},"description":"搜索关键词/Search query","example":"bitcoin"},{"name":"end_cursor","in":"query","required":false,"schema":{"type":"string","description":"分页游标/Pagination cursor (optional)","title":"End Cursor"},"description":"分页游标/Pagination cursor (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/threads/web/search_profiles":{"get":{"tags":["Threads-Web-API"],"summary":"搜索用户档案/Search profiles","description":"# [中文]\n### 用途:\n- 搜索Threads用户档案\n- 价格：0.002$ / 次\n### 参数:\n- query: 搜索关键词，例如：mark\n### 返回:\n- 搜索结果数据，包含:\n    - users: 用户列表\n    - 每个用户包含:\n        - pk: 用户ID\n        - username: 用户名\n        - full_name: 全名\n        - profile_pic_url: 头像URL\n        - is_verified: 是否认证\n        - follower_count: 粉丝数\n        - 等等...\n\n# [English]\n### Purpose:\n- Search Threads user profiles\n- Price: 0.002$ / time\n### Parameters:\n- query: Search query, for example: mark\n### Return:\n- Search result data, including:\n    - users: User list\n    - Each user contains:\n        - pk: User ID\n        - username: Username\n        - full_name: Full name\n        - profile_pic_url: Profile picture URL\n        - is_verified: Is verified\n        - follower_count: Follower count\n        - etc...\n\n# [示例/Example]\nquery = \"mark\"","operationId":"search_profiles_api_v1_threads_web_search_profiles_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search query","title":"Query"},"description":"搜索关键词/Search query","example":"mark"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_home_feed":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP首页推荐内容/Fetch Reddit APP Home Feed","description":"# [中文]\n### 用途:\n- 获取Reddit APP首页推荐内容\n### 参数:\n- sort: 排序方式，支持HOT, NEW, TOP, BEST, CONTROVERSIAL\n- filter_posts: 过滤掉指定的帖子ID列表，用于排除已获取的帖子，避免重复获取\n- after: 分页参数，获取下一页时使用\n### 返回:\n- Reddit APP首页推荐内容的JSON数据\n\n# [English]\n### Purpose:\n- Fetch Reddit APP home feed content\n### Parameters:\n- sort: Sort method, supports HOT, NEW, TOP, BEST, CONTROVERSIAL\n- filter_posts: List of post IDs to filter out, used to exclude already fetched posts\n- after: Pagination parameter for fetching the next page\n### Returns:\n- JSON data of Reddit APP home feed content\n\n# [示例/Example]\nsort=\"BEST\"\n\nfilter_posts=[\"t3_1ojjquz\",\"t3_1ohepm2\",\"t3_1ojxzzz\",\"t3_1ojnvca\",\"t3_1oj9dcb\",\"t3_1ojxubp\",\"t3_1oj5x2b\"]\n\nafter=\"dDNfMW9qNXgyYg==\"","operationId":"fetch_home_feed_api_v1_reddit_app_fetch_home_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort method: HOT, NEW, TOP, BEST, CONTROVERSIAL","default":"BEST","title":"Sort"},"description":"排序方式/Sort method: HOT, NEW, TOP, BEST, CONTROVERSIAL"},{"name":"filter_posts","in":"query","required":false,"schema":{"type":"array","items":{},"description":"过滤掉指定的帖子ID列表/Filter out specified post IDs","default":[],"title":"Filter Posts"},"description":"过滤掉指定的帖子ID列表/Filter out specified post IDs"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页参数/Pagination parameter for fetching next page","default":"","title":"After"},"description":"分页参数/Pagination parameter for fetching next page"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_popular_feed":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP流行推荐内容/Fetch Reddit APP Popular Feed","description":"# [中文]\n### 用途:\n- 获取Reddit APP流行/热门推荐内容,展示全站最受欢迎的帖子\n### 参数:\n- sort: 排序方式,可选: BEST(最佳), HOT(热门), NEW(最新), TOP(顶级), CONTROVERSIAL(有争议), RISING(上升中)\n- time: 时间范围,可选: ALL(全部时间), HOUR(一小时), DAY(一天), WEEK(一周), MONTH(一个月), YEAR(一年)\n- filter_posts: 过滤掉指定的帖子ID列表,用于避免重复获取\n- after: 分页参数,获取下一页时使用\n### 返回:\n- 流行推荐内容JSON数据,包含:\n  - 热门帖子列表\n  - 帖子详细信息(标题、内容、点赞数、评论数等)\n  - 分页信息(after参数用于下一页)\n\n# [English]\n### Purpose:\n- Fetch popular/trending recommended content on Reddit APP, displaying the most popular posts site-wide\n### Parameters:\n- sort: Sort method, options: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING\n- time: Time range, options: ALL, HOUR, DAY, WEEK, MONTH, YEAR\n- filter_posts: List of post IDs to filter out, used to avoid duplicate fetches\n- after: Pagination parameter for fetching next page\n### Returns:\n- JSON data of popular feed containing:\n  - List of trending posts\n  - Detailed post information (title, content, upvotes, comments, etc.)\n  - Pagination information (after parameter for next page)\n\n# [示例/Example]\nsort=\"HOT\"\ntime=\"DAY\"\nfilter_posts=[]\nafter=\"\"","operationId":"fetch_popular_feed_api_v1_reddit_app_fetch_popular_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING","default":"BEST","title":"Sort"},"description":"排序方式/Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING"},{"name":"time","in":"query","required":false,"schema":{"type":"string","description":"时间范围/Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR","default":"ALL","title":"Time"},"description":"时间范围/Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR"},{"name":"filter_posts","in":"query","required":false,"schema":{"type":"array","items":{},"description":"过滤帖子ID列表/Filter post IDs","default":[],"title":"Filter Posts"},"description":"过滤帖子ID列表/Filter post IDs"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页参数/Pagination parameter","default":"","title":"After"},"description":"分页参数/Pagination parameter"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_games_feed":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP游戏推荐内容/Fetch Reddit APP Games Feed","description":"# [中文]\n### 用途:\n- 获取Reddit APP游戏相关的推荐内容,展示游戏社区的热门帖子\n### 参数:\n- sort: 排序方式,可选: NEW(最新), HOT(热门), TOP(顶级), RISING(上升中)\n- time: 时间范围,可选: ALL(全部时间), HOUR(一小时), DAY(一天), WEEK(一周), MONTH(一个月), YEAR(一年)\n- after: 分页参数,获取下一页时使用\n### 返回:\n- 游戏推荐内容JSON数据,包含:\n  - 游戏相关帖子列表\n  - 游戏社区讨论\n  - 游戏新闻和更新\n\n# [English]\n### Purpose:\n- Fetch gaming-related recommended content on Reddit APP, displaying popular posts from gaming communities\n### Parameters:\n- sort: Sort method, options: NEW, HOT, TOP, RISING\n- time: Time range, options: ALL, HOUR, DAY, WEEK, MONTH, YEAR\n- after: Pagination parameter for fetching next page\n### Returns:\n- JSON data of games feed containing:\n  - List of gaming-related posts\n  - Gaming community discussions\n  - Game news and updates\n\n# [示例/Example]\nsort=\"HOT\"\ntime=\"WEEK\"\nafter=\"\"","operationId":"fetch_games_feed_api_v1_reddit_app_fetch_games_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort method: NEW, HOT, TOP, RISING","default":"NEW","title":"Sort"},"description":"排序方式/Sort method: NEW, HOT, TOP, RISING"},{"name":"time","in":"query","required":false,"schema":{"type":"string","description":"时间范围/Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR","default":"ALL","title":"Time"},"description":"时间范围/Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页参数/Pagination parameter","default":"","title":"After"},"description":"分页参数/Pagination parameter"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_news_feed":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP资讯推荐内容/Fetch Reddit APP News Feed","description":"# [中文]\n### 用途:\n- 获取Reddit APP新闻资讯推荐内容,展示最新的新闻和时事讨论\n### 参数:\n- subtopic_ids: 子话题ID列表,默认[\"all\"]表示所有新闻类别\n- after: 分页参数,获取下一页时使用\n### 返回:\n- 新闻推荐内容JSON数据,包含:\n  - 新闻帖子列表\n  - 时事讨论\n  - 热点话题\n  - 新闻来源和链接\n\n# [English]\n### Purpose:\n- Fetch news-related recommended content on Reddit APP, displaying latest news and current affairs discussions\n### Parameters:\n- subtopic_ids: List of subtopic IDs, default [\"all\"] means all news categories\n- after: Pagination parameter for fetching next page\n### Returns:\n- JSON data of news feed containing:\n  - List of news posts\n  - Current affairs discussions\n  - Trending topics\n  - News sources and links\n\n# [示例/Example]\nsubtopic_ids=[\"all\"]\nafter=\"\"","operationId":"fetch_news_feed_api_v1_reddit_app_fetch_news_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subtopic_ids","in":"query","required":false,"schema":{"type":"array","items":{},"description":"子话题ID列表/Subtopic IDs list","default":["all"],"title":"Subtopic Ids"},"description":"子话题ID列表/Subtopic IDs list"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页参数/Pagination parameter","default":"","title":"After"},"description":"分页参数/Pagination parameter"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_post_details":{"get":{"tags":["Reddit-APP-API"],"summary":"获取单个Reddit帖子详情/Fetch Single Reddit Post Details","description":"# [中文]\n## 用途:\n- 根据帖子ID获取单个帖子详情\n- 可选择性包含特定评论的上下文\n\n## 参数:\n- post_id: 帖子ID，格式如 \"t3_XXXXXX\"\n- include_comment_id: 是否包含特定评论ID，默认False\n- comment_id: 评论ID（当include_comment_id为True时使用），格式如 \"t1_XXXXXX\"\n\n## 返回:\n- 包含帖子详细信息的数据，包括:\n  - 帖子内容、标题、作者\n  - 统计数据（点赞数、评论数等）\n  - 版块信息\n  - 奖励信息\n  - 媒体资源\n  - 推荐原因等\n\n## 注意:\n- **APP接口的ID格式与Web接口不同，需要添加类型前缀**\n- 帖子ID前缀: t3_ (例如: t3_1ojnh50)\n- 评论ID前缀: t1_ (例如: t1_abcd123)\n\n---\n\n# [English]\n## Purpose:\n- Fetch single post details by post ID\n- Optionally include context for specific comments\n\n## Parameters:\n- post_id: Post ID, format like \"t3_XXXXXX\"\n- include_comment_id: Whether to include specific comment ID, default False\n- comment_id: Comment ID (used when include_comment_id is True), format like \"t1_XXXXXX\"\n\n## Returns:\n- Data containing detailed post information including:\n  - Post content, title, author\n  - Statistics (upvotes, comment count, etc.)\n  - Subreddit information\n  - Award information\n  - Media resources\n  - Recommendation reasons, etc.\n\n## Note:\n- **APP API ID format differs from Web API, requires type prefix**\n- Post ID prefix: t3_ (e.g., t3_1ojnh50)\n- Comment ID prefix: t1_ (e.g., t1_abcd123)\n\n# [示例/Example]\npost_id=\"t3_1ojnh50\"","operationId":"fetch_post_details_api_v1_reddit_app_fetch_post_details_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":true,"schema":{"type":"string","description":"帖子ID/Post ID (e.g., t3_1ojnh50)","title":"Post Id"},"description":"帖子ID/Post ID (e.g., t3_1ojnh50)"},{"name":"include_comment_id","in":"query","required":false,"schema":{"type":"boolean","description":"是否包含特定评论ID/Include specific comment ID","default":false,"title":"Include Comment Id"},"description":"是否包含特定评论ID/Include specific comment ID"},{"name":"comment_id","in":"query","required":false,"schema":{"type":"string","description":"评论ID/Comment ID (when include_comment_id is True)","default":"","title":"Comment Id"},"description":"评论ID/Comment ID (when include_comment_id is True)"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_post_details_batch":{"get":{"tags":["Reddit-APP-API"],"summary":"批量获取Reddit帖子详情(最多5条)/Fetch Reddit Post Details in Batch (Max 5)","description":"# [中文]\n## 用途:\n- 根据帖子ID列表批量获取帖子详情\n- 支持最多5条帖子的批量查询\n- 可选择性包含特定评论的上下文\n\n## 参数:\n- post_ids: 帖子ID列表，逗号分隔，格式如 \"t3_XXXXXX,t3_YYYYYY\"，最多支持5条\n- include_comment_id: 是否包含特定评论ID，默认False\n- comment_id: 评论ID（当include_comment_id为True时使用），格式如 \"t1_XXXXXX\"\n\n## 返回:\n- 包含帖子详细信息的数据，包括:\n  - 帖子内容、标题、作者\n  - 统计数据（点赞数、评论数等）\n  - 版块信息\n  - 奖励信息\n  - 媒体资源\n  - 推荐原因等\n\n## 注意:\n- 最多支持5条帖子的批量查询\n- 超过5条将返回错误\n- **APP接口的ID格式与Web接口不同，需要添加类型前缀**\n- 帖子ID前缀: t3_ (例如: t3_1ojnh50)\n- 评论ID前缀: t1_ (例如: t1_abcd123)\n\n---\n\n# [English]\n## Purpose:\n- Fetch post details in batch by post ID list\n- Support batch query for up to 5 posts\n- Optionally include context for specific comments\n\n## Parameters:\n- post_ids: Post IDs comma-separated, format like \"t3_XXXXXX,t3_YYYYYY\", max 5 posts\n- include_comment_id: Whether to include specific comment ID, default False\n- comment_id: Comment ID (used when include_comment_id is True), format like \"t1_XXXXXX\"\n\n## Returns:\n- Data containing detailed post information including:\n  - Post content, title, author\n  - Statistics (upvotes, comment count, etc.)\n  - Subreddit information\n  - Award information\n  - Media resources\n  - Recommendation reasons, etc.\n\n## Notes:\n- Maximum 5 posts per batch query\n- Error will be returned if exceeds 5 posts\n- **APP API ID format differs from Web API, requires type prefix**\n- Post ID prefix: t3_ (e.g., t3_1ojnh50)\n- Comment ID prefix: t1_ (e.g., t1_abcd123)\n\n# [示例/Example]\npost_ids=\"t3_1ojnh50,t3_1ok432f,t3_1nwil8j\"","operationId":"fetch_post_details_batch_api_v1_reddit_app_fetch_post_details_batch_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_ids","in":"query","required":true,"schema":{"type":"string","description":"帖子ID列表，逗号分隔，最多5条/Post IDs comma-separated, max 5 (e.g., t3_1ojnh50,t3_1ok432f)","title":"Post Ids"},"description":"帖子ID列表，逗号分隔，最多5条/Post IDs comma-separated, max 5 (e.g., t3_1ojnh50,t3_1ok432f)"},{"name":"include_comment_id","in":"query","required":false,"schema":{"type":"boolean","description":"是否包含特定评论ID/Include specific comment ID","default":false,"title":"Include Comment Id"},"description":"是否包含特定评论ID/Include specific comment ID"},{"name":"comment_id","in":"query","required":false,"schema":{"type":"string","description":"评论ID/Comment ID (when include_comment_id is True)","default":"","title":"Comment Id"},"description":"评论ID/Comment ID (when include_comment_id is True)"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_post_details_batch_large":{"get":{"tags":["Reddit-APP-API"],"summary":"大批量获取Reddit帖子详情(最多30条)/Fetch Reddit Post Details in Large Batch (Max 30)","description":"# [中文]\n## 用途:\n- 根据帖子ID列表大批量获取帖子详情\n- 支持最多30条帖子的批量查询\n- 可选择性包含特定评论的上下文\n\n## 参数:\n- post_ids: 帖子ID列表，逗号分隔，格式如 \"t3_XXXXXX,t3_YYYYYY,...\"，最多支持30条\n- include_comment_id: 是否包含特定评论ID，默认False\n- comment_id: 评论ID（当include_comment_id为True时使用），格式如 \"t1_XXXXXX\"\n\n## 返回:\n- 包含帖子详细信息的数据，包括:\n  - 帖子内容、标题、作者\n  - 统计数据（点赞数、评论数等）\n  - 版块信息\n  - 奖励信息\n  - 媒体资源\n  - 推荐原因等\n\n## 注意:\n- 最多支持30条帖子的批量查询\n- 超过30条将返回错误\n- 大批量查询可能需要较长的响应时间\n- **APP接口的ID格式与Web接口不同，需要添加类型前缀**\n- 帖子ID前缀: t3_ (例如: t3_1ojnh50)\n- 评论ID前缀: t1_ (例如: t1_abcd123)\n\n---\n\n# [English]\n## Purpose:\n- Fetch post details in large batch by post ID list\n- Support batch query for up to 30 posts\n- Optionally include context for specific comments\n\n## Parameters:\n- post_ids: Post IDs comma-separated, format like \"t3_XXXXXX,t3_YYYYYY,...\", max 30 posts\n- include_comment_id: Whether to include specific comment ID, default False\n- comment_id: Comment ID (used when include_comment_id is True), format like \"t1_XXXXXX\"\n\n## Returns:\n- Data containing detailed post information including:\n  - Post content, title, author\n  - Statistics (upvotes, comment count, etc.)\n  - Subreddit information\n  - Award information\n  - Media resources\n  - Recommendation reasons, etc.\n\n## Notes:\n- Maximum 30 posts per batch query\n- Error will be returned if exceeds 30 posts\n- Large batch queries may take longer to respond\n- **APP API ID format differs from Web API, requires type prefix**\n- Post ID prefix: t3_ (e.g., t3_1ojnh50)\n- Comment ID prefix: t1_ (e.g., t1_abcd123)\n\n# [示例/Example]\npost_ids=\"t3_1ojnh50,t3_1ok432f,t3_1nwil8j,t3_1oj6vn6,t3_1nuenmd,...\"","operationId":"fetch_post_details_batch_large_api_v1_reddit_app_fetch_post_details_batch_large_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_ids","in":"query","required":true,"schema":{"type":"string","description":"帖子ID列表，逗号分隔，最多30条/Post IDs comma-separated, max 30 (e.g., t3_1ojnh50,t3_1ok432f,...)","title":"Post Ids"},"description":"帖子ID列表，逗号分隔，最多30条/Post IDs comma-separated, max 30 (e.g., t3_1ojnh50,t3_1ok432f,...)"},{"name":"include_comment_id","in":"query","required":false,"schema":{"type":"boolean","description":"是否包含特定评论ID/Include specific comment ID","default":false,"title":"Include Comment Id"},"description":"是否包含特定评论ID/Include specific comment ID"},{"name":"comment_id","in":"query","required":false,"schema":{"type":"string","description":"评论ID/Comment ID (when include_comment_id is True)","default":"","title":"Comment Id"},"description":"评论ID/Comment ID (when include_comment_id is True)"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_post_comments":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP帖子评论/Fetch Reddit APP Post Comments","description":"# [中文]\n### 用途:\n- 获取Reddit APP指定帖子下的评论\n### 参数:\n- post_id: 帖子ID，格式如 \"t3_XXXXXX\"\n- sort_type: 排序方式，支持CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM\n- after: 分页参数，获取下一页时使用，在commentForest里的最后一个评论节点中可以找到，例如$.data.postInfoById.commentForest.trees[-1].more.cursor\n### 返回:\n- 指定帖子下的评论JSON数据\n### 注意:\n- **APP接口的ID格式与Web接口不同，需要添加类型前缀**\n- 帖子ID前缀: t3_ (例如: t3_1ojnvca)\n\n# [English]\n### Purpose:\n- Fetch comments under a specified Reddit APP post\n### Parameters:\n- post_id: Post ID, format like \"t3_XXXXXX\"\n- sort_type: Sort method, supports HOT, NEW, TOP, BEST, CONTROVERSIAL\n- after: Pagination parameter for fetching the next page, can be found in the last comment node in commentForest, e.g., $.data.postInfoById.commentForest.trees[-1].more.cursor\n### Returns:\n- JSON data of comments under the specified post\n### Note:\n- **APP API ID format differs from Web API, requires type prefix**\n- Post ID prefix: t3_ (e.g., t3_1ojnvca)\n\n# [示例/Example]\npost_id=\"t3_1ojnvca\"\n\nsort=\"CONFIDENCE\"","operationId":"fetch_post_comments_api_v1_reddit_app_fetch_post_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":true,"schema":{"type":"string","description":"帖子ID/Post ID","title":"Post Id"},"description":"帖子ID/Post ID"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM","default":"CONFIDENCE","title":"Sort Type"},"description":"排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页参数/Pagination parameter for fetching next page","default":"","title":"After"},"description":"分页参数/Pagination parameter for fetching next page"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_comment_replies":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP评论回复（二级评论）/Fetch Reddit APP Comment Replies (Sub-comments)","description":"# [中文]\n### 用途:\n- 获取Reddit APP指定评论下的回复（二级评论/子评论）\n- 当评论节点有 more.cursor 字段时，使用此接口获取该评论的子评论\n### 参数:\n- post_id: 帖子ID，格式如 \"t3_XXXXXX\"\n- cursor: 评论游标，从评论数据的 more.cursor 字段获取，格式如 \"commenttree:ex:(xxx)\"\n- sort_type: 排序方式，支持CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM\n### 返回:\n- 指定评论下的回复JSON数据，包含：\n  - 子评论列表\n  - 每个子评论的详细信息（内容、作者、点赞数等）\n  - 分页信息\n### 使用步骤:\n1. 先调用 fetch_post_comments 获取帖子的一级评论\n2. 在返回数据中找到有子评论的节点（childCount > 0）\n3. 获取该节点的 more.cursor 值\n4. 使用该 cursor 调用本接口获取子评论\n### 注意:\n- cursor 值来自评论数据的 more.cursor 字段\n- 路径示例: $.data.postInfoById.commentForest.trees[*].more.cursor\n- cursor 格式类似: \"commenttree:ex:(RjiJd\"\n\n# [English]\n### Purpose:\n- Fetch replies (sub-comments/second-level comments) under a specified Reddit APP comment\n- Use this endpoint when a comment node has more.cursor field to get its sub-comments\n### Parameters:\n- post_id: Post ID, format like \"t3_XXXXXX\"\n- cursor: Comment cursor from the more.cursor field in comment data, format like \"commenttree:ex:(xxx)\"\n- sort_type: Sort method, supports CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM\n### Returns:\n- JSON data of replies under the specified comment, containing:\n  - List of sub-comments\n  - Detailed information for each sub-comment (content, author, upvotes, etc.)\n  - Pagination information\n### Usage Steps:\n1. First call fetch_post_comments to get top-level comments\n2. Find comment nodes with sub-comments (childCount > 0)\n3. Get the more.cursor value from that node\n4. Use that cursor to call this endpoint to fetch sub-comments\n### Note:\n- cursor value comes from the more.cursor field in comment data\n- Path example: $.data.postInfoById.commentForest.trees[*].more.cursor\n- cursor format example: \"commenttree:ex:(RjiJd\"\n\n# [示例/Example]\npost_id=\"t3_1qmup73\"\ncursor=\"commenttree:ex:(RjiJd\"\nsort_type=\"CONFIDENCE\"","operationId":"fetch_comment_replies_api_v1_reddit_app_fetch_comment_replies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"post_id","in":"query","required":true,"schema":{"type":"string","description":"帖子ID/Post ID (e.g., t3_1qmup73)","title":"Post Id"},"description":"帖子ID/Post ID (e.g., t3_1qmup73)"},{"name":"cursor","in":"query","required":true,"schema":{"type":"string","description":"评论游标/Comment cursor from more.cursor field (e.g., commenttree:ex:(RjiJd)","title":"Cursor"},"description":"评论游标/Comment cursor from more.cursor field (e.g., commenttree:ex:(RjiJd)"},{"name":"sort_type","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM","default":"CONFIDENCE","title":"Sort Type"},"description":"排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_subreddit_style":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP版块规则样式信息/Fetch Reddit APP Subreddit Rules and Style Info","description":"# [中文]\n### 用途:\n- 获取Reddit APP指定版块的规则和样式信息\n### 参数:\n- subreddit_name: 版块名称(不带r/前缀)\n### 返回:\n- 指定版块的规则和样式信息JSON数据\n\n# [English]\n### Purpose:\n- Fetch rules and style information of a specified Reddit APP subreddit\n### Parameters:\n- subreddit_name: Subreddit name\n### Returns:\n- JSON data of rules and style information of the specified subreddit\n\n# [示例/Example]\nsubreddit_name=\"pics\"","operationId":"fetch_subreddit_style_api_v1_reddit_app_fetch_subreddit_style_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subreddit_name","in":"query","required":false,"schema":{"type":"string","description":"版块名称/Subreddit name","default":"pics","title":"Subreddit Name"},"description":"版块名称/Subreddit name"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_subreddit_post_channels":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP版块帖子频道信息/Fetch Reddit APP Subreddit Post Channels","description":"# [中文]\n### 用途:\n- 获取Reddit APP指定版块的帖子频道信息\n### 参数:\n- subreddit_name: 版块名称(不带r/前缀)\n- sort: 排序方式，支持HOT, NEW, TOP, CONTROVERSIAL, RISING\n- range: 时间范围，支持HOUR, DAY, WEEK, MONTH, YEAR, ALL\n### 返回:\n- 指定版块的帖子频道信息JSON数据\n\n# [English]\n### Purpose:\n- Fetch post channel information of a specified Reddit APP subreddit\n### Parameters:\n- subreddit_name: Subreddit name\n- sort: Sort method, supports HOT, NEW, TOP, CONTROVERSIAL, RISING\n- range: Time range, supports HOUR, DAY, WEEK, MONTH, YEAR, ALL\n### Returns:\n- JSON data of post channel information of the specified subreddit\n\n# [示例/Example]\nsubreddit_name=\"pics\"","operationId":"fetch_subreddit_post_channels_api_v1_reddit_app_fetch_subreddit_post_channels_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subreddit_name","in":"query","required":false,"schema":{"type":"string","description":"版块名称/Subreddit name","default":"pics","title":"Subreddit Name"},"description":"版块名称/Subreddit name"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING","default":"HOT","title":"Sort"},"description":"排序方式/Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING"},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"时间范围/Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL","default":"DAY","title":"Range"},"description":"时间范围/Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_subreddit_info":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP版块信息/Fetch Reddit APP Subreddit Info","description":"# [中文]\n### 用途:\n- 获取Reddit APP指定版块的详细信息,包括版块描述、成员数量、创建时间、规则等元数据\n### 参数:\n- subreddit_name: 版块名称(不带r/前缀),例如\"pics\", \"funny\", \"AskReddit\"等\n### 返回:\n- 指定版块的详细信息JSON数据\n# [English]\n### Purpose:\n- Fetch detailed information of a specified Reddit APP subreddit, including description, subscriber count, creation time, rules, and other metadata\n### Parameters:\n- subreddit_name: Subreddit name (without r/ prefix), e.g., \"pics\", \"funny\", \"AskReddit\"\n### Returns:\n- JSON data containing detailed subreddit information\n\n# [示例/Example]\nsubreddit_name=\"pics\"","operationId":"fetch_subreddit_info_api_v1_reddit_app_fetch_subreddit_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subreddit_name","in":"query","required":false,"schema":{"type":"string","description":"版块名称/Subreddit name","default":"pics","title":"Subreddit Name"},"description":"版块名称/Subreddit name"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_subreddit_settings":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP版块设置/Fetch Reddit APP Subreddit Settings","description":"# [中文]\n### 用途:\n- 获取Reddit APP指定版块的设置信息,包括发帖规则、用户标签设置、审核设置等配置信息\n### 参数:\n- subreddit_id: 版块ID,格式为t5_开头的唯一标识符,例如\"t5_2qh0u\"(可从fetch_subreddit_info接口获取版块ID)\n### 返回:\n- 指定版块的设置信息JSON数据,包含以下主要字段:\n  - subredditType: 版块类型(public/private/restricted)\n  - submissionType: 允许提交的内容类型(any/link/self)\n  - allowImages: 是否允许图片\n  - allowVideos: 是否允许视频\n  - allowPolls: 是否允许投票\n  - suggestedCommentSort: 建议的评论排序方式\n  - spoilersEnabled: 是否启用剧透标记\n  - allowedPostTypes: 允许的帖子类型配置\n  - contentOptions: 内容选项设置\n  - flairSettings: 用户/帖子标签设置\n### 注意事项:\n- 需要先通过fetch_subreddit_info接口获取版块ID(subreddit.id字段)\n- 版块ID格式必须为\"t5_\"开头\n- **APP接口的ID格式与Web接口不同，需要添加类型前缀**\n- 版块ID前缀: t5_ (例如: t5_2qh0u)\n\n# [English]\n### Purpose:\n- Fetch settings information of a specified Reddit APP subreddit, including posting rules, flair settings, moderation settings, and other configurations\n### Parameters:\n- subreddit_id: Subreddit ID with format starting with t5_, e.g., \"t5_2qh0u\" (can be obtained from the fetch_subreddit_info endpoint)\n### Returns:\n- JSON data containing subreddit settings with the following main fields:\n  - subredditType: Subreddit type (public/private/restricted)\n  - submissionType: Allowed submission content types (any/link/self)\n  - allowImages: Whether images are allowed\n  - allowVideos: Whether videos are allowed\n  - allowPolls: Whether polls are allowed\n  - suggestedCommentSort: Suggested comment sort method\n  - spoilersEnabled: Whether spoiler tags are enabled\n  - allowedPostTypes: Allowed post types configuration\n  - contentOptions: Content options settings\n  - flairSettings: User/post flair settings\n### Notes:\n- You need to first get the subreddit ID (subreddit.id field) via the fetch_subreddit_info endpoint\n- Subreddit ID format must start with \"t5_\"\n- **APP API ID format differs from Web API, requires type prefix**\n- Subreddit ID prefix: t5_ (e.g., t5_2qh0u)\n\n# [示例/Example]\nsubreddit_id=\"t5_2qh0u\"","operationId":"fetch_subreddit_settings_api_v1_reddit_app_fetch_subreddit_settings_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subreddit_id","in":"query","required":true,"schema":{"type":"string","description":"版块ID/Subreddit ID (format: t5_xxxxx)","title":"Subreddit Id"},"description":"版块ID/Subreddit ID (format: t5_xxxxx)"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_search_typeahead":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP搜索自动补全建议/Fetch Reddit APP Search Typeahead Suggestions","description":"# [中文]\n### 用途:\n- 获取Reddit APP搜索框的自动补全建议,包括推荐的版块、用户和搜索词\n### 参数:\n- query: 搜索关键词,输入的搜索文本\n- safe_search: 安全搜索设置,可选值为\"unset\"(未设置)或\"strict\"(严格模式)\n- allow_nsfw: 是否允许显示NSFW(成人)内容,\"0\"表示不允许,\"1\"表示允许\n### 返回:\n- 搜索建议JSON数据,包含以下类型的建议:\n  - 相关版块(subreddits)\n  - 相关用户(users)\n  - 搜索词建议(search suggestions)\n  - 热门话题(trending topics)\n\n# [English]\n### Purpose:\n- Fetch autocomplete suggestions for the Reddit APP search box, including recommended subreddits, users, and search terms\n### Parameters:\n- query: Search keyword, the search text being typed\n- safe_search: Safe search setting, options are \"unset\" or \"strict\"\n- allow_nsfw: Whether to allow NSFW (adult) content display, \"0\" means disallow, \"1\" means allow\n### Returns:\n- JSON data of search suggestions containing the following types:\n  - Related subreddits\n  - Related users\n  - Search term suggestions\n  - Trending topics\n\n# [示例/Example]\nquery=\"programming\"\nsafe_search=\"unset\"\nallow_nsfw=\"0\"","operationId":"fetch_search_typeahead_api_v1_reddit_app_fetch_search_typeahead_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search query","title":"Query"},"description":"搜索关键词/Search query"},{"name":"safe_search","in":"query","required":false,"schema":{"type":"string","description":"安全搜索设置/Safe search setting: unset, strict","default":"unset","title":"Safe Search"},"description":"安全搜索设置/Safe search setting: unset, strict"},{"name":"allow_nsfw","in":"query","required":false,"schema":{"type":"string","description":"是否允许NSFW内容/Allow NSFW content: 0 or 1","default":"0","title":"Allow Nsfw"},"description":"是否允许NSFW内容/Allow NSFW content: 0 or 1"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_dynamic_search":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP动态搜索结果/Fetch Reddit APP Dynamic Search Results","description":"# [中文]\n### 用途:\n- 执行Reddit APP动态搜索,支持搜索帖子、社区、评论、媒体和用户\n### 参数:\n- query: 搜索关键词\n- search_type: 搜索类型,可选值:\n  - post: 搜索帖子(默认)\n  - community: 搜索社区/版块\n  - comment: 搜索评论\n  - media: 搜索媒体(图片/视频/GIF)\n  - people: 搜索用户\n- sort: 排序方式(仅适用于post/comment/media类型),可选值:\n  - RELEVANCE: 相关性\n  - HOT: 热门\n  - TOP: 最受欢迎\n  - NEW: 最新\n  - COMMENTS: 评论数(仅适用于post类型)\n- time_range: 时间范围(仅适用于post/media类型),可选值:\n  - all: 所有时间\n  - year: 去年\n  - month: 上个月\n  - week: 上周\n  - day: 今天\n  - hour: 过去1小时\n- safe_search: 安全搜索设置,\"unset\"或\"strict\"\n- allow_nsfw: 是否允许NSFW内容,\"0\"或\"1\"\n- after: 分页参数,用于获取下一页结果\n### 返回:\n- 搜索结果JSON数据,包含:\n  - 匹配的结果列表(根据search_type不同返回不同类型的数据)\n  - 分页信息\n### 注意:\n- community和people类型不支持sort和time_range参数\n- COMMENTS排序方式仅适用于post类型\n- time_range参数仅适用于post和media类型\n\n# [English]\n### Purpose:\n- Perform Reddit APP dynamic search, supporting posts, communities, comments, media, and users\n### Parameters:\n- query: Search keyword\n- search_type: Search type, options:\n  - post: Search posts (default)\n  - community: Search communities/subreddits\n  - comment: Search comments\n  - media: Search media (images/videos/GIFs)\n  - people: Search users\n- sort: Sort method (only for post/comment/media types), options:\n  - RELEVANCE: By relevance\n  - HOT: Hot/trending\n  - TOP: Most popular\n  - NEW: Newest\n  - COMMENTS: By comment count (only for post type)\n- time_range: Time range (only for post/media types), options:\n  - all: All time\n  - year: Past year\n  - month: Past month\n  - week: Past week\n  - day: Today\n  - hour: Past hour\n- safe_search: Safe search setting, \"unset\" or \"strict\"\n- allow_nsfw: Allow NSFW content, \"0\" or \"1\"\n- after: Pagination parameter for fetching next page\n### Returns:\n- JSON data of search results containing:\n  - List of matching results (different data types based on search_type)\n  - Pagination information\n### Notes:\n- community and people types do not support sort and time_range parameters\n- COMMENTS sort option only applies to post type\n- time_range parameter only applies to post and media types\n\n# [示例/Example]\nquery=\"python programming\"\nsearch_type=\"post\"\nsort=\"RELEVANCE\"\ntime_range=\"all\"\nsafe_search=\"unset\"\nallow_nsfw=\"0\"\nafter=\"\"","operationId":"fetch_dynamic_search_api_v1_reddit_app_fetch_dynamic_search_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"搜索关键词/Search query","title":"Query"},"description":"搜索关键词/Search query"},{"name":"search_type","in":"query","required":false,"schema":{"type":"string","description":"搜索类型/Search type: post(帖子), community(社区), comment(评论), media(媒体), people(用户)","default":"post","title":"Search Type"},"description":"搜索类型/Search type: post(帖子), community(社区), comment(评论), media(媒体), people(用户)"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式(仅适用于post/comment/media)/Sort method (only for post/comment/media): RELEVANCE(相关性), HOT(热门), TOP(最受欢迎), NEW(最新), COMMENTS(评论数,仅post)","title":"Sort"},"description":"排序方式(仅适用于post/comment/media)/Sort method (only for post/comment/media): RELEVANCE(相关性), HOT(热门), TOP(最受欢迎), NEW(最新), COMMENTS(评论数,仅post)"},{"name":"time_range","in":"query","required":false,"schema":{"type":"string","description":"时间范围(仅适用于post/media)/Time range (only for post/media): all(所有时间), year(去年), month(上月), week(上周), day(今天), hour(过去1小时)","title":"Time Range"},"description":"时间范围(仅适用于post/media)/Time range (only for post/media): all(所有时间), year(去年), month(上月), week(上周), day(今天), hour(过去1小时)"},{"name":"safe_search","in":"query","required":false,"schema":{"type":"string","description":"安全搜索设置/Safe search setting: unset, strict","default":"unset","title":"Safe Search"},"description":"安全搜索设置/Safe search setting: unset, strict"},{"name":"allow_nsfw","in":"query","required":false,"schema":{"type":"string","description":"是否允许NSFW内容/Allow NSFW content: 0, 1","default":"0","title":"Allow Nsfw"},"description":"是否允许NSFW内容/Allow NSFW content: 0, 1"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页参数/Pagination parameter","default":"","title":"After"},"description":"分页参数/Pagination parameter"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_community_highlights":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP社区亮点/Fetch Reddit APP Community Highlights","description":"# [中文]\n### 用途:\n- 获取Reddit APP指定社区的精选亮点内容,包括热门帖子和重要公告\n### 参数:\n- subreddit_id: 版块ID,格式为\"t5_\"开头,可从fetch_subreddit_info接口获取\n### 返回:\n- 社区亮点JSON数据,包含:\n  - 精选帖子列表\n  - 置顶公告\n  - 社区重要动态\n  - 推荐内容\n### 注意:\n- **APP接口的ID格式与Web接口不同，需要添加类型前缀**\n- 版块ID前缀: t5_ (例如: t5_2qh0u)\n\n# [English]\n### Purpose:\n- Fetch featured highlight content of a specified Reddit APP community, including popular posts and important announcements\n### Parameters:\n- subreddit_id: Subreddit ID starting with \"t5_\", can be obtained from fetch_subreddit_info endpoint\n### Returns:\n- JSON data of community highlights containing:\n  - Featured post list\n  - Pinned announcements\n  - Important community updates\n  - Recommended content\n### Note:\n- **APP API ID format differs from Web API, requires type prefix**\n- Subreddit ID prefix: t5_ (e.g., t5_2qh0u)\n\n# [示例/Example]\nsubreddit_id=\"t5_2qh0u\"","operationId":"fetch_community_highlights_api_v1_reddit_app_fetch_community_highlights_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subreddit_id","in":"query","required":true,"schema":{"type":"string","description":"版块ID/Subreddit ID (format: t5_xxxxx)","title":"Subreddit Id"},"description":"版块ID/Subreddit ID (format: t5_xxxxx)"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_trending_searches":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP今日热门搜索/Fetch Reddit APP Trending Searches","description":"# [中文]\n### 用途:\n- 获取Reddit APP当前热门搜索话题和趋势内容\n### 参数:\n- 无需参数\n### 返回:\n- 热门搜索JSON数据,包含:\n  - 热门搜索关键词列表\n  - 趋势话题\n  - 每个话题的搜索量和热度\n  - 相关帖子预览\n\n# [English]\n### Purpose:\n- Fetch currently trending search topics and content on Reddit APP\n### Parameters:\n- No parameters required\n### Returns:\n- JSON data of trending searches containing:\n  - List of trending search keywords\n  - Trending topics\n  - Search volume and popularity for each topic\n  - Related post previews\n\n# [示例/Example]\n无需参数/No parameters required","operationId":"fetch_trending_searches_api_v1_reddit_app_fetch_trending_searches_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_user_profile":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP用户资料信息/Fetch Reddit APP User Profile","description":"# [中文]\n### 用途:\n- 获取Reddit APP指定用户的详细资料信息\n### 参数:\n- username: Reddit用户名(不带u/前缀)\n### 返回:\n- 用户资料JSON数据,包含:\n  - 用户名和ID\n  - 账号创建时间\n  - Karma值(帖子karma和评论karma)\n  - 头像和横幅图片\n  - 个人简介\n  - 是否验证账号\n  - 徽章和奖励\n  - 关注者数量\n\n# [English]\n### Purpose:\n- Fetch detailed profile information of a specified Reddit APP user\n### Parameters:\n- username: Reddit username (without u/ prefix)\n### Returns:\n- JSON data of user profile containing:\n  - Username and ID\n  - Account creation date\n  - Karma values (post karma and comment karma)\n  - Avatar and banner images\n  - Bio/description\n  - Verification status\n  - Badges and awards\n  - Follower count\n\n# [示例/Example]\nusername=\"spez\"","operationId":"fetch_user_profile_api_v1_reddit_app_fetch_user_profile_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_user_active_subreddits":{"get":{"tags":["Reddit-APP-API"],"summary":"获取用户活跃的社区列表/Fetch User's Active Subreddits","description":"# [中文]\n### 用途:\n- 获取指定用户最活跃的Reddit社区列表\n### 参数:\n- username: Reddit用户名\n### 返回:\n- 用户活跃社区JSON数据,包含:\n  - 用户最常发帖/评论的社区列表\n  - 每个社区的活跃度信息\n  - 社区基本信息(名称、图标、成员数等)\n\n# [English]\n### Purpose:\n- Fetch list of Reddit communities where the specified user is most active\n### Parameters:\n- username: Reddit username\n### Returns:\n- JSON data of user's active communities containing:\n  - List of communities where user posts/comments most\n  - Activity level in each community\n  - Basic community information (name, icon, member count, etc.)\n\n# [示例/Example]\nusername=\"spez\"","operationId":"fetch_user_active_subreddits_api_v1_reddit_app_fetch_user_active_subreddits_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_user_comments":{"get":{"tags":["Reddit-APP-API"],"summary":"获取用户评论列表/Fetch User Comments","description":"# [中文]\n### 用途:\n- 获取指定用户发表的评论列表\n### 参数:\n- username: Reddit用户名\n- sort: 排序方式,可选值: NEW(最新), TOP(最热), HOT(热门), CONTROVERSIAL(有争议)\n- page_size: 每页返回的评论数量,默认25条\n- after: 分页参数,用于获取下一页\n### 返回:\n- 用户评论列表JSON数据,包含:\n  - 评论内容\n  - 评论所在的帖子信息\n  - 评论时间\n  - 点赞数\n  - 回复数\n  - 分页信息\n\n# [English]\n### Purpose:\n- Fetch list of comments posted by the specified user\n### Parameters:\n- username: Reddit username\n- sort: Sort method, options: NEW (newest), TOP (top rated), HOT (hot), CONTROVERSIAL (controversial)\n- page_size: Number of comments per page, default 25\n- after: Pagination parameter for fetching next page\n### Returns:\n- JSON data of user comments containing:\n  - Comment content\n  - Information about the post where comment was made\n  - Comment timestamp\n  - Upvote count\n  - Reply count\n  - Pagination information\n\n# [示例/Example]\nusername=\"spez\"\nsort=\"NEW\"\npage_size=25\nafter=\"\"","operationId":"fetch_user_comments_api_v1_reddit_app_fetch_user_comments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort method: NEW, TOP, HOT, CONTROVERSIAL","default":"NEW","title":"Sort"},"description":"排序方式/Sort method: NEW, TOP, HOT, CONTROVERSIAL"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","description":"每页数量/Page size (default: 25)","default":25,"title":"Page Size"},"description":"每页数量/Page size (default: 25)"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页参数/Pagination parameter","default":"","title":"After"},"description":"分页参数/Pagination parameter"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_user_posts":{"get":{"tags":["Reddit-APP-API"],"summary":"获取用户发布的帖子列表/Fetch User Posts","description":"# [中文]\n### 用途:\n- 获取指定用户发布的帖子列表\n### 参数:\n- username: Reddit用户名\n- sort: 排序方式,可选值: NEW(最新), TOP(最热), HOT(热门), CONTROVERSIAL(有争议)\n- after: 分页参数,用于获取下一页\n### 返回:\n- 用户帖子列表JSON数据,包含:\n  - 帖子标题和内容\n  - 发布时间\n  - 所属版块\n  - 点赞数和评论数\n  - 帖子类型(文本/图片/视频/链接)\n  - 媒体内容(如有)\n  - 分页信息\n\n# [English]\n### Purpose:\n- Fetch list of posts submitted by the specified user\n### Parameters:\n- username: Reddit username\n- sort: Sort method, options: NEW (newest), TOP (top rated), HOT (hot), CONTROVERSIAL (controversial)\n- after: Pagination parameter for fetching next page\n### Returns:\n- JSON data of user posts containing:\n  - Post title and content\n  - Submission time\n  - Subreddit\n  - Upvote and comment counts\n  - Post type (text/image/video/link)\n  - Media content (if any)\n  - Pagination information\n\n# [示例/Example]\nusername=\"spez\"\nsort=\"NEW\"\nafter=\"\"","operationId":"fetch_user_posts_api_v1_reddit_app_fetch_user_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort method: NEW, TOP, HOT, CONTROVERSIAL","default":"NEW","title":"Sort"},"description":"排序方式/Sort method: NEW, TOP, HOT, CONTROVERSIAL"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页参数/Pagination parameter","default":"","title":"After"},"description":"分页参数/Pagination parameter"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_subreddit_feed":{"get":{"tags":["Reddit-APP-API"],"summary":"获取Reddit APP版块Feed内容/Fetch Reddit APP Subreddit Feed","description":"# [中文]\n### 用途:\n- 获取指定Reddit版块的Feed内容流,展示该版块的帖子列表\n### 参数:\n- subreddit_name: 版块名称(不带r/前缀),如\"pics\", \"funny\"等\n- sort: 排序方式,可选: BEST(最佳), HOT(热门), NEW(最新), TOP(顶级), CONTROVERSIAL(有争议), RISING(上升中)\n- filter_posts: 过滤掉指定的帖子ID列表\n- after: 分页参数,获取下一页时使用\n### 返回:\n- 版块Feed JSON数据,包含:\n  - 该版块的帖子列表\n  - 帖子详细信息\n  - 版块元数据\n  - 分页信息\n\n# [English]\n### Purpose:\n- Fetch feed content stream of a specified Reddit subreddit, displaying the post list of that subreddit\n### Parameters:\n- subreddit_name: Subreddit name (without r/ prefix), e.g., \"pics\", \"funny\"\n- sort: Sort method, options: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING\n- filter_posts: List of post IDs to filter out\n- after: Pagination parameter for fetching next page\n### Returns:\n- JSON data of subreddit feed containing:\n  - List of posts in the subreddit\n  - Detailed post information\n  - Subreddit metadata\n  - Pagination information\n\n# [示例/Example]\nsubreddit_name=\"AskReddit\"\nsort=\"HOT\"\nfilter_posts=[]\nafter=\"\"","operationId":"fetch_subreddit_feed_api_v1_reddit_app_fetch_subreddit_feed_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subreddit_name","in":"query","required":true,"schema":{"type":"string","description":"版块名称/Subreddit name","title":"Subreddit Name"},"description":"版块名称/Subreddit name"},{"name":"sort","in":"query","required":false,"schema":{"type":"string","description":"排序方式/Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING","default":"BEST","title":"Sort"},"description":"排序方式/Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING"},{"name":"filter_posts","in":"query","required":false,"schema":{"type":"array","items":{},"description":"过滤帖子ID列表/Filter post IDs","default":[],"title":"Filter Posts"},"description":"过滤帖子ID列表/Filter post IDs"},{"name":"after","in":"query","required":false,"schema":{"type":"string","description":"分页参数/Pagination parameter","default":"","title":"After"},"description":"分页参数/Pagination parameter"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/check_subreddit_muted":{"get":{"tags":["Reddit-APP-API"],"summary":"检查版块是否静音/Check if Subreddit is Muted","description":"# [中文]\n### 用途:\n- 检查指定Reddit版块是否被当前用户静音\n### 参数:\n- subreddit_id: 版块ID,格式为\"t5_\"开头,可从fetch_subreddit_info接口获取\n### 返回:\n- 静音状态JSON数据,包含:\n  - isMuted: 是否静音的布尔值\n  - subredditId: 版块ID\n### 注意:\n- **APP接口的ID格式与Web接口不同，需要添加类型前缀**\n- 版块ID前缀: t5_ (例如: t5_2qh0u)\n\n# [English]\n### Purpose:\n- Check if a specified Reddit subreddit is muted by the current user\n### Parameters:\n- subreddit_id: Subreddit ID starting with \"t5_\", can be obtained from fetch_subreddit_info endpoint\n### Returns:\n- JSON data of mute status containing:\n  - isMuted: Boolean value indicating if muted\n  - subredditId: Subreddit ID\n### Note:\n- **APP API ID format differs from Web API, requires type prefix**\n- Subreddit ID prefix: t5_ (e.g., t5_2qh0u)\n\n# [示例/Example]\nsubreddit_id=\"t5_2qh0u\"","operationId":"check_subreddit_muted_api_v1_reddit_app_check_subreddit_muted_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"subreddit_id","in":"query","required":true,"schema":{"type":"string","description":"版块ID/Subreddit ID (format: t5_xxxxx)","title":"Subreddit Id"},"description":"版块ID/Subreddit ID (format: t5_xxxxx)"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reddit/app/fetch_user_trophies":{"get":{"tags":["Reddit-APP-API"],"summary":"获取用户公开奖杯/Fetch User Public Trophies","description":"# [中文]\n### 用途:\n- 获取指定Reddit用户的公开奖杯/成就列表\n### 参数:\n- username: Reddit用户名(不带u/前缀)\n### 返回:\n- 用户奖杯JSON数据,包含:\n  - 奖杯列表(trophy list)\n  - 每个奖杯的详细信息:\n    - 奖杯名称\n    - 奖杯描述\n    - 奖杯图标URL\n    - 获得时间\n  - 特殊徽章和成就\n\n# [English]\n### Purpose:\n- Fetch public trophies/achievements list of a specified Reddit user\n### Parameters:\n- username: Reddit username (without u/ prefix)\n### Returns:\n- JSON data of user trophies containing:\n  - Trophy list\n  - Detailed information for each trophy:\n    - Trophy name\n    - Trophy description\n    - Trophy icon URL\n    - Award date\n  - Special badges and achievements\n\n# [示例/Example]\nusername=\"spez\"","operationId":"fetch_user_trophies_api_v1_reddit_app_fetch_user_trophies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"用户名/Username","title":"Username"},"description":"用户名/Username"},{"name":"need_format","in":"query","required":false,"schema":{"type":"boolean","description":"是否需要清洗数据/Whether to clean and format the data","default":false,"title":"Need Format"},"description":"是否需要清洗数据/Whether to clean and format the data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/hybrid/video_data":{"get":{"tags":["Hybrid-Parsing","Hybrid-Parsing"],"summary":"混合解析单一视频接口/Hybrid parsing single video endpoint","description":"# [中文]\n### 用途:\n- 该接口用于解析抖音/TikTok单一视频的数据。\n### 参数:\n- `url`: 视频链接、分享链接、分享文本。\n### 返回:\n- `data`: 视频数据。\n\n# [English]\n### Purpose:\n- This endpoint is used to parse data of a single Douyin/TikTok video.\n### Parameters:\n- `url`: Video link, share link, or share text.\n### Returns:\n- `data`: Video data.\n\n# [Example]\nurl = \"https://v.douyin.com/L4FJNR3/\"","operationId":"hybrid_parsing_single_video_api_v1_hybrid_video_data_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","title":"Url"},"example":"https://v.douyin.com/L4FJNR3/"},{"name":"minimal","in":"query","required":false,"schema":{"type":"boolean","description":"是否返回最小数据/Whether to return minimal data","default":false,"title":"Minimal"},"description":"是否返回最小数据/Whether to return minimal data"},{"name":"base64_url","in":"query","required":false,"schema":{"type":"boolean","description":"是否Base64编码提交URL/Base64 encoding URL","default":false,"title":"Base64 Url"},"description":"是否Base64编码提交URL/Base64 encoding URL"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/ios_shortcut/shortcut":{"get":{"tags":["iOS-Shortcut"],"summary":"用于iOS快捷指令的版本更新信息/Version update information for iOS shortcuts","operationId":"get_shortcut_api_v1_ios_shortcut_shortcut_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/iOS_Shortcut"}}}}}}},"/api/v1/demo/demo/cache_status":{"get":{"tags":["Demo-API"],"summary":"查看Demo缓存状态/View Demo Cache Status","description":"# 查看所有Demo接口的缓存状态\n\n## [中文]\n### 用途:\n- 查看当前缓存的Demo数据\n- 了解缓存过期时间\n\n## [English]\n### Purpose:\n- View current cached Demo data\n- Check cache expiration times","operationId":"view_cache_status_api_v1_demo_demo_cache_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/demo/douyin/web/fetch_one_video":{"get":{"tags":["Demo-API"],"summary":"【Demo】抖音Web获取固定作品数据（1小时缓存）/[Demo] Fetch Douyin Web Fixed Video Data with Cache","description":"# 🎯 **这是一个DEMO接口**\n\n## [中文]\n### ⚠️ 重要说明:\n- **这是一个演示(Demo)接口，仅用于测试和展示功能**\n- **不允许修改aweme_id参数，始终返回固定作品的数据**\n- **数据缓存1小时**\n\n### 用途:\n- 用于测试API连接和数据格式\n- 了解返回数据结构\n- 开发阶段的功能验证\n\n### 特性:\n- ✅ 1小时数据缓存\n- ✅ 固定作品ID: 7534641277405531446\n- ✅ 固定作品的对应链接: https://www.douyin.com/video/7534641277405531446\n- ✅ 免费使用，无需计费\n\n### 返回:\n- 固定作品的缓存数据\n\n---\n\n## [English]\n### ⚠️ Important Notice:\n- **This is a DEMO endpoint for testing and demonstration only**\n- **The aweme_id parameter cannot be modified, always returns data for a fixed video**\n- **Data is cached for 1 hour**\n\n### Purpose:\n- Test API connection and data format\n- Understand return data structure\n- Feature validation during development\n\n### Features:\n- ✅ 1-hour data caching\n- ✅ Fixed video ID: 7534641277405531446\n- ✅ Fixed video link: https://www.douyin.com/video/7534641277405531446\n- ✅ Free to use, no billing\n\n### Return:\n- Cached data for the fixed video\n\n---\n\n# [示例/Example]\n```\n# 无需参数，始终返回固定作品数据\n# No parameters needed, always returns fixed video data\nGET /api/v1/douyin/web/fetch_one_video\n```","operationId":"douyin_web_fetchone_video_demo_api_v1_demo_douyin_web_fetch_one_video_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/demo/douyin/app/fetch_one_video":{"get":{"tags":["Demo-API"],"summary":"【Demo】抖音APP获取固定作品数据（1小时缓存）/[Demo] Fetch Douyin APP Fixed Video Data with Cache","description":"# 🎯 **这是一个DEMO接口**\n\n## [中文]\n### ⚠️ 重要说明:\n- **这是一个演示(Demo)接口，仅用于测试和展示功能**\n- **不允许修改aweme_id参数，始终返回固定作品的数据**\n- **数据缓存1小时**\n\n### 用途:\n- 用于测试API连接和数据格式\n- 了解返回数据结构\n- 开发阶段的功能验证\n\n### 特性:\n- ✅ 1小时数据缓存\n- ✅ 固定作品ID: 7534641277405531446\n- ✅ 固定作品的对应链接: https://www.douyin.com/video/7534641277405531446\n- ✅ 免费使用，无需计费\n\n### 返回:\n- 固定作品的缓存数据\n\n---\n\n## [English]\n### ⚠️ Important Notice:\n- **This is a DEMO endpoint for testing and demonstration only**\n- **The aweme_id parameter cannot be modified, always returns data for a fixed video**\n- **Data is cached for 1 hour**\n\n### Purpose:\n- Test API connection and data format\n- Understand return data structure\n- Feature validation during development\n\n### Features:\n- ✅ 1-hour data caching\n- ✅ Fixed video ID: 7534641277405531446\n- ✅ Fixed video link: https://www.douyin.com/video/7534641277405531446\n- ✅ Free to use, no billing\n\n### Return:\n- Cached data for the fixed video\n\n---\n\n# [示例/Example]\n```\n# 无需参数，始终返回固定作品数据\n# No parameters needed, always returns fixed video data\nGET /api/v1/douyin/app/fetch_one_video\n```","operationId":"douyin_app_fetch_one_video_api_v1_demo_douyin_app_fetch_one_video_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/demo/douyin_search/app/general_search":{"get":{"tags":["Demo-API"],"summary":"【Demo】抖音搜索综合搜索（1小时缓存）/[Demo] Douyin General Search with Cache","description":"# 🎯 **这是一个DEMO接口**\n\n## [中文]\n### ⚠️ 重要说明:\n- **这是一个演示接口，返回固定关键词的搜索结果**\n- **搜索关键词固定为\"美食\"**\n- **数据缓存1小时**\n\n### 特性:\n- ✅ 1小时数据缓存\n- ✅ 固定搜索关键词: 美食\n- ✅ 免费使用\n\n## [English]\n### ⚠️ Important Notice:\n- **Demo endpoint returning fixed keyword search results**\n- **Search keyword fixed as \"美食\" (Food)**\n- **Data cached for 1 hour**\n\n### Features:\n- ✅ 1-hour data caching\n- ✅ Fixed search keyword: 美食\n- ✅ Free to use\n\n---\n\n# [示例/Example]\n```\n# 无需参数，始终返回固定关键词搜索结果\n# No parameters needed, always returns fixed keyword search results\nGET /api/v1/douyin_search/app/general_search\n```","operationId":"douyin_search_general_demo_api_v1_demo_douyin_search_app_general_search_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/demo/kuaishou/web/fetch_one_video":{"get":{"tags":["Demo-API"],"summary":"【Demo】快手获取固定视频信息（1小时缓存）/[Demo] Kuaishou Fixed Video with Cache","description":"# 🎯 **这是一个DEMO接口**\n\n## [中文]\n### ⚠️ 重要说明:\n- **返回固定快手视频信息**\n- **数据缓存1小时**\n\n### 特性:\n- ✅ 1小时数据缓存\n- ✅ 固定视频数据，参数：https://www.kuaishou.com/short-video/3x73wr9tdt7nxqy\n- ✅ 免费使用\n\n## [English]\n### ⚠️ Important Notice:\n- **Returns fixed Kuaishou video info**\n- **Data cached for 1 hour**\n\n### Features:\n- ✅ 1-hour data caching\n- ✅ Fixed video data, parameter: https://www.kuaishou.com/short-video/3x73wr9tdt7nxqy\n- ✅ Free to use\n\n---\n\n# [示例/Example]\n```\n# 无需参数，始终返回固定视频数据\n# No parameters needed, always returns fixed video data\nGET /api/v1/kuaishou/web/fetch_one_video\n```","operationId":"kuaishou_web_fetch_one_video_api_v1_demo_kuaishou_web_fetch_one_video_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/demo/tiktok/web/fetch_user_profile":{"get":{"tags":["Demo-API"],"summary":"【Demo】TikTok固定用户信息（1小时缓存）/[Demo] TikTok Fixed User Profile with Cache","description":"# 🎯 **这是一个DEMO接口**\n\n## [中文]\n### ⚠️ 重要说明:\n- **返回固定TikTok用户信息**\n- **数据缓存1小时**\n\n### 特性:\n- ✅ 1小时数据缓存\n- ✅ 固定用户: tiktok\n- ✅ 免费使用\n\n## [English]\n### ⚠️ Important Notice:\n- **Returns fixed TikTok user profile**\n- **Data cached for 1 hour**\n\n### Features:\n- ✅ 1-hour data caching\n- ✅ Fixed user: tiktok\n- ✅ Free to use\n\n---\n\n# [示例/Example]\n```\n# 无需参数，始终返回固定用户数据\n# No parameters needed, always returns fixed user data\nGET /api/v1/tiktok/web/fetch_user_profile\n```","operationId":"tiktok_web_fetch_user_profile_api_v1_demo_tiktok_web_fetch_user_profile_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/demo/tiktok/app/fetch_one_video":{"get":{"tags":["Demo-API"],"summary":"【Demo】TikTok APP获取固定视频详情（1小时缓存）/[Demo] TikTok APP Fixed Video Detail with Cache","description":"# 🎯 **这是一个DEMO接口**\n\n## [中文]\n### ⚠️ 重要说明:\n- **返回固定TikTok视频详情**\n- **数据缓存1小时**\n\n### 特性:\n- ✅ 1小时数据缓存\n- ✅ 固定视频详情，参数: 7319033421676653855\n- ✅ 免费使用\n\n## [English]\n### ⚠️ Important Notice:\n- **Returns fixed TikTok video detail**\n- **Data cached for 1 hour**\n\n### Features:\n- ✅ 1-hour data caching\n- ✅ Fixed video detail, parameter: 7319033421676653855\n- ✅ Free to use\n\n---\n\n# [示例/Example]\n```\n# 无需参数，始终返回固定视频数据\n# No parameters needed, always returns fixed video data\nGET /api/v1/tiktok/app/fetch_one_video\n```","operationId":"tiktok_app_fetch_one_video_api_v1_demo_tiktok_app_fetch_one_video_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/demo/instagram/web/fetch_user_info":{"get":{"tags":["Demo-API"],"summary":"【Demo】Instagram获取固定用户信息（1小时缓存）/[Demo] Instagram Fixed User Profile with Cache","description":"# 🎯 **这是一个DEMO接口**\n\n## [中文]\n### ⚠️ 重要说明:\n- **返回固定Instagram用户信息**\n- **数据缓存1小时**\n\n### 特性:\n- ✅ 1小时数据缓存\n- ✅ 固定用户: Instagram\n- ✅ 免费使用\n\n## [English]\n### ⚠️ Important Notice:\n- **Returns fixed Instagram user profile**\n- **Data cached for 1 hour**\n\n### Features:\n- ✅ 1-hour data caching\n- ✅ Fixed user: Instagram\n- ✅ Free to use\n\n---\n\n# [示例/Example]\n```\n# 无需参数，始终返回固定用户数据\n# No parameters needed, always returns fixed user data\nGET /api/v1/instagram/web/fetch_user_info\n```","operationId":"instagram_web_fetch_user_info_api_v1_demo_instagram_web_fetch_user_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}},"/api/v1/demo/wechat/article_extract":{"get":{"tags":["Demo-API"],"summary":"【Demo】微信公众号文章提取（1小时缓存）/[Demo] WeChat Article Extract with Cache","description":"# 🎯 **这是一个DEMO接口**\n\n## [中文]\n### ⚠️ 重要说明:\n- **这是一个演示(Demo)接口，仅用于测试和展示功能**\n- **不允许修改URL参数，始终返回固定文章的数据**\n- **数据缓存1小时**\n\n### 用途:\n- 用于测试API连接和数据格式\n- 了解返回数据结构\n- 开发阶段的功能验证\n\n### 特性:\n- ✅ 1小时数据缓存\n- ✅ 固定文章URL: https://mp.weixin.qq.com/s/c7_-h_3XJLpOBqpUfIlJ9w\n- ✅ 免费使用，无需计费\n\n### 返回:\n- 固定文章的缓存数据\n\n---\n\n## [English]\n### ⚠️ Important Notice:\n- **This is a DEMO endpoint for testing and demonstration only**\n- **The URL parameter cannot be modified, always returns data for a fixed article**\n- **Data is cached for 1 hour**\n\n### Purpose:\n- Test API connection and data format\n- Understand return data structure\n- Feature validation during development\n\n### Features:\n- ✅ 1-hour data caching\n- ✅ Fixed article URL: https://mp.weixin.qq.com/s/c7_-h_3XJLpOBqpUfIlJ9w\n- ✅ Free to use, no billing\n\n### Return:\n- Cached data for the fixed article\n\n---\n\n# [示例/Example]\n```\n# 无需参数，始终返回固定文章数据\n# No parameters needed, always returns fixed article data\nGET /api/v1/wechat/article_extract\n```","operationId":"wechat_article_extract_api_v1_demo_wechat_article_extract_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}}}}}},"components":{"schemas":{"ABogusModel":{"properties":{"url":{"type":"string","title":"Url","description":"请求的API URL，需要使用urlencode(url, safe='*')进行编码 | The requested API URL, needs to be encoded using urlencode(url, safe='*')","example":"https://www.douyin.com/aweme/v1/web/general/search/single/?device_platform=webapp&aid=6383&channel=channel_pc_web&search_channel=aweme_general&enable_history=1&keyword=%E4%B8%AD%E5%8D%8E%E5%A8%98&search_source=normal_search&query_correct_type=1&is_filter_search=0&from_group_id=7346905902554844468&offset=0&count=15&need_filter_settings=1&pc_client_type=1&version_code=190600&version_name=19.6.0&cookie_enabled=true&screen_width=1280&screen_height=800&browser_language=zh-CN&browser_platform=Win32&browser_name=Firefox&browser_version=124.0&browser_online=true&engine_name=Gecko&engine_version=124.0&os_name=Windows&os_version=10&cpu_core_num=16&device_memory=&platform=PC&webid=7348962975497324070&msToken=YCTVM6YGmjFdIpQAN9ykXLBXiSiuHdZkOkEQWTeqVOHBEPmOcM0lNwE0Kd9vgHPMPigSndZDHfAq9k-6lDmH3Jqz6mHHxmn-BzQjmLMIfLIPgirgnOixM9x4PwgcNQ%3D%3D"},"data":{"type":"string","title":"Data","description":"POST请求API时的载荷数据，需要使用urlencode(data, safe='*')进行编码 | The payload data when requesting the API with POST, needs to be encoded using urlencode(data, safe='*')","example":""},"user_agent":{"type":"string","title":"User Agent","description":"请求API时的User-Agent | User-Agent when requesting the API","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36"},"index_0":{"type":"integer","title":"Index 0","description":"加密明文列表的第一个值，无特殊要求，默认为0","default":0},"index_1":{"type":"integer","title":"Index 1","description":"加密明文列表的第一个值，无特殊要求，默认为1","default":1},"index_2":{"type":"integer","title":"Index 2","description":"加密明文列表的第一个值，无特殊要求，默认为14","default":14}},"type":"object","required":["url","data","user_agent"],"title":"ABogusModel"},"APIKeyData":{"properties":{"api_key_name":{"type":"string","title":"Api Key Name"},"api_key_scopes":{"items":{},"type":"array","title":"Api Key Scopes"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"api_key_status":{"type":"integer","title":"Api Key Status"}},"type":"object","required":["api_key_name","api_key_scopes","created_at","expires_at","api_key_status"],"title":"APIKeyData"},"AuthorDiagnosisRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"}},"type":"object","required":["cookie"],"title":"AuthorDiagnosisRequest","description":"创作者账号诊断请求模型\nAuthor Diagnosis Request Model\n\n此接口无需额外参数，自动获取最近一周（从当天起往前7天）的账号诊断数据\nThis API requires no additional parameters, automatically fetches diagnosis data for the past 7 days"},"BatchGiftQuery":{"properties":{"gift_ids":{"items":{"type":"string"},"type":"array","maxItems":1000,"minItems":1,"title":"Gift Ids","description":"礼物ID列表，建议50个/次获得最佳性价比($0.025)，超过50个时自动处理前50个 | Gift ID list, recommend 50/call for best value ($0.025), auto-process first 50 if more than 50","example":["10001","10002","10003"]}},"type":"object","required":["gift_ids"],"title":"BatchGiftQuery","description":"批量Gift ID查询模型\n计费：$0.025每次调用，建议每次查询50个ID以获得最佳性价比\n\nArgs:\n    gift_ids (list[str]): 礼物ID列表，建议50个，例如 [\"10001\", \"10002\", \"10003\"]"},"Body_fetch_home_feed_api_v1_tiktok_web_fetch_home_feed_post":{"properties":{"count":{"type":"integer","title":"Count","description":"每页数量/Number per page","default":15},"cookie":{"type":"string","title":"Cookie","description":"用户自己的cookie，可选参数，用于接口返回数据的个性化推荐。/ User's own cookie, optional parameter, used for personalized recommendations of interface return data."}},"type":"object","title":"Body_fetch_home_feed_api_v1_tiktok_web_fetch_home_feed_post"},"Body_fetch_hot_account_list_api_v1_douyin_billboard_fetch_hot_account_list_post":{"properties":{"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，格式 小时，默认24小时","default":24},"page_num":{"type":"integer","title":"Page Num","description":"页码，默认1","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量，默认10","default":10},"query_tag":{"additionalProperties":true,"type":"object","title":"Query Tag","description":"子级垂类标签，空则为全部，多个标签需传入{\"value\": \"{顶级垂类标签id}\", \"children\": [{\"value\": \"{子级垂类标签id}\"}, {\"value\": \"{子级垂类标签id}\"}]}","default":{}}},"type":"object","title":"Body_fetch_hot_account_list_api_v1_douyin_billboard_fetch_hot_account_list_post"},"Body_fetch_hot_calendar_list_api_v1_douyin_billboard_fetch_hot_calendar_list_post":{"properties":{"city_code":{"type":"string","title":"City Code","description":"城市编码，从城市列表获取，空为全部","default":""},"category_code":{"type":"string","title":"Category Code","description":"热点榜分类编码，从热点榜分类获取，空为全部","default":""},"end_date":{"type":"integer","title":"End Date","description":"快照结束时间 格式10位时间戳","default":1735488000},"start_date":{"type":"integer","title":"Start Date","description":"快照开始时间 格式10位时间戳","default":1734902400}},"type":"object","title":"Body_fetch_hot_calendar_list_api_v1_douyin_billboard_fetch_hot_calendar_list_post"},"Body_fetch_hot_total_high_fan_list_api_v1_douyin_billboard_fetch_hot_total_high_fan_list_post":{"properties":{"page":{"type":"integer","title":"Page","description":"页码","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"tags":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Tags","description":"子级垂类标签，空则为全部，多个标签需传入{\"value\": \"{顶级垂类标签id}\", \"children\": [{\"value\": \"{子级垂类标签id}\"}, {\"value\": \"{子级垂类标签id}\"}]}"}},"type":"object","title":"Body_fetch_hot_total_high_fan_list_api_v1_douyin_billboard_fetch_hot_total_high_fan_list_post"},"Body_fetch_hot_total_high_like_list_api_v1_douyin_billboard_fetch_hot_total_high_like_list_post":{"properties":{"page":{"type":"integer","title":"Page","description":"页码","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"tags":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Tags","description":"子级垂类标签，空则为全部，多个标签需传入{\"value\": \"{顶级垂类标签id}\", \"children\": [{\"value\": \"{子级垂类标签id}\"}, {\"value\": \"{子级垂类标签id}\"}]}"}},"type":"object","title":"Body_fetch_hot_total_high_like_list_api_v1_douyin_billboard_fetch_hot_total_high_like_list_post"},"Body_fetch_hot_total_high_play_list_api_v1_douyin_billboard_fetch_hot_total_high_play_list_post":{"properties":{"page":{"type":"integer","title":"Page","description":"页码","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"tags":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Tags","description":"子级垂类标签，空则为全部，多个标签需传入{\"value\": \"{顶级垂类标签id}\", \"children\": [{\"value\": \"{子级垂类标签id}\"}, {\"value\": \"{子级垂类标签id}\"}]}"}},"type":"object","title":"Body_fetch_hot_total_high_play_list_api_v1_douyin_billboard_fetch_hot_total_high_play_list_post"},"Body_fetch_hot_total_high_search_list_api_v1_douyin_billboard_fetch_hot_total_high_search_list_post":{"properties":{"page_num":{"type":"integer","title":"Page Num","description":"页码","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"keyword":{"type":"string","title":"Keyword","description":"搜索关键字","default":"抖音"}},"type":"object","title":"Body_fetch_hot_total_high_search_list_api_v1_douyin_billboard_fetch_hot_total_high_search_list_post"},"Body_fetch_hot_total_high_topic_list_api_v1_douyin_billboard_fetch_hot_total_high_topic_list_post":{"properties":{"page":{"type":"integer","title":"Page","description":"页码","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"tags":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Tags","description":"子级垂类标签，空则为全部，多个标签需传入{\"value\": \"{顶级垂类标签id}\", \"children\": [{\"value\": \"{子级垂类标签id}\"}, {\"value\": \"{子级垂类标签id}\"}]}"}},"type":"object","title":"Body_fetch_hot_total_high_topic_list_api_v1_douyin_billboard_fetch_hot_total_high_topic_list_post"},"Body_fetch_hot_total_hot_word_list_api_v1_douyin_billboard_fetch_hot_total_hot_word_list_post":{"properties":{"page_num":{"type":"integer","title":"Page Num","description":"页码","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"keyword":{"type":"string","title":"Keyword","description":"搜索关键字","default":"抖音"}},"type":"object","title":"Body_fetch_hot_total_hot_word_list_api_v1_douyin_billboard_fetch_hot_total_hot_word_list_post"},"Body_fetch_hot_total_low_fan_list_api_v1_douyin_billboard_fetch_hot_total_low_fan_list_post":{"properties":{"page":{"type":"integer","title":"Page","description":"页码","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"tags":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Tags","description":"子级垂类标签，空则为全部，多个标签需传入{\"value\": \"{顶级垂类标签id}\", \"children\": [{\"value\": \"{子级垂类标签id}\"}, {\"value\": \"{子级垂类标签id}\"}]}"}},"type":"object","title":"Body_fetch_hot_total_low_fan_list_api_v1_douyin_billboard_fetch_hot_total_low_fan_list_post"},"Body_fetch_hot_total_search_list_api_v1_douyin_billboard_fetch_hot_total_search_list_post":{"properties":{"page_num":{"type":"integer","title":"Page Num","description":"页码","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"keyword":{"type":"string","title":"Keyword","description":"搜索关键字","default":"抖音"}},"type":"object","title":"Body_fetch_hot_total_search_list_api_v1_douyin_billboard_fetch_hot_total_search_list_post"},"Body_fetch_hot_total_topic_list_api_v1_douyin_billboard_fetch_hot_total_topic_list_post":{"properties":{"page":{"type":"integer","title":"Page","description":"页码","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"tags":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Tags","description":"子级垂类标签，空则为全部，多个标签需传入{\"value\": \"{顶级垂类标签id}\", \"children\": [{\"value\": \"{子级垂类标签id}\"}, {\"value\": \"{子级垂类标签id}\"}]}"}},"type":"object","title":"Body_fetch_hot_total_topic_list_api_v1_douyin_billboard_fetch_hot_total_topic_list_post"},"Body_fetch_hot_total_video_list_api_v1_douyin_billboard_fetch_hot_total_video_list_post":{"properties":{"page":{"type":"integer","title":"Page","description":"页码，默认1","default":1},"page_size":{"type":"integer","title":"Page Size","description":"每页数量，默认10","default":10},"date_window":{"type":"integer","title":"Date Window","description":"时间窗口，1 按小时 2 按天","default":24},"sub_type":{"type":"integer","title":"Sub Type","description":"榜单分类，1001 视频总榜 1002 低粉爆款 1003 高完播率 1004 高涨粉率 1005 高点赞率","default":1001},"tags":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Tags","description":"子级垂类标签，空则为全部，多个标签需传入{\"value\": \"{顶级垂类标签id}\", \"children\": [{\"value\": \"{子级垂类标签id}\"}, {\"value\": \"{子级垂类标签id}\"}]}"}},"type":"object","title":"Body_fetch_hot_total_video_list_api_v1_douyin_billboard_fetch_hot_total_video_list_post"},"Body_fetch_user_collection_videos_api_v1_douyin_web_fetch_user_collection_videos_post":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户网页版抖音Cookie/Your web version of Douyin Cookie"},"max_cursor":{"type":"integer","title":"Max Cursor","description":"最大游标/Maximum cursor","default":0},"counts":{"type":"integer","title":"Counts","description":"每页数量/Number per page","default":20}},"type":"object","required":["cookie"],"title":"Body_fetch_user_collection_videos_api_v1_douyin_web_fetch_user_collection_videos_post"},"Body_fetch_user_collects_api_v1_douyin_web_fetch_user_collects_post":{"properties":{"max_cursor":{"type":"integer","title":"Max Cursor","description":"最大游标/Maximum cursor","default":0},"counts":{"type":"integer","title":"Counts","description":"每页数量/Number per page","default":20},"cookie":{"type":"string","title":"Cookie","description":"用户网页版抖音Cookie/Your web version of Douyin Cookie"}},"type":"object","required":["cookie"],"title":"Body_fetch_user_collects_api_v1_douyin_web_fetch_user_collects_post"},"Body_fetch_user_like_videos_api_v1_douyin_web_fetch_user_like_videos_post":{"properties":{"sec_user_id":{"type":"string","title":"Sec User Id","description":"用户sec_user_id/User sec_user_id"},"max_cursor":{"type":"integer","title":"Max Cursor","description":"最大游标/Maximum cursor","default":0},"counts":{"type":"integer","title":"Counts","description":"每页数量/Number per page","default":20},"cookie":{"type":"string","title":"Cookie","description":"用户网页版抖音Cookie/Your web version of Douyin Cookie"}},"type":"object","required":["sec_user_id"],"title":"Body_fetch_user_like_videos_api_v1_douyin_web_fetch_user_like_videos_post"},"Body_get_ip_activity_list_api_v1_douyin_xingtu_v2_get_ip_activity_list_post":{"properties":{"query_start_time":{"type":"string","title":"Query Start Time","description":"查询开始时间戳/Query start timestamp"},"query_end_time":{"type":"string","title":"Query End Time","description":"查询结束时间戳/Query end timestamp"},"industry_id_list":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Industry Id List","description":"行业ID列表/Industry ID list"},"category_list":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Category List","description":"IP类型列表/IP category list"},"status_list":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Status List","description":"IP状态列表/IP status list"}},"type":"object","required":["query_start_time","query_end_time"],"title":"Body_get_ip_activity_list_api_v1_douyin_xingtu_v2_get_ip_activity_list_post"},"Body_get_recommend_for_star_authors_api_v1_douyin_xingtu_v2_get_recommend_for_star_authors_post":{"properties":{"author_ids":{"items":{"type":"string"},"type":"array","title":"Author Ids","description":"创作者ID列表/List of creator author IDs"},"similar_type":{"type":"string","title":"Similar Type","description":"相似类型/Similarity type","default":"content"},"page":{"type":"integer","title":"Page","description":"页码/Page number","default":1},"limit":{"type":"integer","title":"Limit","description":"每页数量/Page size","default":12}},"type":"object","required":["author_ids"],"title":"Body_get_recommend_for_star_authors_api_v1_douyin_xingtu_v2_get_recommend_for_star_authors_post"},"Body_upload_image_api_v1_sora2_upload_image_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"PNG/JPG/JPEG"}},"type":"object","required":["file"],"title":"Body_upload_image_api_v1_sora2_upload_image_post"},"ChallengePostRequest":{"properties":{"challenge_id":{"type":"string","title":"Challenge Id","description":"话题ID/Challenge ID","default":"1608846127610893"},"sort_type":{"type":"integer","title":"Sort Type","description":"排序类型/Sort type","default":0},"cursor":{"type":"integer","title":"Cursor","description":"游标/Cursor","default":0},"count":{"type":"integer","title":"Count","description":"数量/Count","default":20},"cookie":{"type":"string","title":"Cookie","description":"用户自行提供的Cookie/User provided Cookie","default":""}},"type":"object","title":"ChallengePostRequest"},"ChallengeSearchV1Request":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"ChallengeSearchV1Request"},"ChallengeSearchV2Request":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"ChallengeSearchV2Request"},"ChallengeSuggestRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词，如 '游戏' / Keyword, e.g., 'game'","default":"游戏"}},"type":"object","title":"ChallengeSuggestRequest"},"CollectRequest":{"properties":{"aweme_id":{"type":"string","title":"AKA Video ID","description":"Video ID, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295","default":"7419966340443819295"},"cookie":{"type":"string","title":"User Cookie","description":"User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.","default":"Your_Cookie_From_Browser"},"device_id":{"type":"string","title":"Device ID","description":"Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.","default":""},"iid":{"type":"string","title":"Device Install ID","description":"Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.","default":""},"proxy":{"type":"string","title":"Proxy IP","description":"Proxy IP, optional, if not filled in, it will be automatically generated, if you need to customize the proxy IP, please use the proxy IP interface to get the proxy IP.","default":""}},"type":"object","title":"CollectRequest"},"CommentSortByAPI":{"type":"string","enum":["top","newest"],"title":"CommentSortByAPI","description":"评论排序方式"},"CreateVideoRequest":{"properties":{"prompt":{"type":"string","maxLength":2000,"title":"Prompt","description":"视频描述文本（最多2000字符）/Video description text (max 2000 chars)","example":"A cat is playing Minecraft"},"orientation":{"$ref":"#/components/schemas/VideoOrientation","description":"视频方向：portrait(竖屏9:16) 或 landscape(横屏16:9)/Video orientation: portrait(9:16) or landscape(16:9)","default":"portrait"},"media_id":{"anyOf":[{"type":"string","pattern":"^media_.*"},{"type":"null"}],"title":"Media Id","description":"图片 media_id（可选），从 upload_image 接口获取，用于图生视频/Image media_id (optional) from upload_image endpoint for image-to-video generation","default":"","example":""}},"type":"object","required":["prompt"],"title":"CreateVideoRequest"},"DiscussSearchRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"DiscussSearchRequest"},"ExperienceSearchRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"ExperienceSearchRequest"},"FetchCommentsRequest":{"properties":{"id":{"type":"string","title":"Id","description":"视频ID/Video ID","example":"14145780330774202411"},"lastBuffer":{"type":"string","title":"Lastbuffer","description":"分页参数，首次请求可为空/Pagination parameter, can be empty for first request","default":""},"comment_id":{"type":"string","title":"Comment Id","description":"评论ID，默认不传，传入则获取该评论下的子评论/Comment ID, if provided, fetches replies to that comment"}},"type":"object","required":["id"],"title":"FetchCommentsRequest"},"FetchDefaultSearchRequest":{"properties":{"keywords":{"type":"string","title":"Keywords","description":"搜索关键词/Search keywords","example":"美食"},"session_buffer":{"type":"string","title":"Session Buffer","description":"分页参数，首次请求可为空，后续使用响应中的 last_buff 进行分页请求/Pagination parameter, can be empty for first request, use last_buff from response for subsequent requests","default":""}},"type":"object","required":["keywords"],"title":"FetchDefaultSearchRequest"},"FetchHomePageRequest":{"properties":{"username":{"type":"string","title":"Username","description":"用户名/Username","example":"v2_060000231003b20faec8c4ea8a1ac7d5c80ce434b077535b622489f476b63209b6886fc4a16f@finder"},"last_buffer":{"type":"string","title":"Last Buffer","description":"分页参数，首次请求可为空，后续使用 object_list 最后一个 item 的 last_buffer 进行分页请求/Pagination parameter, can be empty for first request","default":""}},"type":"object","required":["username"],"title":"FetchHomePageRequest"},"FetchMultiVideoHighQualityPlayUrlRequest":{"properties":{"aweme_ids":{"type":"string","title":"Aweme Ids","description":"作品id列表，用逗号分隔，最多50个/Video id list, separated by commas, up to 50","default":"7512756548356492544,7448118827402972455,7126745726494821640"}},"type":"object","title":"FetchMultiVideoHighQualityPlayUrlRequest"},"FollowRequest":{"properties":{"user_id":{"type":"string","title":"User ID","description":"Video ID, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295","default":"6881290705605477381"},"sec_user_id":{"type":"string","title":"Sec User ID","description":"User sec_id, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295","default":"MS4wLjABAAAAqB08cUbXaDWqbD6MCga2RbGTuhfO2EsHayBYx08NDrN7IE3jQuRDNNN6YwyfH6_6"},"cookie":{"type":"string","title":"User Cookie","description":"User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.","default":"Your_Cookie_From_Browser"},"device_id":{"type":"string","title":"Device ID","description":"Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.","default":""},"iid":{"type":"string","title":"Device Install ID","description":"Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.","default":""},"proxy":{"type":"string","title":"Proxy IP","description":"Proxy IP, optional, if not filled in, it will be automatically generated, if you need to customize the proxy IP, please use the proxy IP interface to get the proxy IP.","default":""}},"type":"object","title":"FollowRequest"},"ForwardRequest":{"properties":{"aweme_id":{"type":"string","title":"AKA Video ID","description":"Video ID, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295","default":"7419966340443819295"},"cookie":{"type":"string","title":"User Cookie","description":"User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.","default":"Your_Cookie_From_Browser"},"device_id":{"type":"string","title":"Device ID","description":"Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.","default":""},"iid":{"type":"string","title":"Device Install ID","description":"Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.","default":""},"proxy":{"type":"string","title":"Proxy IP","description":"Proxy IP, optional, if not filled in, it will be automatically generated, if you need to customize the proxy IP, please use the proxy IP interface to get the proxy IP.","default":""}},"type":"object","title":"ForwardRequest"},"GeneralSearchV1Request":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"GeneralSearchV1Request"},"GeneralSearchV2Request":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"GeneralSearchV2Request"},"GetAccountHealthRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""}},"type":"object","title":"GetAccountHealthRequest"},"GetAccountOverviewRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"start_date":{"type":"string","title":"Start Date","description":"查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'","default":"04-01-2025"}},"type":"object","title":"GetAccountOverviewRequest"},"GetCreatorAccountInfoRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""}},"type":"object","title":"GetCreatorAccountInfoRequest"},"GetHomeFeedRequest":{"properties":{"feed_type":{"type":"string","title":"Feed Type","description":"推荐类型/Feed type","default":"0","examples":["0"]},"need_filter_image":{"type":"boolean","title":"Need Filter Image","description":"是否只看图文笔记/Whether to view only image notes","default":false,"examples":[false]},"cursor_score":{"type":"string","title":"Cursor Score","description":"分页游标/Cursor for pagination","default":"","examples":[""]},"cookie":{"type":"string","title":"Cookie","description":"用户自行提供的已登录的网页Cookie/User provided logged-in web Cookie","default":"","examples":[""]},"proxy":{"type":"string","title":"Proxy","description":"代理，格式：http://用户名:密码@IP:端口/Proxy, format: http://username:password@IP:port","default":"","examples":[""]}},"type":"object","title":"GetHomeFeedRequest"},"GetLiveOverviewRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"start_date":{"type":"string","title":"Start Date","description":"查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'","default":"04-01-2025"}},"type":"object","title":"GetLiveOverviewRequest"},"GetNoteInfoV5Request":{"properties":{"note_id":{"type":"string","title":"Note Id","description":"笔记ID/Note ID","default":"67855d09000000001703d449"},"xsec_token":{"type":"string","title":"Xsec Token","description":"X-Sec-Token，可以从搜索接口中获取/X-Sec-Token, can be obtained from the search interface","default":"ABfpRSESmZDRbX-EX7lzEztktMngxPVC9kU-dgQmuQoNo="},"cookie":{"type":"string","title":"Cookie","description":"用户自行提供的已登录的网页Cookie/User provided logged-in web Cookie","default":""},"proxy":{"type":"string","title":"Proxy","description":"代理，格式：http://用户名:密码@IP:端口/Proxy, format: http://username:password@IP:port","default":""}},"type":"object","title":"GetNoteInfoV5Request"},"GetProductListRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"start_date":{"type":"string","title":"Start Date","description":"开始日期，如 '2025-04-01'/ Start Date, e.g. '2025-04-01'","default":"2025-04-01"},"end_date":{"type":"string","title":"End Date","description":"结束日期，如 '2025-05-01'/ End Date, e.g. '2025-05-01'","default":"2025-05-01"},"page":{"type":"integer","title":"Page","description":"页码/Page Number","default":0}},"type":"object","title":"GetProductListRequest"},"GetProductRelatedVideosRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"start_date":{"type":"string","title":"Start Date","description":"查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'","default":"04-01-2025"},"item_id":{"type":"string","title":"Item Id","description":"视频 ID/Video ID"},"product_id":{"type":"string","title":"Product Id","description":"商品 ID/Product ID"}},"type":"object","required":["item_id","product_id"],"title":"GetProductRelatedVideosRequest"},"GetShowcaseProductListRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"count":{"type":"integer","title":"Count","description":"每页数量/Page Size","default":20},"offset":{"type":"integer","title":"Offset","description":"偏移量/Offset","default":0}},"type":"object","title":"GetShowcaseProductListRequest"},"GetVideoAssociatedProductListRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"start_date":{"type":"string","title":"Start Date","description":"查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'","default":"04-01-2025"},"item_ids":{"items":{"type":"string"},"type":"array","title":"Item Ids","description":"视频 ID 列表/Video ID List"}},"type":"object","required":["item_ids"],"title":"GetVideoAssociatedProductListRequest"},"GetVideoAudienceStatsRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"start_date":{"type":"string","title":"Start Date","description":"查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'","default":"04-01-2025"},"item_id":{"type":"string","title":"Item Id","description":"视频 ID/Video ID"}},"type":"object","required":["item_id"],"title":"GetVideoAudienceStatsRequest"},"GetVideoDetailedStatsRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"start_date":{"type":"string","title":"Start Date","description":"查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'","default":"04-01-2025"},"item_id":{"type":"string","title":"Item Id","description":"视频 ID/Video ID"}},"type":"object","required":["item_id"],"title":"GetVideoDetailedStatsRequest"},"GetVideoListRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"start_date":{"type":"string","title":"Start Date","description":"查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'","default":"04-01-2025"},"page":{"type":"integer","title":"Page","description":"页码/Page Number","default":0},"rules":{"type":"string","title":"Rules","description":"列表排序规则，默认按发布时间排序/ List sorting rule, default is by publish time","default":"VIDEO_LIST_PUBLISH_TIME"}},"type":"object","title":"GetVideoListRequest"},"GetVideoOverviewRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""}},"type":"object","title":"GetVideoOverviewRequest"},"GetVideoToProductStatsRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"start_date":{"type":"string","title":"Start Date","description":"查询开始时间，如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025'","default":"04-01-2025"},"item_id":{"type":"string","title":"Item Id","description":"视频 ID/Video ID"},"product_id":{"type":"string","title":"Product Id","description":"商品 ID/Product ID"}},"type":"object","required":["item_id","product_id"],"title":"GetVideoToProductStatsRequest"},"GetViolationRecordRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户 Cookie 字符串/User Cookie String","default":"Your_Cookie_String"},"proxy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proxy","description":"可选 HTTP 代理地址/Optional HTTP Proxy Address","default":""},"page":{"type":"integer","title":"Page","description":"页码/Page Number","default":1}},"type":"object","title":"GetViolationRecordRequest"},"GiftQuery":{"properties":{"gift_id":{"type":"string","title":"Gift Id","description":"礼物ID | Gift ID","example":"10001"}},"type":"object","required":["gift_id"],"title":"GiftQuery","description":"单个Gift ID查询模型\n\nArgs:\n    gift_id (str): 礼物ID，例如 \"10001\""},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthCheckResponse":{"properties":{"status":{"type":"string","title":"Status","default":"ok"}},"type":"object","title":"HealthCheckResponse"},"ImageSearchRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"ImageSearchRequest"},"ImageSearchV3Request":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"搜索关键词/Search keyword"},"cursor":{"type":"integer","title":"Cursor","description":"翻页游标/Pagination cursor","default":0},"search_id":{"type":"string","title":"Search Id","description":"搜索ID/Search ID for pagination","default":""}},"type":"object","required":["keyword"],"title":"ImageSearchV3Request"},"ItemAnalysisInvolvedVerticalRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"start_date":{"type":"string","title":"Start Date","description":"开始日期(格式YYYYMMDD)/Start date (format YYYYMMDD)","example":"20250713"},"end_date":{"type":"string","title":"End Date","description":"结束日期(格式YYYYMMDD)/End date (format YYYYMMDD)","example":"20251011"}},"type":"object","required":["cookie","start_date","end_date"],"title":"ItemAnalysisInvolvedVerticalRequest","description":"作品垂类获取请求模型\nItem Analysis Involved Vertical Request Model"},"ItemAnalysisItemPerformanceRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"start_date":{"type":"string","title":"Start Date","description":"开始日期(格式YYYYMMDD)/Start date (format YYYYMMDD)","example":"20250713"},"end_date":{"type":"string","title":"End Date","description":"结束日期(格式YYYYMMDD)/End date (format YYYYMMDD)","example":"20251011"},"genres":{"items":{"type":"integer"},"type":"array","title":"Genres","description":"体裁类型列表/Genres list: 1=1min以内视频, 2=1-3min视频, 3=3-5min视频, 4=5min+视频, 5=图文, 8=长图文","default":[1,2,3,4,5,8],"example":[2,3,4,5,8]},"primary_verticals":{"items":{"type":"string"},"type":"array","title":"Primary Verticals","description":"垂类标签列表/Primary verticals list (从involved_vertical接口获取)","example":["动物"]},"metric_type":{"type":"integer","title":"Metric Type","description":"指标类型/Metric type: 1=播放量(Views), 2=点赞量(Likes), 3=评论量(Comments), 4=分享量(Shares)","default":1,"example":1}},"type":"object","required":["cookie","start_date","end_date","primary_verticals"],"title":"ItemAnalysisItemPerformanceRequest","description":"投稿表现请求模型\nItem Analysis Item Performance Request Model"},"ItemAnalysisOverviewRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"start_date":{"type":"string","title":"Start Date","description":"开始日期(格式YYYYMMDD)/Start date (format YYYYMMDD)","example":"20250713"},"end_date":{"type":"string","title":"End Date","description":"结束日期(格式YYYYMMDD)/End date (format YYYYMMDD)","example":"20251011"},"genres":{"items":{"type":"integer"},"type":"array","title":"Genres","description":"体裁类型列表/Genres list: 1=1min以内视频, 2=1-3min视频, 3=3-5min视频, 4=5min+视频, 5=图文, 8=长图文","default":[1,2,3,4,5,8],"example":[1,2,3,4,5,8]},"primary_verticals":{"items":{"type":"string"},"type":"array","title":"Primary Verticals","description":"垂类标签列表/Primary verticals list (从involved_vertical接口获取)","example":["动物"]}},"type":"object","required":["cookie","start_date","end_date","primary_verticals"],"title":"ItemAnalysisOverviewRequest","description":"投稿分析概览请求模型\nItem Analysis Overview Request Model"},"ItemAudienceOthersRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"item_id":{"type":"string","title":"Item Id","description":"作品ID/Item ID","example":"7559536212910853422"}},"type":"object","required":["cookie","item_id"],"title":"ItemAudienceOthersRequest","description":"作品观众其他数据分析请求模型\nItem Audience Others Request Model"},"ItemAudiencePortraitRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"item_id":{"type":"string","title":"Item Id","description":"作品ID/Item ID","example":"7559536212910853422"}},"type":"object","required":["cookie","item_id"],"title":"ItemAudiencePortraitRequest","description":"作品观众数据分析请求模型\nItem Audience Portrait Request Model"},"ItemBulletAnalysisRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"item_id":{"type":"string","title":"Item Id","description":"作品ID/Item ID","example":"7559536212910853422"}},"type":"object","required":["cookie","item_id"],"title":"ItemBulletAnalysisRequest","description":"作品弹幕分析请求模型\nItem Bullet Analysis Request Model"},"ItemListDownloadRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"min_cursor":{"type":"integer","title":"Min Cursor","description":"最小游标(开始时间戳,毫秒)/Min cursor (start timestamp in milliseconds)","example":1752336000000},"max_cursor":{"type":"integer","title":"Max Cursor","description":"最大游标(结束时间戳,毫秒)/Max cursor (end timestamp in milliseconds)","example":1760198399000},"type_filters":{"items":{"type":"integer"},"type":"array","title":"Type Filters","description":"体裁类型过滤/Type filters: 1=1min以内视频, 2=1-3min视频, 3=3-5min视频, 4=5min+视频, 5=图文, 8=长图文","default":[1,2,3,4,5,8],"example":[2,3,4,5,1,8]},"need_long_article":{"type":"boolean","title":"Need Long Article","description":"是否包含长图文/Include long articles","default":true,"example":true}},"type":"object","required":["cookie","min_cursor","max_cursor"],"title":"ItemListDownloadRequest","description":"投稿作品列表导出请求模型\nItem List Download Request Model"},"ItemListRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"count":{"type":"integer","title":"Count","description":"每页数量/Count per page (最多100条)","default":10,"example":10},"order_by":{"type":"integer","title":"Order By","description":"排序方式/Order by (1-26): 1=发布时间↓(新到旧), 2=发布时间↑(旧到新), 3=播放量↓, 4=播放量↑, 5=点赞量↓, 6=点赞量↑, 7=评论量↓, 8=评论量↑, 9=分享量↓, 10=分享量↑, 11=收藏量↓, 12=收藏量↑, 13=2s跳出率↓, 14=2s跳出率↑, 15=5s完播率↓, 16=5s完播率↑, 17=完播率↓, 18=完播率↑, 19=封面点击率↓, 20=封面点击率↑, 21=平均播放时长↓, 22=平均播放时长↑, 23=主页访问量↓, 24=主页访问量↑, 25=粉丝增量↓, 26=粉丝增量↑","default":1,"example":1},"fields":{"type":"string","title":"Fields","description":"需要返回的字段/Fields to return","default":"metrics,review,visibility","example":"metrics,review,visibility"},"need_cooperation":{"type":"boolean","title":"Need Cooperation","description":"是否需要合作信息/Need cooperation info","default":true,"example":true},"start_time":{"type":"integer","title":"Start Time","description":"开始时间戳(毫秒)/Start time timestamp (milliseconds)","example":1758988800000},"end_time":{"type":"integer","title":"End Time","description":"结束时间戳(毫秒)/End time timestamp (milliseconds)","example":1760198399000},"need_long_article":{"type":"boolean","title":"Need Long Article","description":"是否包含长图文/Include long articles","default":true,"example":true},"cursor":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cursor","description":"分页游标/Pagination cursor (可选)"}},"type":"object","required":["cookie","start_time","end_time"],"title":"ItemListRequest","description":"投稿作品列表请求模型\nItem List Request Model"},"ItemMgetRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"ids":{"type":"string","title":"Ids","description":"作品ID列表,多个ID用逗号分隔/Item IDs, separated by comma","example":"7559536212910853422,7559536212910853423"},"fields":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fields","description":"需要返回的字段,多个字段用逗号分隔/Fields to return, separated by comma. 可选值: metrics(指标),review(审核),play_info(播放信息),dou_plus(抖+),integrated_incentive(综合激励),incentive_life(激励生命周期),content_analysis(内容分析)","default":"metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis"}},"type":"object","required":["cookie","ids"],"title":"ItemMgetRequest","description":"作品总览数据请求模型\nItem Overview Data Request Model"},"ItemPlaySourceRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"item_id":{"type":"string","title":"Item Id","description":"作品ID/Item ID","example":"7559536212910853422"}},"type":"object","required":["cookie","item_id"],"title":"ItemPlaySourceRequest","description":"作品流量来源统计请求模型\nItem Play Source Statistics Request Model"},"ItemSearchKeywordRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"item_id":{"type":"string","title":"Item Id","description":"作品ID/Item ID","example":"7559536212910853422"}},"type":"object","required":["cookie","item_id"],"title":"ItemSearchKeywordRequest","description":"作品搜索关键词请求模型\nItem Search Keywords Request Model"},"ItemWatchTrendRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"item_id":{"type":"string","title":"Item Id","description":"作品ID/Item ID","example":"7559536212910853422"},"analysis_type":{"type":"integer","title":"Analysis Type","description":"分析类型/Analysis type: 1=留存分析(Retention), 2=点赞分析(Like), 7=跳出分析(Bounce)","default":1,"example":1}},"type":"object","required":["cookie","item_id"],"title":"ItemWatchTrendRequest","description":"作品观看趋势分析请求模型\nItem Watch Trend Analysis Request Model"},"LikeRequest":{"properties":{"aweme_id":{"type":"string","title":"AKA Video ID","description":"Video ID, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295","default":"7419966340443819295"},"cookie":{"type":"string","title":"User Cookie","description":"User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.","default":"Your_Cookie_From_Browser"},"device_id":{"type":"string","title":"Device ID","description":"Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.","default":""},"iid":{"type":"string","title":"Device Install ID","description":"Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.","default":""},"proxy":{"type":"string","title":"Proxy IP","description":"Proxy IP, optional, if not filled in, it will be automatically generated, if you need to customize the proxy IP, please use the proxy IP interface to get the proxy IP.","default":""}},"type":"object","title":"LikeRequest"},"LiveRoomBatchCheckRequest":{"properties":{"room_ids":{"items":{"type":"string"},"type":"array","title":"Room Ids","description":"多个直播间ID组成的数组 / List of TikTok live room IDs","default":["7494491933781003054","7494514925034113835","7494520590523517739"]}},"type":"object","title":"LiveRoomBatchCheckRequest"},"LiveRoomHistoryListRequest":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户Cookie/User Cookie","example":"Your_Cookie_Here"},"start_date":{"type":"string","title":"Start Date","description":"开始日期(格式YYYY-MM-DD)/Start date (format YYYY-MM-DD)","example":"2025-09-11"},"end_date":{"type":"string","title":"End Date","description":"结束日期(格式YYYY-MM-DD)/End date (format YYYY-MM-DD)","example":"2025-10-11"},"limit":{"type":"integer","title":"Limit","description":"每页数量限制/Limit per page (最多400条)","default":400,"example":400},"need_living":{"type":"integer","title":"Need Living","description":"是否包含正在直播的场次/Include living rooms: 0=不包含, 1=包含","default":1,"example":1},"download":{"type":"integer","title":"Download","description":"是否下载/Download: 0=不下载, 1=下载","default":0,"example":0}},"type":"object","required":["cookie","start_date","end_date"],"title":"LiveRoomHistoryListRequest","description":"直播场次历史记录请求模型\nLive Room History List Request Model"},"LiveSearchV1Request":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"LiveSearchV1Request"},"ModeEnum":{"type":"string","enum":["encrypt","decrypt"],"title":"ModeEnum"},"MultiSearchRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"MultiSearchRequest"},"MusicSearchRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"MusicSearchRequest"},"PostCommentRequest":{"properties":{"aweme_id":{"type":"string","title":"AKA Video ID","description":"Video ID, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295","default":"7419966340443819295"},"text":{"type":"string","title":"Comment Content","description":"Comment content, TikTok comment content needs to comply with the specifications, do not contain illegal keywords, otherwise, even if the request is successful, it will be judged as spam comments by the system and will not be displayed.","default":"Hello, TikTok!"},"cookie":{"type":"string","title":"User Cookie","description":"User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.","default":"Your_Cookie_From_Browser"},"device_id":{"type":"string","title":"Device ID","description":"Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.","default":""},"iid":{"type":"string","title":"Device Install ID","description":"Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.","default":""},"proxy":{"type":"string","title":"Proxy IP","description":"Proxy IP, optional, if not filled in, it will be automatically generated, if you need to customize the proxy IP, please use the proxy IP interface to get the proxy IP.","default":""}},"type":"object","title":"PostCommentRequest"},"ReplyCommentRequest":{"properties":{"aweme_id":{"type":"string","title":"AKA Video ID","description":"Video ID, which can be obtained from the sharing link, for example: https://www.tiktok.com/@username/video/7419966340443819295","default":"7419966340443819295"},"reply_id":{"type":"string","title":"Reply Comment ID AKA CID","description":"Comment ID, which can be obtained from the comment data of the specified video.","default":"7420673787547419435"},"text":{"type":"string","title":"Comment Content","description":"Comment content, TikTok comment content needs to comply with the specifications, do not contain illegal keywords, otherwise, even if the request is successful, it will be judged as spam comments by the system and will not be displayed.","default":"Hello, TikTok!"},"cookie":{"type":"string","title":"User Cookie","description":"User Cookie, you can log in to your TikTok account in the browser and then copy the Cookie information, please use URL-encoded Cookie string when submitting.","default":"Your_Cookie_From_Browser"},"device_id":{"type":"string","title":"Device ID","description":"Device id, optional, if not filled in, it will be automatically generated, if you need to customize the device id, please use the device information interface to get the device id.","default":""},"iid":{"type":"string","title":"Device Install ID","description":"Device install id, optional, if not filled in, it will be automatically generated, if you need to customize the device iid, please use the device information interface to get the device iid.","default":""},"proxy":{"type":"string","title":"Proxy IP","description":"Proxy IP, optional, if not filled in, it will be automatically generated, if you need to customize the proxy IP, please use the proxy IP interface to get the proxy IP.","default":""}},"type":"object","title":"ReplyCommentRequest"},"ResponseModel":{"properties":{"code":{"type":"integer","title":"Code","description":"HTTP status code | HTTP状态码","default":200},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Id","description":"Unique request identifier | 唯一请求标识符"},"message":{"type":"string","title":"Message","description":"Response message (EN-US) | 响应消息 (English)","default":"Request successful. This request will incur a charge."},"message_zh":{"type":"string","title":"Message Zh","description":"Response message (ZH-CN) | 响应消息 (中文)","default":"请求成功，本次请求将被计费。"},"support":{"type":"string","title":"Support","description":"Support message | 支持消息","default":"Discord: https://discord.gg/aMEAS8Xsvz"},"time":{"type":"string","title":"Time","description":"The time the response was generated | 生成响应的时间"},"time_stamp":{"type":"integer","title":"Time Stamp","description":"The timestamp the response was generated | 生成响应的时间戳"},"time_zone":{"type":"string","title":"Time Zone","description":"The timezone of the response time | 响应时间的时区","default":"America/Los_Angeles"},"docs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Docs","description":"Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接"},"cache_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cache Message","description":"Cache message (EN-US) | 缓存消息 (English)","default":"This request will be cached. You can access the cached result directly using the URL below, valid for 24 hours. Accessing the cache will not incur additional charges."},"cache_message_zh":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cache Message Zh","description":"Cache message (ZH-CN) | 缓存消息 (中文)","default":"本次请求将被缓存，你可以使用下面的 URL 直接访问缓存结果，有效期为 24 小时，访问缓存不会产生额外费用。"},"cache_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cache Url","description":"The URL to access the cached result | 访问缓存结果的 URL"},"router":{"type":"string","title":"Router","description":"The endpoint that generated this response | 生成此响应的端点","default":""},"params":{"title":"Params","description":"The parameters used in the request | 请求中使用的参数","default":{}},"data":{"anyOf":[{},{"type":"null"}],"title":"Data","description":"The response data | 响应数据"}},"type":"object","title":"ResponseModel"},"SchoolSearchRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词，如学校名称或所在地区 / Keyword, such as school name or location","default":"北京"}},"type":"object","title":"SchoolSearchRequest"},"SearchChallengeRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"搜索关键词/Search keyword","default":"游戏"},"cursor":{"type":"integer","title":"Cursor","description":"游标/Cursor","default":0},"count":{"type":"integer","title":"Count","description":"数量/Count","default":30},"cookie":{"type":"string","title":"Cookie","description":"用户自行提供的Cookie/User provided Cookie","default":""}},"type":"object","title":"SearchChallengeRequest"},"SearchSuggestRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"需要联想的关键词/The keyword to be suggested","default":"人工智能"}},"type":"object","title":"SearchSuggestRequest"},"SubtitleFormat":{"type":"string","enum":["srt","xml","vtt","txt"],"title":"SubtitleFormat"},"TikTok_APP_Encrypt_Request":{"properties":{"url":{"type":"string","title":"Url","description":"需要加密的URL/URL to be encrypted","default":"https://api16-normal-useast5.tiktokv.us/tiktok/v1/upvote/item/list?user_id=6726034365602628610&offset=0&count=21&scene=0&iid=7425045478163400491&device_id=7349721034012280362&ac=WIFI&channel=googleplay&aid=1233&app_name=musical_ly&version_code=360704&version_name=36.7.4&device_platform=android&os=android&ab_version=36.7.4&ssmix=a&device_type=Pixel+6+Pro&device_brand=google&language=zh&os_api=33&os_version=13&openudid=711192517a8bbf03&manifest_version_code=2023607040&resolution=1440*2891&dpi=560&update_version_code=2023607040&_rticket=1728977220468&is_pad=0&app_type=normal&sys_region=CN&last_install_time=1728977141&timezone_name=America%2FLos_Angeles&app_language=zh-Hans&ac2=wifi5g&uoo=0&op_region=CN&timezone_offset=-28800&build_number=36.7.4&host_abi=arm64-v8a&locale=zh-Hans&region=CN&content_language=en%2C&ts=1728977220&cdid=aa21524b-8633-49ca-8e6e-3275fe1672db"},"data":{"type":"string","title":"Data","description":"如果有POST请求，请填写POST请求的数据参与加密计算/If there is a POST request, please fill in the data of the POST request to participate in the encryption calculation","default":""},"device_info":{"additionalProperties":true,"type":"object","title":"Device Info","description":"设备信息，可选参数，如果不填写则使用默认设备信息/Device information, optional parameter, if not filled in, the default device information is used","default":{"aid":"1233","cdid":"b820f79c-c74a-47b0-912f-ee3002ce60dc","channel":"googleplay","cookies":{},"device_brand":"HONOR","device_id":"7423364899755607598","device_manufacturer":"HUAWEI","device_model":"HONOR V30","device_platform":"android","device_type":"OXF-AN00","dpi":480,"host_abi":"arm64-v8a","iid":"7423365134775469866","lanusk":"","manifest_version_code":"2023604040","mc":"7E:EE:BA:BC:5E:40","mssdk_token":"","openudid":"63401ab5140125d1","os_api":29,"os_version":"10","resolution":"2400*1080","rom":"11.0.0.185C00","rom_version":"OXF-AN00-user 11.0.0 HUAWEIOXF-AN00 185-CHN-LGRP3 release-keys","server_time":1728386909,"ua":"com.zhiliaoapp.musically/2023604040 (Linux; U; Android 10; zh_CN; OXF-AN00; Build/185-CHN-LGRP3;tt-ok/3.12.13.4-tiktok)","update_version_code":"2023604040","uuid":"350244698061054","version_code":"360404","version_name":"36.4.4"}}},"type":"object","title":"TikTok_APP_Encrypt_Request"},"TikTok_APP_Login_Encrypt_Decrypt_Request":{"properties":{"username":{"type":"string","title":"Username","description":"Plaintext or encrypted username","default":"example_username"},"password":{"type":"string","title":"Password","description":"Plaintext or encrypted password","default":"example_password"},"mode":{"$ref":"#/components/schemas/ModeEnum","description":"Encrypt or decrypt the input string","default":"encrypt"}},"type":"object","title":"TikTok_APP_Login_Encrypt_Decrypt_Request","example":{"mode":"encrypt","password":"example_password","username":"example_username"}},"TikTok_APP_V3_Content_Translate":{"properties":{"trg_lang":{"type":"string","title":"Trg Lang","description":"目标语言ISO639-1代码，例如：zh-Hans/ Target language ISO639-1 code, e.g. zh-Hans","default":"zh-Hans"},"src_content":{"type":"string","title":"Src Content","description":"源语言内容，也就是需要翻译的内容/ Source language content, i.e. the content to be translated","default":"Hello, welcome to TikHub!"}},"type":"object","title":"TikTok_APP_V3_Content_Translate"},"TikTok_APP_V3_Home_Feed":{"properties":{"cookie":{"type":"string","title":"Cookie","description":"用户自己的cookie，可选参数，用于接口返回数据的个性化推荐。/ User's own cookie, optional parameter, used for personalized recommendations of interface return data.","default":""}},"type":"object","title":"TikTok_APP_V3_Home_Feed"},"UpdateCheckResponse":{"properties":{"latest_version":{"type":"string","title":"Latest Version","default":"1.0.0"},"update_date":{"type":"string","title":"Update Date","default":"2025-03-17"},"download_url":{"type":"string","title":"Download Url","default":"https://github.com/TikHub/TikHub-Multi-Functional-Downloader/releases/tag/V1.0.0"},"latest_download_url_win":{"type":"string","title":"Latest Download Url Win","default":"https://github.com/TikHub/TikHub-Multi-Functional-Downloader/releases/download/V1.0.0/TikHub_Downloader-Windows-1.0.0.exe"},"latest_download_url_mac":{"type":"string","title":"Latest Download Url Mac","default":"https://github.com/TikHub/TikHub-Multi-Functional-Downloader/archive/refs/tags/V1.0.0.zip"},"upload_note":{"type":"string","title":"Upload Note","default":"Bug fixes and performance improvements"}},"type":"object","title":"UpdateCheckResponse"},"UrlAccessMode":{"type":"string","enum":["normal","blocked"],"title":"UrlAccessMode"},"UserData":{"properties":{"email":{"type":"string","title":"Email"},"balance":{"type":"number","title":"Balance"},"free_credit":{"type":"number","title":"Free Credit"},"email_verified":{"type":"boolean","title":"Email Verified"},"account_disabled":{"type":"boolean","title":"Account Disabled"},"is_active":{"type":"boolean","title":"Is Active"}},"type":"object","required":["email","balance","free_credit","email_verified","account_disabled","is_active"],"title":"UserData"},"UserInfoResponseModel":{"properties":{"code":{"type":"integer","title":"Code","description":"HTTP status code | HTTP状态码","default":200},"router":{"type":"string","title":"Router","description":"The endpoint that generated this response | 生成此响应的端点","default":""},"api_key_data":{"$ref":"#/components/schemas/APIKeyData"},"user_data":{"$ref":"#/components/schemas/UserData"}},"type":"object","required":["api_key_data","user_data"],"title":"UserInfoResponseModel"},"UserSearchRequest":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"douyin_user_fans":{"type":"string","title":"Douyin User Fans","description":"粉丝数过滤：空=不限 0_1k=1千以下 1k_5k=1千到5千 5k_10k=5千到1万 10k_100k=1万到10万 100k_1M=10万到100万 1M_=100万以上 / Fans filter: empty=No limit, 0_1k=Under 1k, etc.","default":""},"douyin_user_type":{"type":"string","title":"Douyin User Type","description":"用户类型过滤：空=不限 300=创作者 900=小店 700=音乐人 800=明星 / User type filter: empty=No limit, 300=Creator, 900=Shop, 700=Musician, 800=Celebrity","default":""},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""}},"type":"object","title":"UserSearchRequest"},"UserSearchRequestV2":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0}},"type":"object","title":"UserSearchRequestV2"},"VIPVideoModel":{"properties":{"bv_id":{"type":"string","title":"Bv Id","description":"作品id/Video id","example":"BV1y7411Q7Eq"},"cid":{"type":"string","title":"Cid","description":"作品cid/Video cid","example":"171776208"},"cookie":{"type":"string","title":"Cookie","description":"大会员用户Cookie/VIP User Cookie","example":"your_vip_bilibili_cookie"}},"type":"object","required":["bv_id","cid","cookie"],"title":"VIPVideoModel"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VideoOrientation":{"type":"string","enum":["portrait","landscape"],"title":"VideoOrientation"},"VideoSearchV1Request":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"VideoSearchV1Request"},"VideoSearchV2Request":{"properties":{"keyword":{"type":"string","title":"Keyword","description":"关键词 / Keyword","default":"猫咪"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"sort_type":{"type":"string","title":"Sort Type","description":"排序方式：0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest","default":"0"},"publish_time":{"type":"string","title":"Publish Time","description":"发布时间筛选：0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year","default":"0"},"filter_duration":{"type":"string","title":"Filter Duration","description":"视频时长过滤：0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes","default":"0"},"content_type":{"type":"string","title":"Content Type","description":"内容类型：0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture, 3=Article","default":"0"},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"backtrace":{"type":"string","title":"Backtrace","description":"翻页回溯标识，用于翻页，从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from the last response","default":""}},"type":"object","title":"VideoSearchV2Request"},"VideosAudiosMode":{"type":"string","enum":["auto","true","raw","false"],"title":"VideosAudiosMode"},"VisionSearchRequest":{"properties":{"image_uri":{"type":"string","title":"Image Uri","description":"图片URI，从抖音其他接口返回中获取（如视频详情、搜索结果、用户主页等接口的图片uri字段）/ Image URI obtained from other Douyin API responses (e.g., video details, search results, user profile - look for image uri fields)"},"cursor":{"type":"integer","title":"Cursor","description":"偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response","default":0},"search_id":{"type":"string","title":"Search Id","description":"搜索ID，用于翻页，从上一次请求返回的响应中获取 / Search ID for pagination, obtained from the last response","default":""},"search_source":{"type":"string","title":"Search Source","description":"搜索来源：graphic_detail=图片详情页搜索, visual_normal_search=带关键词追加搜索 / Search source: graphic_detail=Image detail page search, visual_normal_search=Search with keyword append","default":"graphic_detail"},"detection":{"type":"string","title":"Detection","description":"检测区域坐标，格式为 x1,y1,x2,y2 / Detection area coordinates in format x1,y1,x2,y2","default":"0.1,0.1,0.9,0.9"},"detection_index":{"type":"integer","title":"Detection Index","description":"检测索引 / Detection index","default":0},"user_query":{"type":"string","title":"User Query","description":"搜索关键词，仅当search_source=visual_normal_search时使用 / Search keyword, only used when search_source=visual_normal_search","default":""},"aweme_id":{"type":"string","title":"Aweme Id","description":"原视频ID，仅当search_source=visual_normal_search时使用 / Original video ID, only used when search_source=visual_normal_search","default":""}},"type":"object","required":["image_uri"],"title":"VisionSearchRequest"},"XBogusModel":{"properties":{"url":{"type":"string","title":"Url","description":"请求的API URL，不需要进行编码 | The requested API URL, no need to encode","example":"https://www.douyin.com/aweme/v1/web/aweme/detail/?aweme_id=7148736076176215311&device_platform=webapp&aid=6383&channel=channel_pc_web&pc_client_type=1&version_code=170400&version_name=17.4.0&cookie_enabled=true&screen_width=1920&screen_height=1080&browser_language=zh-CN&browser_platform=Win32&browser_name=Edge&browser_version=117.0.2045.47&browser_online=true&engine_name=Blink&engine_version=117.0.0.0&os_name=Windows&os_version=10&cpu_core_num=128&device_memory=10240&platform=PC&downlink=10&effective_type=4g&round_trip_time=100"},"user_agent":{"type":"string","title":"User Agent","description":"请求API时的User-Agent | User-Agent when requesting the API","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"}},"type":"object","required":["url","user_agent"],"title":"XBogusModel"},"XGnarlyAndXBogusModel":{"properties":{"url":{"type":"string","title":"Url","description":"包含域名和参数的请求的API URL，不需要进行URL编码 | The requested API URL, no need to URL encode","examples":["https://www.tiktok.com/api/search/user/full/?WebIdLastTime=1756087650&aid=1988&app_language=zh-Hans&app_name=tiktok_web&browser_language=zh-CN&browser_name=Mozilla&browser_online=true&browser_platform=MacIntel&browser_version=5.0%20%28Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F139.0.0.0%20Safari%2F537.36&channel=tiktok_web&cookie_enabled=true&cursor=10&data_collection_enabled=false&device_id=7542339104672111234&device_platform=web_pc&focus_state=true&from_page=search&history_len=3&is_fullscreen=true&is_page_visible=true&keyword=musk&odinId=7542338997269211234&os=mac&priority_region&referer&region=US&screen_height=967&screen_width=1496&search_id&tz_name=America%2FLos_Angeles&user_is_login=false&web_search_code=%7B%22tiktok%22%3A%7B%22client_params_x%22%3A%7B%22search_engine%22%3A%7B%22ies_mt_user_live_video_card_use_libra%22%3A1%2C%22mt_search_general_user_live_card%22%3A1%7D%7D%2C%22search_server%22%3A%7B%7D%7D%7D&webcast_language=zh-Hans"]},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body","description":"请求的API参数，适用于POST请求 | The API parameters of the request, applicable for POST requests","default":""}},"type":"object","required":["url"],"title":"XGnarlyAndXBogusModel"},"XMssdkInfoModel":{"properties":{"user_agent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Agent","description":"可选的用户代理字符串，目前不支持自定义，默认为固定的值 | Optional User-Agent string, currently not supported for customization, defaults to a fixed value"}},"type":"object","title":"XMssdkInfoModel"},"XhsWebSignRequestModel":{"properties":{"path":{"type":"string","title":"Path","description":"请求接口的路径/Request API path","default":"/api/sns/web/v1/homefeed"},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"请求API的荷载数据/Payload data of request API","default":{"cursor_score":"","num":35,"refresh_type":1,"note_index":35,"unread_begin_note_id":"","unread_end_note_id":"","unread_note_count":0,"category":"homefeed_recommend","search_key":"","need_num":10,"image_formats":["jpg","webp","avif"],"need_filter_image":false}},"cookie":{"type":"string","title":"Cookie","description":"请求接口的Cookie/Request API cookie","default":"web_session=030037a04eafd37791e6e4bd05204a8cf2af05;acw_tc=0a00d79f17363096679345838efb77751cc087fb039dd1691dc954824410f6;abRequestId=384480ae-5196-5818-a835-42e6278de9f0;webBuild=4.47.1;xsecappid=xhs-pc-web;a1=194441ef694PayUbdUvgp0dSHfIcACsNsLud0Lgru50000354513;webId=6cf10a564b9b07d129729b65e0d1785a;sec_poison_id=32964532-d414-4beb-914f-98811853b75f"}},"type":"object","title":"XhsWebSignRequestModel"},"YouTubeContentTypeAPI":{"type":"string","enum":["video","channel","playlist","movie"],"title":"YouTubeContentTypeAPI","description":"YouTube内容类型过滤 - API显示版本"},"YouTubeDurationAPI":{"type":"string","enum":["short","medium","long"],"title":"YouTubeDurationAPI","description":"YouTube视频时长过滤 - API显示版本"},"YouTubeFeatureAPI":{"type":"string","enum":["live","4k","hd","subtitles","creative_commons","360","vr180","3d","hdr","location","purchased"],"title":"YouTubeFeatureAPI","description":"YouTube特征过滤 - API显示版本"},"YouTubeSearchSortAPI":{"type":"string","enum":["relevance","upload_date","view_count","rating"],"title":"YouTubeSearchSortAPI","description":"YouTube搜索排序方式 - API显示版本"},"YouTubeUploadTimeAPI":{"type":"string","enum":["hour","today","week","month","year"],"title":"YouTubeUploadTimeAPI","description":"YouTube上传时间过滤 - API显示版本"},"iOS_Shortcut":{"properties":{"version":{"type":"string","title":"Version"},"update":{"type":"string","title":"Update"},"link":{"type":"string","title":"Link"},"link_en":{"type":"string","title":"Link En"},"note":{"type":"string","title":"Note"},"note_en":{"type":"string","title":"Note En"}},"type":"object","required":["version","update","link","link_en","note","note_en"],"title":"iOS_Shortcut"}},"securitySchemes":{"HTTPBearer":{"type":"http","description":"----\n#### API Token Introduction:\n##### Method 1: Use API Token in the Request Header (Recommended)\n- **Header**: `Authorization`\n- **Format**: `Bearer {token}`\n- **Example**: `{\"Authorization\": \"Bearer your_token\"}`\n- **Swagger UI**: Click on the `Authorize` button in the upper right corner of the page to enter the API token directly without the `Bearer` keyword.\n\n##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only When Method 1 is Unavailable)\n- **Cookie**: `Authorization`\n- **Format**: `Bearer {token}`\n- **Example**: `Authorization=Bearer your_token`\n\n#### Get API Token:\n1. Register and log in to your account on the TikHub website.\n2. Go to the user center, click on the API token menu, and create an API token.\n3. Copy and use the API token in the request header.\n4. Keep your API token confidential and use it only in the request header.\n\n----\n\n#### API令牌简介:\n##### 方法一：在请求头中使用API令牌（推荐）\n- **请求头**: `Authorization`\n- **格式**: `Bearer {token}`\n- **示例**: `{\"Authorization\": \"Bearer your_token\"}`\n- **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。\n\n##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用）\n- **Cookie**: `Authorization`\n- **格式**: `Bearer {token}`\n- **示例**: `Authorization=Bearer your_token`\n\n#### 获取API令牌:\n1. 在TikHub网站注册并登录账户。\n2. 进入用户中心，点击API令牌菜单，创建API令牌。\n3. 复制并在请求头中使用API令牌。\n4. 保密您的API令牌，仅在请求头中使用。\n","scheme":"bearer"}}},"tags":[{"name":"Health-Check","description":"**(服务器健康检查/Server Health Check)**"},{"name":"TikHub-Downloader-API","description":"**(TikHub下载器接口/TikHub-Downloader-API endpoints)**"},{"name":"Demo-API","description":"**(TikHub API示例项目/Demo Project)**"},{"name":"TikHub-User-API","description":"**(TikHub用户数据接口/TikHub-User-API endpoints)**"},{"name":"Douyin-Web-API","description":"**(抖音Web数据接口/Douyin-Web-API data endpoints)**"},{"name":"Douyin-App-V1-API","description":"**(抖音-App-V2数据接口（旧版接口已弃用并下架，请使用新版 V3 接口）/Douyin-App-V1-API (This version is deprecated and removed, please use the new V3 version))**"},{"name":"Douyin-App-V2-API","description":"**(抖音-App-V2数据接口（旧版接口已弃用并下架，请使用新版 V3 接口）/Douyin-App-V2-API (This version is deprecated and removed, please use the new V3 version))**"},{"name":"Douyin-App-V3-API","description":"**(抖音-App-V3数据接口（当前最新版本）/Douyin-App-V3-API (Current latest version))**"},{"name":"Douyin-Creator-API","description":"**(抖音创作者数据接口/Douyin-Creator-API data endpoints)**"},{"name":"Douyin-Creator-V2-API","description":"**(抖音创作者V2数据接口（需要用户Cookie，可获取作品流量总览等数据）/Douyin-Creator-V2-API data endpoints (Requires user Cookie, can get item traffic overview data))**"},{"name":"Douyin-Search-API","description":"**(抖音搜索数据接口（当前最新版，请优先使用此目录下的接口而不是其他目录下的搜索接口）/Douyin-Search-API data endpoints (Current latest version, please use the interfaces in this directory first instead of the search interfaces in other directories))**"},{"name":"Douyin-Billboard-API","description":"**(抖音热点榜数据接口/Douyin-Billboard-API data endpoints)**"},{"name":"Douyin-Xingtu-API","description":"**(抖音星图数据接口/Douyin-Xingtu-API data endpoints)**"},{"name":"Douyin-Xingtu-V2-API","description":"**(抖音星图V2数据接口/Douyin-Xingtu-V2-API data endpoints)**"},{"name":"TikTok-Web-API","description":"**(TikTok-Web-API数据接口/TikTok-Web-API data endpoints)**"},{"name":"TikTok-App-V2-API","description":"**(TikTok-App-V2-API数据接口（（旧版接口已弃用并下架，请使用新版 V3 接口）/TikTok-App-V2-API (This version is deprecated and removed, please use the new V3 version))**"},{"name":"TikTok-App-V3-API","description":"**(TikTok-App-V3-API数据接口（当前最新版本）/TikTok-App-V3-API (Current latest version))**"},{"name":"TikTok-Creator-API","description":"**(TikTok创作者数据和账号收益数据接口/TikTok-Creator-API data and account revenue data endpoints)**"},{"name":"TikTok-Analytics-API","description":"**(TikTok数据分析接口/TikTok-Analytics-API data analysis endpoints)**"},{"name":"TikTok-Ads-API","description":"**(TikTok广告创意中心数据接口/TikTok-Ads-Creative-Center-API endpoints)**"},{"name":"TikTok-Shop-Web-API","description":"**(TikTok电商网页版数据接口/TikTok-Shop-Web-API data endpoints)**"},{"name":"TikTok-Interaction-API","description":"**(TikTok交互类接口（不在提供该业务）/TikTok-Interaction-API (This service is no longer available))**"},{"name":"Xigua-App-V2-API","description":"**(西瓜视频App V2数据接口/Xigua-App-V2-API data endpoints)**"},{"name":"Toutiao-Web-API","description":"**(今日头条Web数据接口/Toutiao-Web-API data endpoints)**"},{"name":"Toutiao-App-API","description":"**(今日头条App数据接口/Toutiao-App-API data endpoints)**"},{"name":"Xiaohongshu-App-V2-API","description":"**(小红书App V2数据接口/Xiaohongshu-App-V2-API data endpoints)** ⭐ 推荐优先使用/Recommended first choice - 稳定性最高、功能最全/Most stable and feature-rich"},{"name":"Xiaohongshu-App-API","description":"**(小红书App数据接口/Xiaohongshu-App-API data endpoints)** - 第二优先/Second choice"},{"name":"Xiaohongshu-Web-V2-API","description":"**(小红书Web V2数据接口/Xiaohongshu-Web-V2-API data endpoints)** - 第三优先/Third choice"},{"name":"Xiaohongshu-Web-API","description":"**(小红书Web数据接口/Xiaohongshu-Web-API data endpoints)** - 第四优先/Fourth choice"},{"name":"Lemon8-App-API","description":"**(Lemon8 APP数据接口/Lemon8-APP-API data endpoints)**"},{"name":"Bilibili-Web-API","description":"**(哔哩哔哩Web数据接口/Bilibili-Web-API data endpoints)**"},{"name":"Bilibili-App-API","description":"**(哔哩哔哩App数据接口/Bilibili-App-API data endpoints)**"},{"name":"Sora2-API","description":"**(Sora2 接口/Sora2 API endpoints)**"},{"name":"Kuaishou-Web-API","description":"**(快手Web数据接口/Kuaishou-Web-API data endpoints)**"},{"name":"Kuaishou-App-API","description":"**(快手App数据接口/Kuaishou-App-API data endpoints)**"},{"name":"PiPiXia-App-API","description":"**(皮皮虾App数据接口/PiPiXia-App-API data endpoints)**"},{"name":"WeChat-Media-Platform-Web-API","description":"**(微信公众号Web数据接口/WeChat-Media-Platform-Web-API data endpoints)**"},{"name":"WeChat-Channels-API","description":"**(微信视频号数据接口/WeChat-Channels-API data endpoints)**"},{"name":"Weibo-Web-API","description":"**(新浪微博Web数据接口/Weibo-Web-API data endpoints)**"},{"name":"Weibo-Web-V2-API","description":"**(新浪微博 Web V2 数据接口/Weibo-Web-V2-API data endpoints)**"},{"name":"Weibo-App-API","description":"**(新浪微博APP数据接口/Weibo-App-API data endpoints)**"},{"name":"Instagram-Web-And-APP-API","description":"**(Instagram Web和App数据接口（已下架，请使用V1或V2接口）/Instagram-Web-And-APP-API endpoints (Deprecated, please use V1 or V2 endpoints))**"},{"name":"Instagram-V1-API","description":"**(Instagram V1数据接口（优先使用V1接口，V2接口仅在V1接口无法满足需求时使用）/Instagram-V1-API endpoints (Prefer using V1 endpoints, V2 endpoints are only for use when V1 endpoints cannot meet the requirements))**"},{"name":"Instagram-V2-API","description":"**(Instagram V2数据接口（若V1接口的功能无法满足需求时使用，稳定性不如V1接口）/Instagram-V2-API endpoints (Use when V1 endpoints cannot meet the requirements, stability is not as good as V1 endpoints))**"},{"name":"Instagram-V3-API","description":"**(Instagram V3数据接口/Instagram-V3-API endpoints)**"},{"name":"YouTube-Web-API","description":"**(YouTube Web数据接口/YouTube-Web-API endpoints)**"},{"name":"YouTube-Web-V2-API","description":"**(YouTube Web V2数据接口/YouTube-Web-V2-API endpoints)**"},{"name":"NetEase-Cloud-Music-API","description":"**(网易云音乐App数据接口/NetEase-Cloud-Music-API endpoints)**"},{"name":"Twitter-Web-API","description":"**(Twitter Web数据接口/Twitter-Web-API endpoints)**"},{"name":"Threads-Web-API","description":"**(Threads Web数据接口/Threads-Web-API endpoints)**"},{"name":"Reddit-Web-API","description":"**(Reddit Web数据接口/Reddit-Web-API endpoints)**"},{"name":"Reddit-APP-API","description":"**(Reddit APP数据接口/Reddit-APP-API endpoints)**"},{"name":"LinkedIn-Web-API","description":"**(LinkedIn Web数据接口/LinkedIn-Web-API endpoints)**"},{"name":"Zhihu-Web-API","description":"**(知乎Web数据接口/Zhihu-Web-API endpoints)**"},{"name":"Captcha-Solver","description":"**(各种验证码绕过接口/Captcha-Solver endpoints)**"},{"name":"Temp-Mail-API","description":"**(临时邮箱接口/Temp-Mail-API endpoints)**"},{"name":"Hybrid-Parsing","description":"**(混合解析单个视频接口/Hybrid-Parsing endpoints)**"},{"name":"iOS-Shortcut","description":"**(iOS快捷方式接口/iOS-Shortcut endpoints)**"}]}