{ "openapi": "3.1.0", "info": { "title": "OpenAPI definition", "version": "v0" }, "servers": [ { "url": "https://api.justoneapi.com", "description": "Global production API (default)" } ], "tags": [ { "name": "WeChat Official Accounts", "description": "WeChat Official Accounts articles, engagement metrics, search, and publisher timelines for content intelligence.", "x-platform-id": "wechat-official-accounts", "x-platform-aliases": [ "WeChat Official Accounts", "WeChat OA", "微信公众号", "公众号" ], "x-platform-detection-aliases": [ "WeChat Official Accounts", "WeChat OA", "微信公众号", "公众号" ] }, { "name": "WeChat Channels", "description": "WeChat Channels videos, creators, comments, search, and publisher content for media monitoring and discovery.", "x-platform-id": "wechat-channels", "x-platform-aliases": [ "WeChat Channels", "微信视频号", "视频号" ], "x-platform-detection-aliases": [ "WeChat Channels", "微信视频号", "视频号" ] }, { "name": "Zhihu", "description": "Zhihu answers, columns, articles, and search data for knowledge content analysis and topic discovery.", "x-platform-id": "zhihu", "x-platform-aliases": [ "Zhihu", "知乎" ], "x-platform-detection-aliases": [ "Zhihu", "知乎" ] }, { "name": "YouTube", "description": "YouTube channel uploads and video details for content indexing, creator monitoring, and media analysis.", "x-platform-id": "youtube", "x-platform-aliases": [ "YouTube", "油管" ], "x-platform-detection-aliases": [ "YouTube", "油管" ] }, { "name": "YOUKU", "description": "Youku video discovery, video details, and user profiles for media lookup and entertainment research.", "x-platform-id": "youku", "x-platform-aliases": [ "YOUKU", "Youku", "优酷" ], "x-platform-detection-aliases": [ "YOUKU", "Youku", "优酷" ] }, { "name": "Xiaohongshu (RedNote)", "description": "Xiaohongshu notes, comments, users, search, and link resolution for content monitoring and creator research.", "x-platform-id": "xiaohongshu-rednote", "x-platform-aliases": [ "Xiaohongshu", "RedNote", "小红书" ], "x-platform-detection-aliases": [ "Xiaohongshu", "RedNote", "小红书" ] }, { "name": "Xiaohongshu Creator Marketplace (Pugongying)", "description": "Xiaohongshu creator marketplace profiles, audience insights, content performance, and campaign analytics.", "x-platform-id": "xiaohongshu-creator-marketplace-pugongying", "x-platform-aliases": [ "Xiaohongshu Pugongying", "Pugongying", "小红书蒲公英", "蒲公英" ], "x-platform-detection-aliases": [ "Xiaohongshu Pugongying", "Pugongying", "小红书蒲公英", "蒲公英" ] }, { "name": "Xiaohongshu E-commerce (RedNote)", "description": "Xiaohongshu E-commerce product search for discovering marketplace products by keyword.", "x-platform-id": "xiaohongshu-e-commerce-rednote", "x-platform-aliases": [ "Xiaohongshu E-commerce", "RedNote E-commerce", "Xiaohongshu product search", "RedNote product search", "小红书电商", "小红书商品搜索" ], "x-platform-detection-aliases": [ "Xiaohongshu E-commerce", "RedNote E-commerce", "Xiaohongshu product search", "RedNote product search", "小红书电商", "小红书商品搜索" ] }, { "name": "Xianyu (GooFish)", "description": "Xianyu second-hand marketplace listings and details for resale research, seller analysis, and price monitoring.", "x-platform-id": "xianyu-goofish", "x-platform-aliases": [ "Xianyu", "GooFish", "闲鱼" ], "x-platform-detection-aliases": [ "Xianyu", "GooFish", "闲鱼" ] }, { "name": "Weibo", "description": "Weibo posts, comments, hot search rankings, account details, and follower data for social listening and research.", "x-platform-id": "weibo", "x-platform-aliases": [ "Weibo", "微博" ], "x-platform-detection-aliases": [ "Weibo", "微博" ] }, { "name": "Twitter", "description": "Twitter profiles and timelines for creator research, account monitoring, and content aggregation.", "x-platform-id": "twitter", "x-platform-aliases": [ "Twitter", "X" ], "x-platform-detection-aliases": [ "Twitter" ] }, { "name": "Toutiao", "description": "Toutiao articles, videos, profiles, and search data for news monitoring, publisher analysis, and topic research.", "x-platform-id": "toutiao", "x-platform-aliases": [ "Toutiao", "今日头条", "头条" ], "x-platform-detection-aliases": [ "Toutiao", "今日头条", "头条" ] }, { "name": "TikTok", "description": "TikTok users, posts, comments, and search data for global short-video monitoring and creator research.", "x-platform-id": "tiktok", "x-platform-aliases": [ "TikTok", "抖音国际版" ], "x-platform-detection-aliases": [ "TikTok", "抖音国际版" ] }, { "name": "TikTok Shop", "description": "TikTok Shop product search and product detail data for social commerce catalog workflows.", "x-platform-id": "tiktok-shop", "x-platform-aliases": [ "TikTok Shop", "TikTok电商" ], "x-platform-detection-aliases": [ "TikTok Shop", "TikTok电商" ] }, { "name": "Temu", "description": "Temu marketplace homepage product feeds for product sourcing, catalog monitoring, and trend research.", "x-platform-id": "temu", "x-platform-aliases": [ "Temu", "Temu marketplace", "Temu 电商" ], "x-platform-detection-aliases": [ "Temu", "Temu marketplace", "Temu 电商" ] }, { "name": "Taobao and Tmall", "description": "Taobao and Tmall marketplace product, review, search, and shop catalog data for commerce intelligence workflows.", "x-platform-id": "taobao-and-tmall", "x-platform-aliases": [ "Taobao", "Tmall", "淘宝", "天猫" ], "x-platform-detection-aliases": [ "Taobao", "Tmall", "淘宝", "天猫" ] }, { "name": "Shopee", "description": "Shopee marketplace product, shop, review, search, and category data across Taiwan, Indonesia, and Thailand, with installment data where supported.", "x-platform-id": "shopee", "x-platform-aliases": [ "Shopee", "Shopee marketplace", "虾皮" ], "x-platform-detection-aliases": [ "Shopee", "Shopee marketplace", "虾皮" ] }, { "name": "Social Media", "description": "Cross-platform social media discovery, monitoring, and trend research across supported content platforms.", "x-platform-id": "social-media", "x-platform-aliases": [ "social media", "社交媒体", "跨平台搜索" ], "x-platform-detection-aliases": [ "social media", "社交媒体", "跨平台搜索" ] }, { "name": "Reddit", "description": "Reddit search, posts, and comments for community monitoring and discussion analysis.", "x-platform-id": "reddit", "x-platform-aliases": [ "Reddit" ], "x-platform-detection-aliases": [ "Reddit" ] }, { "name": "QQ Huxuan Creator Marketplace", "description": "Tencent creator marketplace search, profiles, recent videos, and articles for campaign planning and creator evaluation.", "x-platform-id": "qq-huxuan-creator-marketplace", "x-platform-aliases": [ "QQ Huxuan", "Tencent Huxuan", "腾讯互选", "互选" ], "x-platform-detection-aliases": [ "QQ Huxuan", "Tencent Huxuan", "腾讯互选", "互选" ] }, { "name": "LLM", "description": "Large-language-model answer collection from supported client experiences for response monitoring and comparison.", "x-platform-id": "llm", "x-platform-aliases": [ "LLM", "large language model", "大模型", "大模型问答" ], "x-platform-detection-aliases": [ "LLM", "large language model", "大模型", "大模型问答" ] }, { "name": "LinkedIn", "description": "LinkedIn professional profiles, user activity posts, and post comments for professional research and content analysis.", "x-platform-id": "linkedin", "x-platform-aliases": [ "LinkedIn", "领英" ], "x-platform-detection-aliases": [ "LinkedIn", "领英" ] }, { "name": "Kuaishou", "description": "Kuaishou user, video, comment, search, and link resolution data for account monitoring and content discovery.", "x-platform-id": "kuaishou", "x-platform-aliases": [ "Kuaishou", "快手" ], "x-platform-detection-aliases": [ "Kuaishou", "快手" ] }, { "name": "JD.com", "description": "JD.com product details, reviews, and store catalog data for commerce intelligence and catalog monitoring.", "x-platform-id": "jdcom", "x-platform-aliases": [ "JD.com", "JD", "京东" ], "x-platform-detection-aliases": [ "JD.com", "JD", "京东" ] }, { "name": "Instagram", "description": "Instagram profiles, posts, reels, and hashtag search for social analytics and creator research.", "x-platform-id": "instagram", "x-platform-aliases": [ "Instagram", "IG" ], "x-platform-detection-aliases": [ "Instagram", "IG" ] }, { "name": "IMDb", "description": "IMDb title details, rankings, cast, reviews, awards, releases, and streaming metadata for media intelligence.", "x-platform-id": "imdb", "x-platform-aliases": [ "IMDb", "互联网电影资料库" ], "x-platform-detection-aliases": [ "IMDb", "互联网电影资料库" ] }, { "name": "Facebook", "description": "Facebook page and post lookup data for account monitoring, keyword discovery, and social content analysis.", "x-platform-id": "facebook", "x-platform-aliases": [ "Facebook", "FB" ], "x-platform-detection-aliases": [ "Facebook", "FB" ] }, { "name": "Douyin (TikTok China)", "description": "Douyin user, video, comment, and search data for content intelligence, account monitoring, and discovery.", "x-platform-id": "douyin-tiktok-china", "x-platform-aliases": [ "Douyin", "TikTok China", "抖音" ], "x-platform-detection-aliases": [ "Douyin", "TikTok China", "抖音" ] }, { "name": "Douyin Creator Marketplace (Xingtu)", "description": "Douyin Xingtu creator metrics, audience structure, commerce data, and campaign analytics for creator marketing.", "x-platform-id": "douyin-creator-marketplace-xingtu", "x-platform-aliases": [ "Douyin Xingtu", "Xingtu", "巨量星图", "星图" ], "x-platform-detection-aliases": [ "Douyin Xingtu", "Xingtu", "巨量星图", "星图" ] }, { "name": "Douyin E-commerce", "description": "Douyin E-commerce product and catalog data for enrichment, price monitoring, and commerce analytics.", "x-platform-id": "douyin-e-commerce", "x-platform-aliases": [ "Douyin E-commerce", "抖音电商" ], "x-platform-detection-aliases": [ "Douyin E-commerce", "抖音电商" ] }, { "name": "Douban Movie", "description": "Douban Movie titles, reviews, comments, and hot lists for entertainment analysis and catalog enrichment.", "x-platform-id": "douban-movie", "x-platform-aliases": [ "Douban Movie", "豆瓣电影", "豆瓣" ], "x-platform-detection-aliases": [ "Douban Movie", "豆瓣电影", "豆瓣" ] }, { "name": "Dewu (Poizon)", "description": "Dewu marketplace product discovery and catalog data for trend research, assortment tracking, and price monitoring.", "x-platform-id": "dewu-poizon", "x-platform-aliases": [ "Dewu", "Poizon", "得物" ], "x-platform-detection-aliases": [ "Dewu", "Poizon", "得物" ] }, { "name": "Bilibili", "description": "Bilibili video metadata, comments, danmaku, captions, users, and uploads for media analysis and discovery.", "x-platform-id": "bilibili", "x-platform-aliases": [ "Bilibili", "哔哩哔哩", "B站" ], "x-platform-detection-aliases": [ "Bilibili", "哔哩哔哩", "B站" ] }, { "name": "Beike", "description": "Beike neighborhood and resale housing data for property search, listing analysis, and market research.", "x-platform-id": "beike", "x-platform-aliases": [ "Beike", "贝壳", "贝壳找房" ], "x-platform-detection-aliases": [ "Beike", "贝壳", "贝壳找房" ] }, { "name": "Amazon", "description": "Amazon catalog data, reviews, best-seller rankings, and category listings for market research and enrichment.", "x-platform-id": "amazon", "x-platform-aliases": [ "Amazon", "亚马逊" ], "x-platform-detection-aliases": [ "Amazon", "亚马逊" ] }, { "name": "1688", "description": "Alibaba 1688 wholesale marketplace product, shop, supplier, and catalog data for sourcing and commerce research.", "x-platform-id": "1688", "x-platform-aliases": [ "1688", "Alibaba 1688", "阿里巴巴1688" ], "x-platform-detection-aliases": [ "1688", "Alibaba 1688", "阿里巴巴1688" ] } ], "paths": { "/api/search/v1": { "get": { "tags": [ "Social Media" ], "summary": "Cross-Platform Search", "description": "Searches recent content across news, Weibo, WeChat, Zhihu, Douyin, Xiaohongshu, Bilibili, and Kuaishou with source and time filters. Use it to monitor a topic across multiple platforms.", "operationId": "getApiSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search query string. Supports these five syntax forms:\n- AND (&&): A && B matches content containing both A and B.\n- OR (||): A || B matches content containing A or B.\n- Exclusion (-): -A matches content that does not contain A.\n- Parentheses (): (A && B) || C matches content containing C, or both A and B.\n- English double quotes (\"\"): \"A\" disables tokenization and requires an exact match for A.\n", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Target social media platform for search filtering.\n\nAvailable Values:\n- `ALL`: All platforms\n- `NEWS`: News\n- `WEIBO`: Sina Weibo\n- `WEIXIN`: Weixin (WeChat)\n- `ZHIHU`: Zhihu\n- `DOUYIN`: Douyin (TikTok China)\n- `XIAOHONGSHU`: Xiaohongshu (Little Red Book)\n- `BILIBILI`: Bilibili\n- `KUAISHOU`: Kuaishou", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Platform types for social media search.", "enum": [ "ALL", "NEWS", "WEIBO", "WEIXIN", "ZHIHU", "DOUYIN", "XIAOHONGSHU", "BILIBILI", "KUAISHOU" ] } }, { "name": "start", "in": "query", "description": "Start time of the search period (yyyy-MM-dd HH:mm:ss). Required for initial request.", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "description": "End time of the search period (yyyy-MM-dd HH:mm:ss). Required for initial request.", "required": false, "schema": { "type": "string" } }, { "name": "nextCursor", "in": "query", "description": "Pagination cursor provided by the 'nextCursor' field in the previous response.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "10001000", "x-api-version": "v1", "x-search-aliases": [ "cross-platform social media search", "multi-platform content search", "social media time range search", "跨平台社交媒体搜索", "全网内容关键词查询", "多平台舆情搜索" ], "x-highlights": [ { "type": "info", "kind": "GUIDANCE", "content": "This endpoint returns cached data." }, { "type": "warning", "kind": "GUIDANCE", "content": "This endpoint does not return all available data. Results for less common keywords may be incomplete." } ], "x-endpoint-family": "search" } }, "/api/taobao/get-item-detail/v1": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Details", "description": "Retrieves Taobao or Tmall product details by item ID through the V1 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis.", "operationId": "getApiTaobaoGetItemDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001000", "x-api-version": "v1", "x-search-aliases": [ "Taobao product details v1", "Tmall item detail lookup", "Taobao item information API", "淘宝商品详情 V1", "天猫商品详情查询", "淘宝商品 ID 查询" ], "x-highlights": [ { "type": "tip", "kind": "CONDITION", "content": "Some products may not be available through this endpoint.", "concept": "product_coverage", "aliases": [ "product coverage", "supported products", "商品覆盖", "支持商品" ] } ], "x-endpoint-family": "taobao_get_item_detail" } }, "/api/taobao/get-item-detail/v2": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Details", "description": "Access the asynchronous Taobao and Tmall product detail workflow from the Just One API dashboard Task Management page. Use it to submit and download product detail research tasks.", "operationId": "getApiTaobaoGetItemDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001100", "x-api-version": "v2", "x-search-aliases": [ "Taobao asynchronous product details", "Tmall product detail task", "Taobao dashboard task download", "淘宝异步商品详情", "天猫商品详情任务", "淘宝后台任务下载" ], "x-highlights": [ { "type": "danger", "kind": "LIMITATION", "content": "Direct calls to this endpoint do not fetch product data.", "concept": "direct_api_call", "aliases": [ "direct API call", "synchronous API call", "直接调用", "同步调用" ] }, { "type": "info", "kind": "GUIDANCE", "content": "Submit the task, wait for completion, and download the result from the Just One API dashboard Task Management page: https://dashboard.justoneapi.com/en/dashboard/task-records or https://dashboard.justoneapi.com/zh/dashboard/task-records." } ], "x-endpoint-family": "taobao_get_item_detail" } }, "/api/taobao/get-item-detail/v3": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Details", "description": "Retrieves Taobao or Tmall product details by item ID through the V3 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis.", "operationId": "getApiTaobaoGetItemDetailV3", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001150", "x-api-version": "v3", "x-search-aliases": [ "Taobao product details v3", "Tmall item detail lookup v3", "Taobao item information API v3", "淘宝商品详情 V3", "天猫商品详情查询 V3", "淘宝商品 ID 查询 V3" ], "x-recommended": true, "x-highlights": [], "x-endpoint-family": "taobao_get_item_detail" } }, "/api/taobao/get-item-detail/v4": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Details", "description": "Retrieves Taobao or Tmall product details by item ID through the V4 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis.", "operationId": "getApiTaobaoGetItemDetailV4", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001200", "x-api-version": "v4", "x-search-aliases": [ "Taobao product details v4", "Tmall item detail lookup v4", "Taobao item information API v4", "淘宝商品详情 V4", "天猫商品详情查询 V4", "淘宝商品 ID 查询 V4" ], "x-highlights": [ { "type": "tip", "kind": "CONDITION", "content": "Some products may not be available through this endpoint.", "concept": "product_coverage", "aliases": [ "product coverage", "supported products", "商品覆盖", "支持商品" ] }, { "type": "tip", "kind": "CAPABILITY", "content": "This endpoint can retrieve the price after applying coupons.", "concept": "post_coupon_price", "aliases": [ "price after coupon", "post-coupon price", "券后价", "优惠券后价格" ] } ], "x-endpoint-family": "taobao_get_item_detail" } }, "/api/taobao/get-item-detail/v5": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Details", "description": "Retrieves Taobao or Tmall product details by item ID through the V5 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis.", "operationId": "getApiTaobaoGetItemDetailV5", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001300", "x-api-version": "v5", "x-search-aliases": [ "Taobao product details v5", "Tmall item detail lookup v5", "Taobao item information API v5", "淘宝商品详情 V5", "天猫商品详情查询 V5", "淘宝商品 ID 查询 V5" ], "x-highlights": [ { "type": "tip", "kind": "CONDITION", "content": "Some products may not be available through this endpoint.", "concept": "product_coverage", "aliases": [ "product coverage", "supported products", "商品覆盖", "支持商品" ] } ], "x-endpoint-family": "taobao_get_item_detail" } }, "/api/taobao/get-item-detail/v7": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Details", "description": "Retrieves Taobao or Tmall product details by item ID through the V7 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis.", "operationId": "getApiTaobaoGetItemDetailV7", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001375", "x-api-version": "v7", "x-search-aliases": [ "Taobao product details v7", "Tmall item detail lookup v7", "Taobao item information API v7", "淘宝商品详情 V7", "天猫商品详情查询 V7", "淘宝商品 ID 查询 V7" ], "x-highlights": [ { "type": "tip", "kind": "GUIDANCE", "content": "This endpoint supports all Taobao and Tmall products." } ], "x-endpoint-family": "taobao_get_item_detail" } }, "/api/taobao/get-item-detail/v9": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Details", "description": "Retrieves Taobao or Tmall product details by item ID through the V9 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis.", "operationId": "getApiTaobaoGetItemDetailV9", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001400", "x-api-version": "v9", "x-search-aliases": [ "Taobao product details v9", "Tmall item detail lookup v9", "Taobao item information API v9", "淘宝商品详情 V9", "天猫商品详情查询 V9", "淘宝商品 ID 查询 V9" ], "x-highlights": [ { "type": "tip", "kind": "CONDITION", "content": "Some products may not be available through this endpoint.", "concept": "product_coverage", "aliases": [ "product coverage", "supported products", "商品覆盖", "支持商品" ] } ], "x-endpoint-family": "taobao_get_item_detail" } }, "/api/taobao/get-item-comment/v3": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Reviews", "description": "Retrieves Taobao and Tmall product reviews by item ID with page-based pagination and configurable sorting. Use it to analyze customer feedback.", "operationId": "getApiTaobaoGetItemCommentV3", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `feedbackdate`: Sort by feedback date\n- `general`: General sorting", "required": false, "schema": { "type": "string", "default": "feedbackdate", "description": "Sort order for product comments", "enum": [ "feedbackdate", "general" ] } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001500", "x-api-version": "v3", "x-search-aliases": [ "Taobao product reviews API", "Tmall item comments", "Taobao review list v3", "淘宝商品评价接口", "天猫商品评论", "淘宝评价列表 V3" ], "x-highlights": [], "x-endpoint-family": "taobao_get_item_comment" } }, "/api/taobao/get-social-feed/v1": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Questions", "description": "Retrieves the Taobao or Tmall product social feed by item ID with page-based pagination. Use it to review product questions and related discussion during customer-concern or product research.", "operationId": "getApiTaobaoGetSocialFeedV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001550", "x-api-version": "v1", "x-search-aliases": [ "Taobao product question feed", "Tmall item social feed", "Taobao buyer questions API", "淘宝商品问答动态", "天猫商品社交动态", "淘宝买家问题接口" ], "x-highlights": [], "x-endpoint-family": "taobao_get_social_feed" } }, "/api/taobao/get-shop-item-list/v1": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Shop Product List", "description": "Retrieves products from a Taobao or Tmall shop by seller or user ID, with page-based pagination and default or sales sorting. Use it to browse or monitor a seller catalog.", "operationId": "getApiTaobaoGetShopItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "Shop identifier. Also known as Seller ID or User ID (they refer to the same value).", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `_sale`: Sales\n- `_default`: Default", "required": false, "schema": { "type": "string", "default": "_sale", "description": "Taobao shop item list sorting options", "enum": [ "_sale", "_default" ] } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001600", "x-api-version": "v1", "x-search-aliases": [ "Taobao shop product list v1", "Tmall seller catalog", "Taobao products by seller ID", "淘宝店铺商品列表 V1", "天猫卖家商品目录", "淘宝按卖家 ID 查商品" ], "x-highlights": [ { "type": "tip", "kind": "CONDITION", "content": "For some stores, the returned product list may be empty.", "concept": "shop_product_coverage", "aliases": [ "shop product coverage", "shop product list", "店铺商品覆盖", "店铺商品列表" ] } ], "x-endpoint-family": "taobao_get_shop_item_list" } }, "/api/taobao/get-shop-item-list/v2": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Shop Product List", "description": "Retrieves products from a Taobao or Tmall shop using both seller or user ID and shop ID, with page-based pagination and configurable sorting. Use it to browse a known shop catalog.", "operationId": "getApiTaobaoGetShopItemListV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "Shop identifier. Also known as Seller ID or User ID (they refer to the same value).", "required": true, "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "description": "Unique shop identifier on Taobao/Tmall (shop ID).", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `coefp`: Comprehensive sorting\n- `hotsell`: Hot selling / Sales volume\n- `oldstarts`: New arrivals / Old starts\n- `bid`: Price: Low to High\n- `_bid`: Price: High to Low", "required": false, "schema": { "type": "string", "default": "coefp", "description": "Sort types for product list (V5.0)", "enum": [ "coefp", "hotsell", "oldstarts", "bid", "_bid" ] } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001700", "x-api-version": "v2", "x-search-aliases": [ "Taobao shop product list v2", "Tmall shop catalog lookup", "Taobao products by user and shop ID", "淘宝店铺商品列表 V2", "天猫店铺目录查询", "淘宝按用户和店铺 ID 查商品" ], "x-highlights": [ { "type": "tip", "kind": "CONDITION", "content": "For some stores, the returned product list may be empty.", "concept": "shop_product_coverage", "aliases": [ "shop product coverage", "shop product list", "店铺商品覆盖", "店铺商品列表" ] } ], "x-endpoint-family": "taobao_get_shop_item_list" } }, "/api/taobao/get-shop-item-list/v4": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Shop Product List", "description": "Retrieves products from a Taobao or Tmall shop by seller ID with page-based pagination. Use it to browse or monitor a known seller's catalog across result pages.", "operationId": "getApiTaobaoGetShopItemListV4", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "sellerId", "in": "query", "description": "Taobao/Tmall seller user ID used to identify the shop.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001825", "x-api-version": "v4", "x-search-aliases": [ "Taobao shop product list v4", "Tmall seller catalog lookup", "Taobao products by seller ID v4", "淘宝店铺商品列表 V4", "天猫卖家目录查询", "淘宝按卖家 ID 查商品 V4" ], "x-highlights": [ { "type": "tip", "kind": "GUIDANCE", "content": "This endpoint supports all Taobao and Tmall shops." } ], "x-endpoint-family": "taobao_get_shop_item_list" } }, "/api/taobao/get-item-sale/v1": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Sales", "description": "Retrieves the 30-day sales count for a Taobao or Tmall product by item ID. Use it to compare recent product sales or support ecommerce monitoring and product research.", "operationId": "getApiTaobaoGetItemSaleV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Unique product identifier on Taobao/Tmall (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": "11001850", "x-api-version": "v1", "x-search-aliases": [ "Taobao 30-day product sales", "Tmall monthly sales API", "Taobao item sales count", "淘宝商品近30天销量", "天猫月销量接口", "淘宝商品销量查询" ], "x-highlights": [], "x-endpoint-family": "taobao_get_item_sale" } }, "/api/taobao/search-item-list/v1": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Search", "description": "Searches Taobao and Tmall products by keyword with page, sort, optional Tmall-only, and inclusive price-range filters. Use it to discover products and narrow ecommerce research.", "operationId": "getApiTaobaoSearchItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `_sale`: Sales\n- `_bid`: Price: High to Low\n- `bid`: Price: Low to High\n- `_coefp`: General", "required": false, "schema": { "type": "string", "default": "_sale", "description": "Taobao search item list sorting options", "enum": [ "_sale", "_bid", "bid", "_coefp" ] } }, { "name": "tmall", "in": "query", "description": "Whether to filter results to Tmall only.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "startPrice", "in": "query", "description": "Minimum price filter (inclusive).", "required": false, "schema": { "type": "string" } }, { "name": "endPrice", "in": "query", "description": "Maximum price filter (inclusive).", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001900", "x-api-version": "v1", "x-search-aliases": [ "Taobao product search API", "Tmall keyword item search", "Taobao product price filter", "淘宝商品搜索接口", "天猫关键词商品查询", "淘宝商品价格筛选" ], "x-highlights": [], "x-endpoint-family": "taobao_search_item_list" } }, "/api/taobao/search-item-list/v2": { "get": { "tags": [ "Taobao and Tmall" ], "summary": "Product Search", "description": "Searches Taobao and Tmall products by keyword with page-based pagination and returns results sorted by sales. Use it to discover popular products for ecommerce research, catalog analysis, or product selection.", "operationId": "getApiTaobaoSearchItemListV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination, starting from 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "11001910", "x-api-version": "v2", "x-search-aliases": [ "Taobao product search V2", "Tmall keyword product search", "Taobao sales-ranked product search", "淘宝商品搜索 V2", "天猫关键词商品查询", "淘宝按销量排序商品搜索" ], "x-recommended": true, "x-highlights": [], "x-endpoint-family": "taobao_search_item_list" } }, "/api/xiaohongshu/ask-dots": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Ask Dots AI", "description": "Queries Xiaohongshu (RedNote) Ask Dots AI with a keyword question. Use it to retrieve an AI answer for topic research and question exploration.", "operationId": "getApiXiaohongshuAskDots", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Question or keyword to submit to Ask Dots AI.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12000000", "x-search-aliases": [ "Xiaohongshu Ask Dots AI API", "RedNote Ask Dots AI", "Xiaohongshu AI question answering", "小红书问点点AI接口", "小红书点点AI问答", "小红书AI问答" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_ask_dots" } }, "/api/xiaohongshu/hot-search/v1": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Hot Search", "description": "Searches Xiaohongshu (RedNote) hot-content entries with optional keyword, content-category path, pagination, ranking metric, and time-range controls. Use it to support trend discovery, topic monitoring, and content planning.", "operationId": "getApiXiaohongshuHotSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "searchWord", "in": "query", "description": "Search keyword.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageNum", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "orderBy", "in": "query", "description": "Sort metric for the result set.\n\nAvailable Values:\n- `premium_imp_num`: Exposure\n- `premium_good_read_rate`: Read rate\n- `premium_read_num`: Read count\n- `premium_engage_num`: Engagement count\n- `premium_engage_rate`: Engagement rate\n- `premium_like_num`: Like count\n- `premium_fav_num`: Favorite count\n- `premium_cmt_num`: Comment count", "required": false, "schema": { "type": "string", "default": "premium_imp_num", "description": "Content square ranking metric", "enum": [ "premium_imp_num", "premium_good_read_rate", "premium_read_num", "premium_engage_num", "premium_engage_rate", "premium_like_num", "premium_fav_num", "premium_cmt_num" ] } }, { "name": "nd", "in": "query", "description": "Time range in days.\n\nAvailable Values:\n- `DAY_3`: Last 3 days\n- `DAY_7`: Last 7 days\n- `DAY_14`: Last 14 days\n- `DAY_30`: Last 30 days", "required": false, "schema": { "type": "string", "default": "DAY_7", "description": "Content square time range", "enum": [ "DAY_3", "DAY_7", "DAY_14", "DAY_30" ] } }, { "name": "noteContentCategory", "in": "query", "description": "Content category filter. Pass one complete Pugongying category path joined with # separators. You may pass a parent path or append one listed child with another #. Only one path is accepted.\n\nAvailable values:\n\nContent categories:\n- 内容类目#美妆: 整体妆容, 唇妆, 眼妆, 美甲, 底妆, 美妆合集, 香水, 美妆其他\n- 内容类目#护肤: 面部保养, 面部清洁, 护肤合集, 护肤其他\n- 内容类目#个人护理: 头发产品, 身体护理, 口腔护理, 护理其他\n- 内容类目#母婴: 母婴日常, 早教, 婴童用品, 婴童洗护, 婴童食品, 婴童时尚, 孕期穿搭, 孕产经验, 产后恢复, 育儿经验, 宝宝才艺, 宝宝写真, 母婴其他\n- 内容类目#时尚: 穿搭, 配饰, 发型, 箱包, 鞋靴, 时尚其他\n- 内容类目#美食: 美食教程, 美食探店, 美食展示, 美食测评, 吃播, 美食其他\n- 内容类目#家居家装: 装修, 家居用品, 花艺园艺, 家居装饰, 家具, 家电, 室内设计, 居家经验, 家居家装其他\n- 内容类目#影视综资讯: 动漫, 娱乐资讯, 影视, 民生资讯, 综艺, 影视综其他\n- 内容类目#运动健身: 减脂塑形, 滑雪, 滑板, 水上活动, 运动其他, 足球, 篮球, 跑步, 游泳\n- 内容类目#宠物: 猫, 狗, 动物其他\n- 内容类目#文化艺术: 社科, 文化, 艺术, 文化艺术其他\n- 内容类目#兴趣爱好: 绘画, 手工, 阅读, 文具手账, 舞蹈, 兴趣爱好其他, 玩具周边\n- 内容类目#生活记录: 接地气生活, 日常片段, 中外生活, 品质生活, 校园生活\n- 内容类目#教育: 大学教育, k12教育, 家庭教育, 学习日常, 留学教育, 教育其他, 语言教育\n- 内容类目#职场: 职场干货, 职场行业, 职业考试, 职场其他\n- 内容类目#情感: 情感知识, 情感日常, 情感其他\n- 内容类目#摄影: 人文风光摄影, 摄影技巧, 胶片摄影, 人像摄影, 摄影其他\n- 内容类目#游戏: 手机游戏, 主机游戏, 游戏其他, 线下游戏\n- 内容类目#科技数码: 移动数码, 玩机攻略, 数码科技其他\n- 内容类目#出行旅游: 城市出行, 户外, 旅行\n- 内容类目#音乐\n- 内容类目#搞笑\n- 内容类目#健康养生\n- 内容类目#汽车: 用车攻略, 汽车评测, 汽车其他\n- 内容类目#婚嫁: 婚礼造型, 婚礼记录, 婚礼经验, 婚礼用品\n- 内容类目#商业财经\n- 内容类目#素材\n- 内容类目#其他\n\nIndustry categories:\n- 所属行业#母婴: 母婴出行, 哺乳喂养工具, 婴童个护清洁, 母婴家居, 母婴奶粉, 母婴辅零食, 婴童服饰鞋靴, 玩具相关, 母婴纸品, 孕产妇相关, 母婴营养品, 婴童面部护肤, 母婴小家电\n- 所属行业#家用电器: 大家电, 厨卫电器, 生活电器, 家电套系\n- 所属行业#3C数码: 手机, 数码设备, 电脑, 办公设备, 操作系统\n- 所属行业#食品饮料: 休闲零食, 方便速食, 粮油调味, 预制菜, 饮料冲调, 乳制品, 水果/水产, 肉禽蛋品, 功能性食品, 酒类（新）\n- 所属行业#美妆个护: 彩妆, 美容护肤, 香水香薰, 身体洗护, 口腔护理, 头发护理, 美容仪器\n- 所属行业#汽车出行: 乘用车, 摩托车, 电动自行车, 自行车, 卡车, 汽车用品, 维修保养, 汽车服务\n- 所属行业#本地生活: 奶茶果汁(新), 咖啡(新), 甜品烘焙(新), 熟食卤味(新), 特色小吃/特产(新), 酒吧(新), 西式快餐(新), 中式快餐(新), 中式正餐(新), 西式正餐(新), 线下零售\n- 所属行业#日化家清: 家务工具, 家用清洁, 纸品, 护理用品\n- 所属行业#医疗健康: OTC, 保健食品, 保健用品, 非OTC药品, 健康机械, 视力保健, 家用医疗器械, 成人计生（械）\n- 所属行业#宠物（新）: 宠物服务, 宠物食品, 宠物用品, 养宠经验, 宠物药保\n- 所属行业#家居家装: 灯饰光源, 家居百货, 家居建材零售, 家具, 家装辅材, 家装主材, 五金电具, 装修设计与工程服务, 智能家居, 家居卖场, 家居展会, 家纺, 餐厨杯\n- 所属行业#出行旅游: 交通出行, 酒店住宿, 国内游(新), 出境游(新), 景点景区(新), 旅游攻略(新), 旅游主题(新)\n- 所属行业#教育培训: K12教育, 素质教育, 图书, 成人兴趣培训, 学历教育, 语言及留学, 早教, 职业教育\n- 所属行业#金融行业: 保险, 贷款, 银行, 证券\n- 所属行业#医疗医美: 口腔医疗, 眼科医疗, 皮肤美容, 植发养发, 体检机构(新), 月子妇产(新), 面部塑形, 医美身体塑形, 中医医疗\n- 所属行业#免税平台: 美妆个护, 奢侈品\n- 所属行业#服饰鞋包: 女装, 男装, 女鞋, 男鞋, 女士内衣, 男士内衣, 服饰配件, 童装/亲子装, 箱包, 旅行箱, 童鞋/亲子鞋\n- 所属行业#珠宝配饰: 腕表, 首饰, 眼镜, 配饰, 珠宝摆件, 金条、金币\n- 所属行业#运动户外: 运动鞋, 户外鞋, 运动服装, 户外服装, 运动户外装备, 运动服配, 健身器械, 运动现场\n- 所属行业#文玩娱乐: 玩具, 游戏, 文玩收藏, 文体, 文具\n- 所属行业#到店综合: 商务服务, 生活服务\n- 所属行业#奢侈品: 箱包, 服饰, 鞋履, 珠宝配饰, 腕表, 运动户外, 品质生活, 婴童, 内衣, 高端酒店, 书写工具\n- 所属行业#互联网: 平台电商, 网服, 游戏, 内容消费, 生活服务, 软件工具, 会员服务\n- 所属行业#影像婚美: 婚纱摄影, 写真摄影, 婚礼服务, 婚恋交友\n- 所属行业#房地产: 房产中介, 房产开发, 商业地产\n\nExamples:\n- 内容类目#美妆\n- 内容类目#美妆#整体妆容\n- 所属行业#母婴#母婴出行\n", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001000", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu hot content search", "RedNote trending note search", "Xiaohongshu trend search API", "小红书热门内容搜索", "小红书热点笔记查询", "小红书热搜接口" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_hot_search" } }, "/api/xiaohongshu/search-note/v2": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Note Search", "description": "Searches Xiaohongshu (RedNote) notes by keyword with pagination plus sort, note-type, and publish-time filters. Use it to support topic research, content discovery, and monitoring keyword-related posts.", "operationId": "getApiXiaohongshuSearchNoteV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "sort", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `general`: General\n- `popularity_descending`: Popularity Descending\n- `time_descending`: Time Descending\n- `comment_descending`: Comment Descending\n- `collect_descending`: Collect Descending", "required": false, "schema": { "type": "string", "default": "general", "description": "Xiaohongshu Search Note Sort", "enum": [ "general", "popularity_descending", "time_descending", "comment_descending", "collect_descending" ] } }, { "name": "noteType", "in": "query", "description": "Note type filter.\n\nAvailable Values:\n- `_0`: General\n- `_1`: Video\n- `_2`: Normal", "required": false, "schema": { "type": "string", "default": "_0", "description": "Xiaohongshu search note type", "enum": [ "_0", "_1", "_2" ] } }, { "name": "noteTime", "in": "query", "description": "Note publish time filter. Results may include notes published outside the selected time range.\n\nAvailable Values:\n- `ONE_DAY`: Within one day\n- `ONE_WEEK`: Within a week\n- `HALF_YEAR`: Within half a year", "required": false, "schema": { "type": "string", "description": "Xiaohongshu search note publish time filter", "enum": [ "ONE_DAY", "ONE_WEEK", "HALF_YEAR" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001100", "x-api-version": "v2", "x-search-aliases": [ "Xiaohongshu note search API", "RedNote keyword note search", "Xiaohongshu content search v2", "小红书笔记搜索接口", "小红书关键词搜笔记", "小红书内容搜索 V2" ], "x-highlights": [ { "type": "warning", "kind": "GUIDANCE", "content": "The `noteTime` filter is not precise. For example, requesting notes from the past day may still return notes published outside that time range. For more accurate publish-time filtering, use [V4](./note-search-v4)." } ], "x-endpoint-family": "xiaohongshu_search_note" } }, "/api/xiaohongshu/search-note/v4": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Note Search", "description": "Searches Xiaohongshu (RedNote) notes through the mobile-app search flow with pagination, sorting, note-type, and time filters. Use it to support iterative topic research and filtered content discovery.", "operationId": "getApiXiaohongshuSearchNoteV4", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "sortType", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `general`: General\n- `popularity_descending`: Popularity Descending\n- `time_descending`: Time Descending\n- `comment_descending`: Comment Descending\n- `collect_descending`: Collect Descending", "required": false, "schema": { "type": "string", "default": "general", "description": "Xiaohongshu Search Note Sort", "enum": [ "general", "popularity_descending", "time_descending", "comment_descending", "collect_descending" ] } }, { "name": "noteType", "in": "query", "description": "Note type filter.\n\nAvailable Values:\n- `ALL`: No Limit\n- `VIDEO_NOTE`: Video Note\n- `NORMAL_NOTE`: Normal Note", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Xiaohongshu note type filter", "enum": [ "ALL", "VIDEO_NOTE", "NORMAL_NOTE" ] } }, { "name": "timeFilter", "in": "query", "description": "Publish time filter.\n\nAvailable Values:\n- `ALL`: No Limit\n- `ONE_DAY`: Within one day\n- `ONE_WEEK`: Within one week\n- `HALF_YEAR`: Within half a year", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Xiaohongshu note publish time filter", "enum": [ "ALL", "ONE_DAY", "ONE_WEEK", "HALF_YEAR" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001120", "x-api-version": "v4", "x-search-aliases": [ "Xiaohongshu app note search API", "RedNote mobile note search", "Xiaohongshu note search v4", "小红书 App 笔记搜索", "小红书移动端内容搜索", "小红书笔记搜索 V4" ], "x-highlights": [ { "type": "tip", "kind": "GUIDANCE", "content": "This is a mobile app version endpoint. Search results are more accurate." } ], "x-endpoint-family": "xiaohongshu_search_note" } }, "/api/xiaohongshu/search-user/v2": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "User Search", "description": "Searches Xiaohongshu (RedNote) users by keyword with page-based pagination. Use it to support creator discovery, account research, and finding profiles related to a topic, name, or brand term.", "operationId": "getApiXiaohongshuSearchUserV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001200", "x-api-version": "v2", "x-search-aliases": [ "Xiaohongshu user search API", "RedNote creator search", "Xiaohongshu account keyword search", "小红书用户搜索接口", "小红书博主搜索", "小红书账号关键词查询" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_search_user" } }, "/api/xiaohongshu/get-user-note-list/v4": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "User Published Notes", "description": "Retrieves notes published by a Xiaohongshu (RedNote) user, accepting a user ID or supported profile URL and a cursor for pagination. Use it to support creator content browsing, account monitoring, and reviewing a user's note history.", "operationId": "getApiXiaohongshuGetUserNoteListV4", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "A Xiaohongshu user ID or a profile URL containing /user/profile/.", "required": true, "schema": { "type": "string" } }, { "name": "lastCursor", "in": "query", "description": "Pagination cursor from the previous page (the last note's cursor value).", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001310", "x-api-version": "v4", "x-search-aliases": [ "Xiaohongshu user published notes", "RedNote user note list", "Xiaohongshu creator notes", "小红书用户发布笔记", "小红书用户笔记列表", "小红书博主笔记" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_get_user_note_list" } }, "/api/xiaohongshu/get-note-detail/v1": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Note Details", "description": "Retrieves Xiaohongshu (RedNote) details for a note identified by a note ID or supported explore URL. Use it to perform direct note lookup and content review from stored identifiers or shared explore links.", "operationId": "getApiXiaohongshuGetNoteDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "noteId", "in": "query", "description": "A Xiaohongshu note ID or an explore URL containing /explore/.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001400", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu note details", "RedNote note lookup", "Xiaohongshu explore URL lookup", "小红书笔记详情", "小红书笔记查询", "小红书链接查笔记" ], "x-recommended": true, "x-highlights": [ { "type": "tip", "kind": "LIMITATION", "content": "This version does not support video downloads.", "concept": "video_download", "aliases": [ "video download", "download video", "视频下载", "下载视频" ] }, { "type": "info", "kind": "GUIDANCE", "content": "Use `v6` for video download workflows." } ], "x-endpoint-family": "xiaohongshu_get_note_detail" } }, "/api/xiaohongshu/get-note-detail/v6": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Note Details", "description": "Retrieves Xiaohongshu (RedNote) video-note details by note ID. Use it to look up and process a known video note.", "operationId": "getApiXiaohongshuGetNoteDetailV6", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "noteId", "in": "query", "description": "Unique note identifier on Xiaohongshu.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001445", "x-api-version": "v6", "x-search-aliases": [ "Xiaohongshu video note details", "RedNote video post details", "Xiaohongshu video note lookup", "小红书视频笔记详情", "小红书视频笔记查找", "小红书视频笔记查询" ], "x-highlights": [ { "type": "tip", "kind": "CONDITION", "content": "This endpoint supports video downloads for video notes only; image-and-text notes are not supported.", "concept": "video_download", "aliases": [ "video download", "download video", "视频下载", "下载视频" ] } ], "x-endpoint-family": "xiaohongshu_get_note_detail" } }, "/api/xiaohongshu/get-note-comment/v2": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Note Comments", "description": "Retrieves comments for a Xiaohongshu (RedNote) note with cursor pagination and normal, latest, or like-count sorting. Use it to support feedback review, discussion analysis, and comment moderation workflows.", "operationId": "getApiXiaohongshuGetNoteCommentV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "noteId", "in": "query", "description": "A Xiaohongshu note ID or an explore URL containing /explore/.", "required": true, "schema": { "type": "string" } }, { "name": "lastCursor", "in": "query", "description": "Pagination cursor from the previous page (use the cursor value returned by the last response).", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort strategy for the result set.\n\nAvailable Values:\n- `normal`: Normal\n- `latest`: Latest\n- `like_count`: Like Count", "required": false, "schema": { "type": "string", "default": "latest", "description": "Xiaohongshu Comment Sort V3", "enum": [ "normal", "latest", "like_count" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001500", "x-api-version": "v2", "x-search-aliases": [ "Xiaohongshu note comments", "RedNote comment list", "Xiaohongshu comments by note", "小红书笔记评论", "小红书评论列表", "小红书笔记评论分页" ], "x-highlights": [ { "type": "tip", "kind": "GUIDANCE", "content": "We recommend using the `latest` sort by default. If comments cannot be retrieved for some notes with `latest`, try again using `normal`." } ], "x-endpoint-family": "xiaohongshu_get_note_comment" } }, "/api/xiaohongshu/get-note-sub-comment/v2": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Comment Replies", "description": "Retrieves replies to a specific Xiaohongshu (RedNote) note comment with cursor pagination. Use it to inspect threaded discussions and continue through reply pages for feedback review or moderation.", "operationId": "getApiXiaohongshuGetNoteSubCommentV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "noteId", "in": "query", "description": "Unique note identifier on Xiaohongshu.", "required": true, "schema": { "type": "string" } }, { "name": "commentId", "in": "query", "description": "Unique comment identifier on Xiaohongshu.", "required": true, "schema": { "type": "string" } }, { "name": "lastCursor", "in": "query", "description": "Pagination cursor from the previous page (use the cursor value returned by the last response).", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001600", "x-api-version": "v2", "x-search-aliases": [ "Xiaohongshu comment replies", "RedNote reply list", "Xiaohongshu subcomments", "小红书评论回复", "小红书二级评论", "小红书子评论列表" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_get_note_sub_comment" } }, "/api/xiaohongshu/get-user/v3": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "User Profile", "description": "Retrieves a Xiaohongshu (RedNote) user profile from a user ID or supported profile URL. Use it to support creator discovery, account research, and reviewing a known profile before related content analysis.", "operationId": "getApiXiaohongshuGetUserV3", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "A Xiaohongshu user ID or a profile URL containing /user/profile/.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001700", "x-api-version": "v3", "x-search-aliases": [ "Xiaohongshu user profile API", "RedNote user lookup", "Xiaohongshu profile URL lookup", "小红书用户资料接口", "小红书用户信息查询", "小红书用户主页链接查询" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_get_user" } }, "/api/xiaohongshu/search-recommend/v1": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Keyword Suggestions", "description": "Returns Xiaohongshu (RedNote) search keyword suggestions for a submitted seed term. Use it to expand query sets, refine content-research searches, and plan SEO or programmatic SEO keyword coverage.", "operationId": "getApiXiaohongshuSearchRecommendV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001800", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu keyword suggestions API", "RedNote search recommendations", "Xiaohongshu related search terms", "小红书关键词建议接口", "小红书搜索联想词", "小红书相关搜索词" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_search_recommend" } }, "/api/xiaohongshu/get-topic-note-list/v1": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Topic Note List", "description": "Retrieves Xiaohongshu (RedNote) notes associated with a topic ID, with hot or latest sorting and cursor pagination. Use it to support topic content discovery, trend review, and continuing through topic result pages.", "operationId": "getApiXiaohongshuGetTopicNoteListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "topicId", "in": "query", "description": "Unique topic identifier on Xiaohongshu.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `time`: Latest\n- `hot`: Hot", "required": false, "schema": { "type": "string", "default": "hot", "description": "Xiaohongshu Topic Sort", "enum": [ "time", "hot" ] } }, { "name": "cursor", "in": "query", "description": "Pagination cursor from the previous page.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12001900", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu topic notes", "RedNote topic note list", "Xiaohongshu notes by topic", "小红书话题笔记", "小红书话题笔记列表", "小红书话题下的笔记" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_get_topic_note_list" } }, "/api/xiaohongshu/share-url-transfer/v1": { "get": { "tags": [ "Xiaohongshu (RedNote)" ], "summary": "Share Link Resolution", "description": "Resolve a supported Xiaohongshu (RedNote) short share link and return its public redirect URL. Use it to expand shared links before subsequent Xiaohongshu content lookup or processing.", "operationId": "getApiXiaohongshuShareUrlTransferV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "shareUrl", "in": "query", "description": "A Xiaohongshu (RedNote) short share URL beginning with http://xhslink.com/ or https://xhslink.com/.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12002000", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu short link resolution", "RedNote share link expansion", "Xiaohongshu redirect URL", "小红书短链解析", "小红书分享链接解析", "小红书跳转链接" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_share_url_transfer" } }, "/api/xiaohongshu-ec/search-products/v1": { "get": { "tags": [ "Xiaohongshu E-commerce (RedNote)" ], "summary": "Product Search", "description": "Searches Xiaohongshu E-commerce (RedNote) products by keyword with page and search-ID pagination; pages after the first require the search ID returned by the initial search. Use it to discover marketplace products and continue through multi-page results.", "operationId": "getApiXiaohongshuEcSearchProductsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number, starting from 1.", "required": false, "schema": { "type": "string" } }, { "name": "searchId", "in": "query", "description": "Search ID returned by the first-page response; required when page is greater than 1.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "12501000", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu ecommerce product search", "RedNote product search", "Xiaohongshu marketplace keyword search", "小红书电商商品搜索", "小红书商城关键词搜索", "小红书商品查询" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_ec_search_products" } }, "/api/xiaohongshu-pgy/api/solar/cooperator/blogger/v2/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Creator Search", "description": "Search Xiaohongshu Pugongying creators with keyword, audience, location, content, pricing, performance, cooperation, live, and similarity filters. Use it to build a campaign creator shortlist.", "operationId": "getApiXiaohongshuPgyApiSolarCooperatorBloggerV2V1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "searchType", "in": "query", "description": "Search criteria type.\n\nAvailable Values:\n- `NICKNAME`: Search by nickname\n- `NOTE`: Search by note content", "required": false, "schema": { "type": "string", "default": "NICKNAME", "description": "Search Type", "enum": [ "NICKNAME", "NOTE" ] } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "sort", "in": "query", "description": "Creator search sorting. Values: FANS sorts by follower count descending, DEFAULT uses Pugongying intelligent ranking.\n\nAvailable Values:\n- `DEFAULT`: Platform default intelligent ranking\n- `FANS`: Sort by follower count descending", "required": false, "schema": { "type": "string", "default": "FANS", "description": "Creator search sorting", "enum": [ "DEFAULT", "FANS" ] } }, { "name": "fansNumberLower", "in": "query", "description": "Minimum number of fans.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "fansNumberUpper", "in": "query", "description": "Maximum number of fans.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "fansAge", "in": "query", "description": "Target fans age group.\n\nAvailable Values:\n- `ALL`: All ages\n- `LT_18`: Under 18\n- `AGE_18_24`: 18 to 24\n- `AGE_25_34`: 25 to 34\n- `AGE_35_44`: 35 to 44\n- `GT_44`: Above 44", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Fans age distribution", "enum": [ "ALL", "LT_18", "AGE_18_24", "AGE_25_34", "AGE_35_44", "GT_44" ] } }, { "name": "fansGender", "in": "query", "description": "Target fans gender.\n\nAvailable Values:\n- `ALL`: All genders\n- `MALE_HIGH`: Mainly Male\n- `FE_MALE_HIGH`: Mainly Female", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Fans gender distribution", "enum": [ "ALL", "MALE_HIGH", "FE_MALE_HIGH" ] } }, { "name": "fansChildAgeInfo", "in": "query", "description": "Mother-and-baby audience stage filter. Pass Pugongying labels or numeric codes separated by English or Chinese commas.\n\nAvailable values:\n- 1: 备孕\n- 2: 0-6月\n- 3: 7-12月\n- 4: 1-3岁\n- 5: 4-6岁\n- 6: 7-12岁\n- 7: 孕早期\n- 8: 孕晚期\n", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "KOL's gender.\n\nAvailable Values:\n- `ALL`: All genders\n- `MALE`: Male\n- `FEMALE`: Female", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Gender type", "enum": [ "ALL", "MALE", "FEMALE" ] } }, { "name": "location", "in": "query", "description": "Creator profile location filter. Pass Pugongying location labels separated by English or Chinese commas. Country, China province or region, city-level paths, and district/county-level paths are supported. China province or region short labels are normalized to the full Pugongying value. Only paths present in the Pugongying location tree are accepted. Paths such as `河北 秦皇岛`, `山西 长治 潞州区`, or `中国 山西 长治 潞州区` are normalized to values like `中国 山西 长治 潞州区`.\n\nAvailable country/province base values:\n- 中国\n- 美国\n- 日本\n- 澳大利亚\n- 英国\n- 加拿大\n- 韩国\n- 法国\n- 德国\n- 新加坡\n- 其他\n- 中国 北京\n- 中国 天津\n- 中国 河北\n- 中国 山西\n- 中国 内蒙古\n- 中国 辽宁\n- 中国 吉林\n- 中国 黑龙江\n- 中国 上海\n- 中国 江苏\n- 中国 浙江\n- 中国 安徽\n- 中国 福建\n- 中国 江西\n- 中国 山东\n- 中国 河南\n- 中国 湖北\n- 中国 湖南\n- 中国 广东\n- 中国 广西\n- 中国 海南\n- 中国 重庆\n- 中国 四川\n- 中国 贵州\n- 中国 云南\n- 中国 西藏\n- 中国 陕西\n- 中国 甘肃\n- 中国 青海\n- 中国 宁夏\n- 中国 新疆\n- 中国 澳门\n- 中国 台湾\n- 中国 香港\n\nExample:\n- 广东,中国 上海,河北 秦皇岛,山西 长治 潞州区\n", "required": false, "schema": { "type": "string" } }, { "name": "contentTag", "in": "query", "description": "Content category filter. Pass first-level or second-level category labels from Pugongying, separated by commas.\n\nAvailable values:\n- 美妆: 整体妆容, 唇妆, 眼妆, 美甲, 底妆, 美妆合集, 香水, 美妆其他\n- 护肤: 面部保养, 面部清洁, 护肤合集, 护肤其他\n- 个人护理: 头发产品, 身体护理, 口腔护理, 护理其他\n- 母婴: 母婴日常, 早教, 婴童用品, 婴童洗护, 婴童食品, 婴童时尚, 孕期穿搭, 孕产经验, 产后恢复, 育儿经验, 宝宝才艺, 宝宝写真, 母婴其他\n- 时尚: 穿搭, 配饰, 发型, 箱包, 鞋靴, 时尚其他\n- 美食: 美食教程, 美食探店, 美食展示, 美食测评, 吃播, 美食其他\n- 家居家装: 装修, 家居用品, 家居装饰, 家具, 家电, 室内设计, 居家经验, 家居家装其他\n- 影视综资讯: 动漫, 电影, 电视, 娱乐资讯, 影视, 民生资讯, 综艺, 影视综其他\n- 运动健身: 健身减肥, 健身塑形, 滑雪, 滑板, 水上活动, 运动其他, 足球, 篮球, 跑步, 游泳\n- 宠物: 猫, 狗, 动物其他\n- 文化艺术: 社科, 文化, 艺术, 文化艺术其他\n- 兴趣爱好: 绘画, 手工, 阅读, 文具手账, 舞蹈, 益智玩具, 潮流玩具, 兴趣爱好其他\n- 生活记录: 接地气生活, 日常片段, 中外生活, 品质生活, 校园生活\n- 教育: 大学教育, k12教育, 家庭教育, 学习日常, 职场教育, 教育其他\n- 情感: 情感知识, 情感日常, 情感其他\n- 摄影: 人文风光摄影, 摄影技巧, 胶片摄影, 人像摄影, 摄影其他\n- 游戏: 手机游戏, 主机游戏, 游戏其他, 线下游戏\n- 科技数码: 数码, 玩机攻略, 数码科技其他\n- 出行: 城市出行, 户外, 旅行\n- 音乐\n- 搞笑\n- 健康养生\n- 汽车\n- 婚嫁: 婚礼造型, 婚礼记录, 婚礼经验, 婚礼用品\n- 商业财经\n- 素材\n- 其他\n", "required": false, "schema": { "type": "string" } }, { "name": "contentSceneLabel", "in": "query", "description": "Content scene label filter. Pass full Pugongying note category scene label paths separated by English or Chinese commas.\n\nAvailable values:\n- 汽车 理性决策 选车攻略 政策\n- 汽车 理性决策 选车攻略 购车顾虑\n- 汽车 理性决策 选车攻略 配置\n- 汽车 理性决策 选车攻略 能源类型优势对比\n- 汽车 理性决策 选车攻略 攻略\n- 汽车 理性决策 新车测评\n- 汽车 理性决策 探店试驾\n- 汽车 理性决策 车主心得\n- 汽车 用车场景 远行近游 近郊探索\n- 汽车 用车场景 远行近游 长途自驾\n- 汽车 用车场景 远行近游 硬核越野\n- 汽车 用车场景 提车/交付场景 场地布置与礼遇\n- 汽车 用车场景 提车/交付场景 仪式感记录\n- 汽车 用车场景 商务用车 移动头等舱\n- 汽车 用车场景 商务用车 商务接待\n- 汽车 用车场景 亲子家庭 家庭采购日\n- 汽车 用车场景 亲子家庭 接送孩子\n- 汽车 用车场景 亲子家庭 三代同堂\n- 汽车 用车场景 亲子家庭 周末溜娃\n- 汽车 用车场景 亲子家庭 车内学习室\n- 汽车 用车场景 亲子家庭 车内育婴室\n- 汽车 用车场景 朋友社交 后备箱经济\n- 汽车 用车场景 朋友社交 移动娱乐屋\n- 汽车 用车场景 礼赠场景 毕业礼物\n- 汽车 用车场景 礼赠场景 送给父母\n- 汽车 用车场景 礼赠场景 适合送男友\n- 汽车 用车场景 礼赠场景 适合送女友\n- 汽车 用车场景 户外兴趣 钓鱼/野营\n- 汽车 用车场景 户外兴趣 骑行\n- 汽车 用车场景 户外兴趣 徒步\n- 汽车 用车场景 户外兴趣 硬核竞速\n- 汽车 用车场景 宠物出行 大型宠物\n- 汽车 用车场景 宠物出行 短途出行\n- 汽车 用车场景 宠物出行 小型宠物\n- 汽车 用车场景 宠物出行 长途出行\n- 汽车 用车场景 城市通勤 车内小憩\n- 汽车 用车场景 城市通勤 健身储物\n- 汽车 用车场景 城市通勤 日常通勤\n- 汽车 用车场景 城市通勤 生活圈代步\n- 汽车 用车场景 城市通勤 移动美容舱\n- 汽车 个性化美化 个性改装\n- 汽车 个性化美化 储物收纳\n- 汽车 个性化美化 车内装饰\n- 汽车 个性化美化 车外装饰\n- 汽车 个性化美化 车衣保护\n- 汽车 个性化美化 汽车用品\n- 汽车 车型品类 轿车\n- 汽车 车型品类 SUV\n- 汽车 车型品类 MPV\n- 汽车 车型品类 跑车\n- 汽车 车型品类 微型车\n- 汽车 车型品类 微面\n- 汽车 车型品类 房车\n- 汽车 车型品类 越野车\n- 汽车 车型品类 旅行车\n- 汽车 圈层属性 改装圈层\n- 汽车 圈层属性 痛车圈层\n- 汽车 圈层属性 跑山圈层\n- 汽车 品牌倾向 自主\n- 汽车 品牌倾向 豪华\n- 汽车 品牌倾向 集团\n- 汽车 品牌倾向 新势力\n- 汽车 能源类型 纯电车\n- 汽车 能源类型 新能源\n- 汽车 能源类型 油车\n- 汽车 人生阶段 单身\n- 汽车 人生阶段 多娃&大家庭阶段\n- 汽车 人生阶段 银发退休阶段\n- 游戏 游戏品类 网页游戏\n- 游戏 游戏品类 电脑游戏\n- 游戏 游戏品类 手机游戏\n- 游戏 游戏类型 动作格斗游戏 永劫无间\n- 游戏 游戏类型 即时制二次元游戏 境界刀鸣\n- 游戏 游戏类型 即时制二次元游戏 黑色信标\n- 游戏 游戏类型 即时制二次元游戏 物华弥新\n- 游戏 游戏类型 即时制二次元游戏 无期迷途\n- 游戏 游戏类型 即时制二次元游戏 新月同行\n- 游戏 游戏类型 即时制二次元游戏 绝区零\n- 游戏 游戏类型 即时制角色扮演 诛仙2\n- 游戏 游戏类型 即时制角色扮演 诛仙\n- 游戏 游戏类型 即时制角色扮演 明日之后\n- 游戏 游戏类型 即时制角色扮演 超自然行动组\n- 游戏 游戏类型 即时制角色扮演 永恒之塔2\n- 游戏 游戏类型 回合制二次元游戏 未定事件簿\n- 游戏 游戏类型 回合制二次元游戏 雷索纳斯\n- 游戏 游戏类型 回合制二次元游戏 浮生忆玲珑\n- 游戏 游戏类型 回合制二次元游戏 重返未来1999\n- 游戏 游戏类型 回合制角色扮演 梦幻西游手游\n- 游戏 游戏类型 回合制角色扮演 龙魂旅人\n- 游戏 游戏类型 回合制角色扮演 最终幻想14\n- 游戏 游戏类型 塔防游戏 保卫向日葵\n- 游戏 游戏类型 塔防游戏 全境守卫\n- 游戏 游戏类型 塔防游戏 向僵尸开炮\n- 游戏 游戏类型 开放世界角色扮演 燕云十六声\n- 游戏 游戏类型 开放世界角色扮演 王者荣耀世界\n- 游戏 游戏类型 恋爱游戏 如鸢\n- 游戏 游戏类型 恋爱游戏 银与绯\n- 游戏 游戏类型 恋爱游戏 时空中的绘旅人\n- 游戏 游戏类型 恋爱游戏 光与夜之恋\n- 游戏 游戏类型 恋爱游戏 恋与深空\n- 游戏 游戏类型 恋爱游戏 恋与制作人\n- 游戏 游戏类型 战略游戏 率土之滨\n- 游戏 游戏类型 战略游戏 群星纪元\n- 游戏 游戏类型 战略游戏 阿瓦隆之王\n- 游戏 游戏类型 战略游戏 快来当领主\n- 游戏 游戏类型 战略游戏 冒险之星\n- 游戏 游戏类型 战略游戏 无尽的拉格朗日\n- 游戏 游戏类型 放置类二次元游戏 花花与幕间剧\n- 游戏 游戏类型 放置类角色扮演 发条总动员\n- 游戏 游戏类型 放置类角色扮演 遮天凡尘一叶\n- 游戏 游戏类型 模拟养成 美人传\n- 游戏 游戏类型 模拟养成 盲盒派对\n- 游戏 游戏类型 模拟养成 闪耀暖暖\n- 游戏 游戏类型 模拟养成 以闪亮之名\n- 游戏 游戏类型 模拟养成 无限暖暖\n- 游戏 游戏类型 模拟家园建造 江南百景图\n- 游戏 游戏类型 模拟家园建造 动物森友会\n- 游戏 游戏类型 模拟家园建造 星露谷物语\n- 游戏 游戏类型 模拟经营 暴吵萌厨\n- 游戏 游戏类型 模拟经营 肥鹅健身房\n- 游戏 游戏类型 模拟职业 杜拉拉升职记\n- 游戏 游戏类型 消除游戏 四季合合\n- 游戏 游戏类型 生存沙盒游戏 无尽冬日\n- 游戏 游戏类型 聚会游戏 蛋仔派对\n- 游戏 游戏类型 聚会游戏 代号砰砰\n- 游戏 游戏类型 解谜游戏 晴空之下\n- 游戏 游戏类型 抓宠类游戏 洛克王国手游\n- 游戏 游戏类型 射击游戏 三角洲行动\n- 游戏 游戏类型 射击游戏 codm（使命召唤）\n- 母婴 婴童洗护 安全防晒\n- 母婴 婴童洗护 浴后护理\n- 母婴 婴童洗护 敏感修护\n- 母婴 婴童洗护 屏障树立\n- 母婴 婴童洗护 泳后护理\n- 母婴 婴童洗护 口周干裂\n- 母婴 婴童洗护 分区清洁\n- 母婴 婴童洗护 头皮问题\n- 母婴 婴童洗护 驱虫驱蚊\n- 母婴 婴童洗护 洁面清洁\n- 母婴 婴童洗护 红屁股\n- 母婴 婴童洗护 湿疹皮炎\n- 母婴 婴童洗护 痱子热疹\n- 母婴 婴童洗护 抚触链接\n- 母婴 婴童洗护 趣味洗护\n- 母婴 母婴纸品 精算育儿\n- 母婴 母婴纸品 颜值派\n- 母婴 母婴纸品 汗宝宝\n- 母婴 母婴纸品 囤货党\n- 母婴 母婴纸品 敏感肌\n- 母婴 母婴纸品 肉腿娃\n- 母婴 母婴纸品 功课党\n- 母婴 母婴纸品 好动宝\n- 母婴 母婴纸品 安睡整夜\n- 母婴 母婴纸品 出行便携\n- 母婴 母婴纸品 贵妇体验\n- 母婴 母婴纸品 红屁屁\n- 母婴 母婴小家电 空间收纳\n- 母婴 母婴小家电 滋补养生\n- 母婴 母婴小家电 温度把控\n- 母婴 母婴小家电 夜奶操作\n- 母婴 母婴小家电 新手喂养\n- 母婴 母婴小家电 材质挑选\n- 母婴 母婴小家电 三代同育\n- 母婴 母婴小家电 户外喂养\n- 母婴 母婴小家电 通乳攻略\n- 母婴 母婴小家电 洁癖爸妈\n- 母婴 母婴小家电 精准喂养\n- 母婴 母婴小家电 职场妈妈\n- 母婴 婴童辅食 吞咽能力\n- 母婴 婴童辅食 多元辅食\n- 母婴 婴童辅食 零食分享\n- 母婴 婴童辅食 健康零食\n- 母婴 婴童辅食 放学加餐\n- 母婴 婴童辅食 出牙磨牙\n- 母婴 婴童辅食 居家囤货\n- 母婴 婴童辅食 节日礼包\n- 母婴 婴童辅食 零食训练\n- 母婴 婴童辅食 宝宝挑食\n- 母婴 婴童辅食 户外零食\n- 母婴 婴童辅食 低敏辅食\n- 母婴 婴童辅食 入园社交\n- 母婴 婴童辅食 居家辅食\n- 母婴 婴童辅食 入园准备\n- 母婴 婴童辅食 敏敏零食\n- 母婴 婴童辅食 抓握训练\n- 母婴 婴童辅食 外出口粮\n- 母婴 婴童辅食 营养均衡\n- 母婴 婴童辅食 自主进食\n- 母婴 婴童辅食 第一口辅食\n- 母婴 母婴营养品 开胃因子\n- 母婴 母婴营养品 视力保护\n- 母婴 母婴营养品 营养补充\n- 母婴 母婴营养品 防护因子\n- 母婴 母婴营养品 高钙因子\n- 母婴 母婴营养品 自护构建\n- 母婴 母婴营养品 发育表现\n- 母婴 母婴营养品 助眠安睡\n- 母婴 婴童奶粉 丝滑转奶\n- 母婴 婴童奶粉 益生组合\n- 母婴 婴童奶粉 眼脑体发育\n- 母婴 婴童奶粉 选奶功课\n- 母婴 婴童奶粉 防敏脱敏\n- 母婴 婴童奶粉 助力聪明脑\n- 母婴 婴童奶粉 乳铁自护\n- 母婴 婴童奶粉 黄金长高\n- 母婴 婴童奶粉 内修外护\n- 母婴 婴童奶粉 肚肚吸收\n- 母婴 婴童奶粉 断奶攻略\n- 母婴 婴童奶粉 混合喂养\n- 母婴 婴童奶粉 母源黄金HMO\n- 母婴 婴童奶粉 长肉多肉\n- 母婴 哺乳喂养工具 萌娃穿搭\n- 母婴 哺乳喂养工具 安全材质\n- 母婴 哺乳喂养工具 奶瓶喂养\n- 母婴 哺乳喂养工具 颜值发育\n- 母婴 哺乳喂养工具 哄娃安抚\n- 母婴 哺乳喂养工具 餐具选购\n- 母婴 哺乳喂养工具 学饮指南\n- 母婴 哺乳喂养工具 换季保温\n- 母婴 母婴孕产 职场孕妇\n- 母婴 母婴孕产 产后复工\n- 母婴 母婴孕产 顺产\n- 母婴 母婴孕产 孕期变化\n- 母婴 母婴孕产 孕期学习\n- 母婴 母婴孕产 剖腹产\n- 母婴 母婴家居 护脊深睡\n- 母婴 母婴家居 安全翻滚\n- 母婴 母婴家居 进食习惯\n- 母婴 母婴家居 早教启蒙\n- 母婴 母婴家居 学习角落\n- 母婴 母婴家居 自主入睡\n- 母婴 母婴家居 爬行探索\n- 母婴 母婴家居 防惊跳\n- 母婴 母婴出行&用品 长线旅途\n- 母婴 母婴出行&用品 户外探索\n- 母婴 母婴出行&用品 二胎/双胎\n- 母婴 母婴出行&用品 新贵消费\n- 母婴 母婴出行&用品 备产研究\n- 母婴 母婴出行&用品 短途旅行\n- 母婴 母婴出行&用品 高频出行\n- 母婴 母婴出行&用品 新生出行\n- 母婴 母婴出行&用品 务实精算\n- 母婴 母婴出行&用品 遛娃必备\n", "required": false, "schema": { "type": "string" } }, { "name": "personalTags", "in": "query", "description": "Blogger persona tag filter. Pass one or more Pugongying persona labels separated by English or Chinese commas.\n\nAvailable values:\n- 妈妈\n- 萌娃\n- 爸爸\n- 奶奶\n- 情侣\n- 夫妻\n- 家庭\n- 闺蜜\n- 兄弟\n- 备孕中\n- 孕期中\n- 12岁以上\n- 传统行业\n- 互联网\n- 教育科研\n- 金融法律\n- 企业创业\n- 时尚美妆\n- 食品饮料\n- 文化传媒\n- 医疗健康\n- 艺术设计\n- 影视娱乐\n- 运动健身\n- 专业服务\n- 工程师\n- 销售\n- HR\n- 教练\n- 运动员\n- 舞蹈老师\n- 生活背景\n- 备考经验\n- 兴趣爱好\n- 留学背景\n- 海外华人\n- 铲屎官\n- 孕妈\n- 独居人群\n- 外国人\n- 混血儿\n\nExample:\n- 妈妈,教练,运动员,舞蹈老师,留学背景\n", "required": false, "schema": { "type": "string" } }, { "name": "marketTarget", "in": "query", "description": "Marketing target filter. Pass one Pugongying marketing target value.\n\nAvailable values:\n- estimateAllCpm: Exposure - exposure performance - cost\n- mAccumImpNum: Exposure - exposure performance - scale\n- readCost: Exposure - read performance - cost\n- mValidRawReadFeedNum: Exposure - read performance - scale\n- estimateEngageCost: Seeding - engagement performance - cost\n- mEngagementNum90d: Seeding - engagement performance - scale\n- estimateCpuv: Conversion - outer-store visit performance - cost\n- mCpuvNum: Conversion - outer-store visit performance - scale\n", "required": false, "schema": { "type": "string" } }, { "name": "audienceGroup", "in": "query", "description": "Audience target filter. Pass Pugongying audience group IDs (`dmpGroupId`) separated by English or Chinese commas. These IDs are dynamic and account-specific, so there is no fixed global value list. Use the audience group name shown in Pugongying Audience Management to identify what each ID means.\n", "required": false, "schema": { "type": "string" } }, { "name": "top20CrowdsLabel", "in": "query", "description": "Top-20 audience filter. Pass top-level or child audience labels separated by commas; child labels are converted to Pugongying request values.", "required": false, "schema": { "type": "string" } }, { "name": "industrySpecificCrowdsMotorDom", "in": "query", "description": "Industry-specific portrait filter. Pass Pugongying portrait value IDs or label values separated by commas.", "required": false, "schema": { "type": "string" } }, { "name": "featureTags", "in": "query", "description": "Good-at content tag filter. Pass label values separated by commas.", "required": false, "schema": { "type": "string" } }, { "name": "contentThemeLabel", "in": "query", "description": "Content theme filter. Pass Pugongying value IDs or label values separated by commas; labels are converted to value IDs.", "required": false, "schema": { "type": "string" } }, { "name": "excludeLowActive", "in": "query", "description": "Whether to exclude low-activity bloggers.", "required": false, "schema": { "type": "boolean" } }, { "name": "fansNumUp", "in": "query", "description": "Whether to exclude bloggers whose fan count is dropping.", "required": false, "schema": { "type": "boolean" } }, { "name": "noteType", "in": "query", "description": "Note type filter. Values: ALL=all note types, PHOTO_TEXT=mainly photo-text notes, VIDEO=mainly video notes.\n\nAvailable Values:\n- `ALL`: All note types\n- `PHOTO_TEXT`: Mainly photo-text notes\n- `VIDEO`: Mainly video notes", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Creator search note type preference", "enum": [ "ALL", "PHOTO_TEXT", "VIDEO" ] } }, { "name": "industry", "in": "query", "description": "Pugongying industry preset for industry assistant style creator recommendations.\n\nAvailable Values:\n- `BEAUTY_PERSONAL_CARE_BEAUTY`: Beauty and personal care - beauty\n- `BEAUTY_PERSONAL_CARE_SKINCARE`: Beauty and personal care - skincare\n- `BEAUTY_PERSONAL_CARE_PERSONAL_CARE`: Beauty and personal care - personal care\n- `BEAUTY_PERSONAL_CARE_FRAGRANCE`: Beauty and personal care - fragrance\n- `FOOD_BEVERAGE_SNACKS`: Food and beverage - snacks\n- `FOOD_BEVERAGE_DRINKS`: Food and beverage - drinks\n- `FOOD_BEVERAGE_HEALTH_FOOD`: Food and beverage - health food\n- `FOOD_BEVERAGE_DAIRY`: Food and beverage - dairy\n- `FOOD_BEVERAGE_ALCOHOL`: Food and beverage - alcohol\n- `FOOD_BEVERAGE_GRAINS_OIL`: Food and beverage - grains and oil\n- `FOOD_BEVERAGE_CROSS_BORDER_FOOD`: Food and beverage - cross-border food\n- `FOOD_BEVERAGE_FRESH_FOOD`: Food and beverage - fresh food\n- `FOOD_BEVERAGE_MEAL_REPLACEMENT`: Food and beverage - meal replacement\n- `FOOD_BEVERAGE_TRADITIONAL_NOURISHMENT`: Food and beverage - traditional nourishment\n- `MOTHER_BABY_SUPPLIES`: Mother and baby - baby supplies\n- `MOTHER_BABY_FORMULA_FOOD`: Mother and baby - formula and baby food\n- `DIGITAL_APPLIANCES_HOME_APPLIANCES`: Digital and appliances - home appliances\n- `DIGITAL_APPLIANCES_DIGITAL_PRODUCTS`: Digital and appliances - digital products\n- `DAILY_GOODS_HOUSEHOLD_DAILY_USE`: Daily goods - household daily use\n- `DAILY_GOODS_PET_SUPPLIES_FOOD`: Daily goods - pet supplies and food\n- `DAILY_GOODS_OFFICE_SUPPLIES`: Daily goods - office supplies\n- `APPAREL_ACCESSORIES_CLOTHING_SHOES_HATS`: Apparel and accessories - clothing, shoes, and hats\n- `APPAREL_ACCESSORIES_JEWELRY`: Apparel and accessories - jewelry\n- `APPAREL_ACCESSORIES_BAGS_GLASSES`: Apparel and accessories - bags and glasses\n- `APPAREL_ACCESSORIES_SPORTS_OUTDOOR`: Apparel and accessories - sports and outdoor\n- `APPAREL_ACCESSORIES_WATCHES`: Apparel and accessories - watches\n- `APPAREL_ACCESSORIES_SECOND_HAND_LUXURY`: Apparel and accessories - second-hand luxury\n- `HOME_BUILDING_MATERIALS_HOME_DECOR`: Home and building materials - home decor\n- `HOME_BUILDING_MATERIALS_FURNITURE`: Home and building materials - furniture\n- `HOME_BUILDING_MATERIALS_MAIN_MATERIALS`: Home and building materials - main building materials\n- `AUTOMOTIVE`: Automotive\n- `INTERNET_ECOMMERCE`: Internet - e-commerce\n- `INTERNET_SOFTWARE_TOOLS`: Internet - software tools\n- `HEALTHCARE_MEDICAL_DEVICES`: Healthcare - medical devices\n- `HEALTHCARE_MEDICAL_BEAUTY`: Healthcare - medical beauty\n- `CULTURE_SPORTS_ENTERTAINMENT_SPORTS_GOODS`: Culture, sports, and entertainment - sports goods\n- `CULTURE_SPORTS_ENTERTAINMENT_STATIONERY_TOYS_GIFTS`: Culture, sports, and entertainment - stationery, toys, and gifts\n- `CULTURE_SPORTS_ENTERTAINMENT_OUTDOOR_PRODUCTS`: Culture, sports, and entertainment - outdoor products\n- `CULTURE_SPORTS_ENTERTAINMENT_ART_COLLECTIBLES`: Culture, sports, and entertainment - art collectibles\n- `LIFE_SERVICES_OFFLINE_RETAIL`: Life services - offline retail\n- `LIFE_SERVICES_BEAUTY_HAIR`: Life services - beauty and hair\n- `CATERING_RESTAURANTS`: Catering - restaurants\n- `CATERING_DRINKS_DESSERTS`: Catering - drinks and desserts\n- `BUSINESS_SERVICES`: Business services\n- `EDUCATION_TRAINING_LANGUAGE_STUDY_ABROAD`: Education and training - language and study abroad\n- `EDUCATION_TRAINING_VOCATIONAL_EDUCATION`: Education and training - vocational education\n- `EDUCATION_TRAINING_INTEREST_TRAINING`: Education and training - interest training\n- `EDUCATION_TRAINING_K12_EDUCATION`: Education and training - K-12 education\n- `EDUCATION_TRAINING_DEGREE_EDUCATION`: Education and training - degree education\n- `EDUCATION_TRAINING_CORPORATE_DEVELOPMENT`: Education and training - corporate and team development\n- `EDUCATION_TRAINING_OTHER`: Education and training - other\n- `GAMES`: Games\n- `TRAVEL_TOURISM`: Travel and tourism", "required": false, "schema": { "type": "string", "description": "Industry assistant creator recommendation industry", "enum": [ "BEAUTY_PERSONAL_CARE_BEAUTY", "BEAUTY_PERSONAL_CARE_SKINCARE", "BEAUTY_PERSONAL_CARE_PERSONAL_CARE", "BEAUTY_PERSONAL_CARE_FRAGRANCE", "FOOD_BEVERAGE_SNACKS", "FOOD_BEVERAGE_DRINKS", "FOOD_BEVERAGE_HEALTH_FOOD", "FOOD_BEVERAGE_DAIRY", "FOOD_BEVERAGE_ALCOHOL", "FOOD_BEVERAGE_GRAINS_OIL", "FOOD_BEVERAGE_CROSS_BORDER_FOOD", "FOOD_BEVERAGE_FRESH_FOOD", "FOOD_BEVERAGE_MEAL_REPLACEMENT", "FOOD_BEVERAGE_TRADITIONAL_NOURISHMENT", "MOTHER_BABY_SUPPLIES", "MOTHER_BABY_FORMULA_FOOD", "DIGITAL_APPLIANCES_HOME_APPLIANCES", "DIGITAL_APPLIANCES_DIGITAL_PRODUCTS", "DAILY_GOODS_HOUSEHOLD_DAILY_USE", "DAILY_GOODS_PET_SUPPLIES_FOOD", "DAILY_GOODS_OFFICE_SUPPLIES", "APPAREL_ACCESSORIES_CLOTHING_SHOES_HATS", "APPAREL_ACCESSORIES_JEWELRY", "APPAREL_ACCESSORIES_BAGS_GLASSES", "APPAREL_ACCESSORIES_SPORTS_OUTDOOR", "APPAREL_ACCESSORIES_WATCHES", "APPAREL_ACCESSORIES_SECOND_HAND_LUXURY", "HOME_BUILDING_MATERIALS_HOME_DECOR", "HOME_BUILDING_MATERIALS_FURNITURE", "HOME_BUILDING_MATERIALS_MAIN_MATERIALS", "AUTOMOTIVE", "INTERNET_ECOMMERCE", "INTERNET_SOFTWARE_TOOLS", "HEALTHCARE_MEDICAL_DEVICES", "HEALTHCARE_MEDICAL_BEAUTY", "CULTURE_SPORTS_ENTERTAINMENT_SPORTS_GOODS", "CULTURE_SPORTS_ENTERTAINMENT_STATIONERY_TOYS_GIFTS", "CULTURE_SPORTS_ENTERTAINMENT_OUTDOOR_PRODUCTS", "CULTURE_SPORTS_ENTERTAINMENT_ART_COLLECTIBLES", "LIFE_SERVICES_OFFLINE_RETAIL", "LIFE_SERVICES_BEAUTY_HAIR", "CATERING_RESTAURANTS", "CATERING_DRINKS_DESSERTS", "BUSINESS_SERVICES", "EDUCATION_TRAINING_LANGUAGE_STUDY_ABROAD", "EDUCATION_TRAINING_VOCATIONAL_EDUCATION", "EDUCATION_TRAINING_INTEREST_TRAINING", "EDUCATION_TRAINING_K12_EDUCATION", "EDUCATION_TRAINING_DEGREE_EDUCATION", "EDUCATION_TRAINING_CORPORATE_DEVELOPMENT", "EDUCATION_TRAINING_OTHER", "GAMES", "TRAVEL_TOURISM" ] } }, { "name": "accumCommonImpMedinNum30d", "in": "query", "description": "Daily note exposure median range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound.", "required": false, "schema": { "type": "string" } }, { "name": "readMidNor30", "in": "query", "description": "Daily note read median range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound.", "required": false, "schema": { "type": "string" } }, { "name": "interMidNor30", "in": "query", "description": "Daily note interaction median range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound.", "required": false, "schema": { "type": "string" } }, { "name": "thousandLikePercent30", "in": "query", "description": "Thousand-like note ratio range. Pass fractional ratios such as 0.4,null or percentage values such as 40,null.", "required": false, "schema": { "type": "string" } }, { "name": "notePrice", "in": "query", "description": "Photo-text cooperation quote range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound.", "required": false, "schema": { "type": "string" } }, { "name": "videoPrice", "in": "query", "description": "Video cooperation quote range. Pass two comma-separated numeric bounds; use -1 or null for an open upper bound.", "required": false, "schema": { "type": "string" } }, { "name": "inviteReply48hNumRatio", "in": "query", "description": "48-hour invite reply ratio range. Pass fractional ratios such as 0.9,0.95 or percentage values such as 90,95.", "required": false, "schema": { "type": "string" } }, { "name": "progressOrderCnt", "in": "query", "description": "Current cooperation order count range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "tradeType", "in": "query", "description": "Recent cooperation industry filter from Pugongying.", "required": false, "schema": { "type": "string" } }, { "name": "tradeReportBrandIds", "in": "query", "description": "Recent cooperation brand IDs, separated by English or Chinese commas.", "required": false, "schema": { "type": "string" } }, { "name": "excludeTradeReportBrandIds", "in": "query", "description": "Whether to exclude creators who cooperated with the selected recent cooperation brands.", "required": false, "schema": { "type": "boolean" } }, { "name": "accumCoopImpMedinNum30d", "in": "query", "description": "Cooperation note exposure median range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "readMidCoop30", "in": "query", "description": "Cooperation note read median range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "interMidCoop30", "in": "query", "description": "Cooperation note interaction median range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "mCpuvNum30d", "in": "query", "description": "Cooperation note outer-store median range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "estimatePictureCpm", "in": "query", "description": "Estimated photo-text CPM range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "estimateVideoCpm", "in": "query", "description": "Estimated video CPM range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "estimatePicReadPrice", "in": "query", "description": "Estimated photo-text read unit price range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "estimateVideoReadPrice", "in": "query", "description": "Estimated video read unit price range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "estimatePictureEngageCost", "in": "query", "description": "Estimated photo-text engagement unit price range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "estimateVideoEngageCost", "in": "query", "description": "Estimated video engagement unit price range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "estimateCpuv30d", "in": "query", "description": "Estimated outer-store visit unit price range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "kliveCnt30d", "in": "query", "description": "Live count in the last 30 days range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "avgLiveViewerNum", "in": "query", "description": "Average live viewer count range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "avgAgmv90d", "in": "query", "description": "Average live sales amount range. Pass two comma-separated numeric bounds.", "required": false, "schema": { "type": "string" } }, { "name": "similarUserId", "in": "query", "description": "Similar creator user ID. `similarUserId` and `similarWord` must be provided together.", "required": false, "schema": { "type": "string" } }, { "name": "similarWord", "in": "query", "description": "Similar creator keyword shown by Pugongying. `similarUserId` and `similarWord` must be provided together.", "required": false, "schema": { "type": "string" } }, { "name": "fansLocation", "in": "query", "description": "Follower audience location filter. Pass Pugongying follower-region labels separated by English or Chinese commas. Country, China province, and city-level paths are supported; district/county-level paths are not accepted. Only paths present in the Pugongying follower-region tree are accepted. Use city paths such as `福建 南平`, `福建-南平`, or `中国 福建 南平`; they are normalized to values like `中国 福建 南平`.\n\nExamples:\n- 福建 南平\n- 中国 福建 南平,广东\n", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13000010", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying creator search", "Pugongying influencer filter", "Xiaohongshu campaign creator discovery", "小红书蒲公英达人搜索", "蒲公英博主筛选", "小红书投放达人发现" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_cooperator_blogger_v2" } }, "/api/xiaohongshu-pgy/api/solar/cooperator/user/blogger/userId/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Creator Profile", "description": "Retrieve a Xiaohongshu Pugongying creator profile and cooperation quote information for a known user ID. Use it to review a creator before campaign outreach or pricing comparison.", "operationId": "getApiXiaohongshuPgyApiSolarCooperatorUserBloggerUserIdV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "Blogger's user ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13001000", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying creator profile", "Pugongying creator cooperation quotes", "Xiaohongshu creator pricing profile", "小红书蒲公英博主资料", "蒲公英博主合作报价", "小红书达人报价资料" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_cooperator_user_blogger_userid" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV3/dataSummary/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Data Summary", "description": "Retrieve the Xiaohongshu Pugongying data summary for a creator's daily or cooperation notes. Use it to compare aggregate creator performance between business modes.", "operationId": "getApiXiaohongshuPgyApiSolarKolDataV3DataSummaryV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } }, { "name": "business", "in": "query", "description": "Business type.\n\nAvailable Values:\n- `DAILY_NOTE`: Daily notes\n- `COOPERATE_NOTE`: Cooperative notes", "required": false, "schema": { "type": "string", "default": "DAILY_NOTE", "description": "Business Type", "enum": [ "DAILY_NOTE", "COOPERATE_NOTE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13001100", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying data summary", "Pugongying creator performance summary", "Xiaohongshu daily cooperation note metrics", "小红书蒲公英数据概览", "蒲公英达人表现汇总", "小红书日常合作笔记数据" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_datav3_datasummary" } }, "/api/xiaohongshu-pgy/api/solar/kol/data/userId/fans_overall_new_history/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Follower Growth History", "description": "Retrieve Xiaohongshu Pugongying follower history for a creator over the selected 30- or 90-day period. Use it to track total followers or new-follower growth over time.", "operationId": "getApiXiaohongshuPgyApiSolarKolDataUserIdFansOverallNewHistoryV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } }, { "name": "dateType", "in": "query", "description": "Time range for data.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "DAY_30", "description": "Date range type", "enum": [ "DAY_30", "DAY_90" ] } }, { "name": "increaseType", "in": "query", "description": "Type of growth data.\n\nAvailable Values:\n- `FANS_TOTAL`: Total fans\n- `FANS_INCREASE`: New fans increase", "required": false, "schema": { "type": "string", "default": "FANS_TOTAL", "description": "Increase type", "enum": [ "FANS_TOTAL", "FANS_INCREASE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13001200", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying follower history", "Pugongying follower growth trend", "Xiaohongshu creator fan trend", "小红书蒲公英粉丝趋势", "蒲公英粉丝增长历史", "小红书达人涨粉趋势" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_data_userid_fans_overall_new_history" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV3/fansSummary/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Follower Summary", "description": "Retrieve the Xiaohongshu Pugongying follower summary for a known creator. Use it to review the account's aggregate audience status before deeper demographic or trend analysis.", "operationId": "getApiXiaohongshuPgyApiSolarKolDataV3FansSummaryV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13001300", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying follower summary", "Pugongying audience summary", "Xiaohongshu creator fan overview", "小红书蒲公英粉丝概览", "蒲公英受众汇总", "小红书达人粉丝摘要" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_datav3_fanssummary" } }, "/api/xiaohongshu-pgy/api/solar/kol/get_similar_kol/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Similar Creators", "description": "Retrieve paginated Xiaohongshu Pugongying creators similar to a known creator. Use it to expand a campaign shortlist from an existing reference account.", "operationId": "getApiXiaohongshuPgyApiSolarKolGetSimilarKolV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } }, { "name": "pageNum", "in": "query", "description": "Page number for results.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13001400", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying similar creators", "Pugongying lookalike influencers", "Xiaohongshu comparable creator list", "小红书蒲公英相似达人", "蒲公英同类博主", "小红书可比达人列表" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_get_similar_kol" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/kolFeatureTags/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Creator Feature Tags", "description": "Retrieve Xiaohongshu Pugongying feature tags assigned to a known creator. Use it to understand the creator's recognized formats, styles, or content strengths.", "operationId": "getApiXiaohongshuPgyApiSolarKolDataV2KolFeatureTagsV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13001500", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying feature tags", "Pugongying creator strengths", "Xiaohongshu creator format tags", "小红书蒲公英特征标签", "蒲公英达人内容特长", "小红书博主形式标签" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_datav2_kolfeaturetags" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/kolContentTags/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Creator Content Tags", "description": "Retrieve Xiaohongshu Pugongying content category tags associated with a known creator. Use it to understand the subjects and categories represented in the creator's published content.", "operationId": "getApiXiaohongshuPgyApiSolarKolDataV2KolContentTagsV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13001600", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying content tags", "Pugongying creator categories", "Xiaohongshu creator content topics", "小红书蒲公英内容标签", "蒲公英达人内容分类", "小红书博主内容主题" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_datav2_kolcontenttags" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV3/notesRate/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Note Performance Metrics", "description": "Retrieve Xiaohongshu Pugongying aggregate note performance metrics for a creator with business, note-type, date-range, and advertisement filters. Use it to compare content performance across selected scopes.", "operationId": "getApiXiaohongshuPgyApiSolarKolDataV3NotesRateV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } }, { "name": "business", "in": "query", "description": "Business type.\n\nAvailable Values:\n- `DAILY_NOTE`: Daily notes\n- `COOPERATE_NOTE`: Cooperative notes", "required": false, "schema": { "type": "string", "default": "DAILY_NOTE", "description": "Business Type", "enum": [ "DAILY_NOTE", "COOPERATE_NOTE" ] } }, { "name": "noteType", "in": "query", "description": "Type of note.\n\nAvailable Values:\n- `PHOTO_TEXT_AND_VIDEO`: Photo and Video\n- `PHOTO_TEXT`: Photo and Text\n- `VIDEO`: Video only", "required": false, "schema": { "type": "string", "default": "PHOTO_TEXT_AND_VIDEO", "description": "Note type", "enum": [ "PHOTO_TEXT_AND_VIDEO", "PHOTO_TEXT", "VIDEO" ] } }, { "name": "dateType", "in": "query", "description": "Time range for data.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "DAY_30", "description": "Date range type", "enum": [ "DAY_30", "DAY_90" ] } }, { "name": "advertiseSwitch", "in": "query", "description": "Advertisement filter.\n\nAvailable Values:\n- `ALL`: All notes\n- `ORGANIC_ONLY`: Organic notes only", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Advertisement switch", "enum": [ "ALL", "ORGANIC_ONLY" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13001700", "x-api-version": "v1", "x-search-aliases": [ "Pugongying note performance metrics", "Xiaohongshu creator note rates", "Pugongying filtered content performance", "小红书蒲公英笔记表现", "蒲公英达人笔记指标", "蒲公英筛选内容表现" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_datav3_notesrate" } }, "/api/xiaohongshu-pgy/api/solar/kol/data/userId/fans_profile/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Follower Distribution", "description": "Retrieves Xiaohongshu Pugongying follower profile data for a known creator. Use it to review a creator's audience profile during campaign planning.", "operationId": "getApiXiaohongshuPgyApiSolarKolDataUserIdFansProfileV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13001900", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying follower demographics", "Pugongying audience profile", "Xiaohongshu creator audience profile", "小红书蒲公英粉丝画像", "蒲公英受众画像", "小红书达人受众画像" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_data_userid_fans_profile" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/costEffective/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Cost Effectiveness Analysis", "description": "Retrieve the Xiaohongshu Pugongying cost-effectiveness analysis for a known creator. Use it to assess cooperation efficiency when comparing creators for a campaign.", "operationId": "getApiXiaohongshuPgyApiSolarKolDataV2CostEffectiveV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13002000", "x-api-version": "v1", "x-search-aliases": [ "Pugongying creator cost effectiveness", "Xiaohongshu cooperation efficiency", "Pugongying campaign cost analysis", "小红书蒲公英达人性价比", "蒲公英合作效率分析", "小红书达人投放成本分析" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_datav2_costeffective" } }, "/api/xiaohongshu-pgy/api/solar/note/noteId/detail/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Note Details", "description": "Retrieves Xiaohongshu Pugongying details for a known note ID. Use it to review an individual note during creator or campaign research.", "operationId": "getApiXiaohongshuPgyApiSolarNoteNoteIdDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "noteId", "in": "query", "description": "Note's unique ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13002100", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying note details", "Pugongying note lookup", "Xiaohongshu campaign note details", "小红书蒲公英笔记详情", "蒲公英笔记查询", "小红书活动笔记详情" ], "x-highlights": [ { "type": "tip", "kind": "CAPABILITY", "content": "This endpoint can retrieve note view counts.", "concept": "note_view_count", "aliases": [ "note view count", "views", "笔记阅读量", "曝光量" ] }, { "type": "tip", "kind": "CONDITION", "content": "Engagement metrics may be unavailable for some notes.", "concept": "engagement_metrics", "aliases": [ "engagement metrics", "likes comments shares", "互动指标", "点赞评论收藏" ] } ], "x-endpoint-family": "xiaohongshu_pgy_api_solar_note_noteid_detail" } }, "/api/xiaohongshu-pgy/api/pgy/kol/data/core_data/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Creator Core Metrics", "description": "Retrieves Xiaohongshu Pugongying core data for a creator with business, note-type, date-range, and advertisement filters. Use it to compare creators within a selected analysis scope.", "operationId": "getApiXiaohongshuPgyApiPgyKolDataCoreDataV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } }, { "name": "business", "in": "query", "description": "Business type.\n\nAvailable Values:\n- `DAILY_NOTE`: Daily notes\n- `COOPERATE_NOTE`: Cooperative notes", "required": false, "schema": { "type": "string", "default": "DAILY_NOTE", "description": "Business Type", "enum": [ "DAILY_NOTE", "COOPERATE_NOTE" ] } }, { "name": "noteType", "in": "query", "description": "Type of note.\n\nAvailable Values:\n- `PHOTO_TEXT_AND_VIDEO`: Photo and Video\n- `PHOTO_TEXT`: Photo and Text\n- `VIDEO`: Video only", "required": false, "schema": { "type": "string", "default": "PHOTO_TEXT_AND_VIDEO", "description": "Note type", "enum": [ "PHOTO_TEXT_AND_VIDEO", "PHOTO_TEXT", "VIDEO" ] } }, { "name": "dateType", "in": "query", "description": "Time range for data.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "DAY_30", "description": "Date range type", "enum": [ "DAY_30", "DAY_90" ] } }, { "name": "advertiseSwitch", "in": "query", "description": "Advertisement filter.\n\nAvailable Values:\n- `ALL`: All notes\n- `ORGANIC_ONLY`: Organic notes only", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Advertisement switch", "enum": [ "ALL", "ORGANIC_ONLY" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13002300", "x-api-version": "v1", "x-search-aliases": [ "Pugongying creator core data", "Xiaohongshu creator core data", "Pugongying creator analysis", "蒲公英达人核心数据", "蒲公英达人分析", "小红书达人核心数据" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_pgy_kol_data_core_data" } }, "/api/xiaohongshu-pgy/api/pgy/content_square/search_note_v2/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Content Square Notes", "description": "Search Xiaohongshu Pugongying Content Square notes by keyword or browse all notes, with business-category, ranking, time-window, and page controls. Use it to discover high-performing campaign content.", "operationId": "getApiXiaohongshuPgyApiPgyContentSquareSearchNoteV2V1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "searchWord", "in": "query", "description": "Keyword for note search. Empty string searches all notes.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "pageNum", "in": "query", "description": "Page number for results.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "bizType", "in": "query", "description": "Business category.\n\nAvailable Values:\n- `XIAOHONGSHU_HOT`: Xiaohongshu hot\n- `PRODUCT_SEEDING`: Product seeding\n- `ECOMMERCE_PROMOTION`: E-commerce promotion\n- `PUGONGYING_COOPERATION`: Pugongying cooperation\n- `LEAD_COLLECTION`: Lead collection\n- `ECOMMERCE_HOT`: E-commerce hot\n- `SEEDING_DIRECT`: Seeding direct\n- `APP_PROMOTION`: App promotion", "required": false, "schema": { "type": "string", "default": "XIAOHONGSHU_HOT", "description": "Content square business category", "enum": [ "XIAOHONGSHU_HOT", "PRODUCT_SEEDING", "ECOMMERCE_PROMOTION", "PUGONGYING_COOPERATION", "LEAD_COLLECTION", "ECOMMERCE_HOT", "SEEDING_DIRECT", "APP_PROMOTION" ] } }, { "name": "orderBy", "in": "query", "description": "Ranking metric.\n\nAvailable Values:\n- `premium_imp_num`: Exposure\n- `premium_good_read_rate`: Read rate\n- `premium_read_num`: Read count\n- `premium_engage_num`: Engagement count\n- `premium_engage_rate`: Engagement rate\n- `premium_like_num`: Like count\n- `premium_fav_num`: Favorite count\n- `premium_cmt_num`: Comment count", "required": false, "schema": { "type": "string", "default": "premium_imp_num", "description": "Content square ranking metric", "enum": [ "premium_imp_num", "premium_good_read_rate", "premium_read_num", "premium_engage_num", "premium_engage_rate", "premium_like_num", "premium_fav_num", "premium_cmt_num" ] } }, { "name": "nd", "in": "query", "description": "Time range in days.\n\nAvailable Values:\n- `DAY_3`: Last 3 days\n- `DAY_7`: Last 7 days\n- `DAY_14`: Last 14 days\n- `DAY_30`: Last 30 days", "required": false, "schema": { "type": "string", "default": "DAY_7", "description": "Content square time range", "enum": [ "DAY_3", "DAY_7", "DAY_14", "DAY_30" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13002350", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying Content Square", "Pugongying note discovery", "Xiaohongshu campaign content search", "小红书蒲公英内容广场", "蒲公英笔记发现", "小红书投放内容搜索" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_pgy_content_square_search_note_v2" } }, "/api/xiaohongshu-pgy/api/solar/kol/dataV2/notesDetail/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Creator Note List", "description": "Retrieve a paginated Xiaohongshu Pugongying creator note list with advertisement, sort-order, note-type, and third-platform filters. Use it to browse selected content from a known creator.", "operationId": "getApiXiaohongshuPgyApiSolarKolDataV2NotesDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "KOL's user ID.", "required": true, "schema": { "type": "string" } }, { "name": "advertiseSwitch", "in": "query", "description": "Advertisement filter.\n\nAvailable Values:\n- `ALL`: All notes\n- `ORGANIC_ONLY`: Organic notes only", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Advertisement switch", "enum": [ "ALL", "ORGANIC_ONLY" ] } }, { "name": "orderType", "in": "query", "description": "Sorting order.\n\nAvailable Values:\n- `LATEST`: Latest\n- `MOST_READ`: Most read\n- `MOST_INTERACT`: Most interactions", "required": false, "schema": { "type": "string", "default": "LATEST", "description": "Sorting order type", "enum": [ "LATEST", "MOST_READ", "MOST_INTERACT" ] } }, { "name": "noteType", "in": "query", "description": "Type of note.\n\nAvailable Values:\n- `ALL`: All types\n- `COOPERATION`: Cooperation notes\n- `PHOTO_TEXT`: Photo and Text\n- `VIDEO`: Video only", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Note type V2", "enum": [ "ALL", "COOPERATION", "PHOTO_TEXT", "VIDEO" ] } }, { "name": "isThirdPlatform", "in": "query", "description": "Whether from third-party platform.\n\nAvailable Values:\n- `NO`: No\n- `YES`: Yes", "required": false, "schema": { "type": "string", "default": "NO", "description": "Third platform presence", "enum": [ "NO", "YES" ] } }, { "name": "pageNumber", "in": "query", "description": "Page number.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13002895", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying creator note list", "Pugongying filtered creator notes", "Xiaohongshu creator content list", "小红书蒲公英达人笔记列表", "蒲公英筛选博主笔记", "小红书达人内容列表" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_api_solar_kol_datav2_notesdetail" } }, "/api/xiaohongshu-pgy/get-kol-note-list/v1": { "get": { "tags": [ "Xiaohongshu Creator Marketplace (Pugongying)" ], "summary": "Creator Note List Pro", "description": "Retrieve a paginated Xiaohongshu Pugongying creator note list with advertisement, sort-order, and note-type controls. Use it to browse a creator's recent, most-read, or most-interacted notes.", "operationId": "getApiXiaohongshuPgyGetKolNoteListV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "kolId", "in": "query", "description": "KOL ID.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "adSwitch", "in": "query", "description": "Ad filter.\n\nAvailable Values:\n- `_1`: Full traffic (All notes)\n- `_0`: Natural traffic (Organic notes)", "required": true, "schema": { "type": "string", "description": "Note list advertisement filter", "enum": [ "_1", "_0" ] } }, { "name": "orderType", "in": "query", "description": "Sorting order.\n\nAvailable Values:\n- `_1`: Latest\n- `_2`: Most read\n- `_3`: Most interactions", "required": true, "schema": { "type": "string", "description": "Note list sorting order", "enum": [ "_1", "_2", "_3" ] } }, { "name": "noteType", "in": "query", "description": "Note type.\n\nAvailable Values:\n- `_1`: Photo and Text notes\n- `_2`: Video notes\n- `_3`: Cooperation notes\n- `_4`: All types", "required": false, "schema": { "type": "string", "default": "_4", "description": "Note list type filter", "enum": [ "_1", "_2", "_3", "_4" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "13002900", "x-api-version": "v1", "x-search-aliases": [ "Xiaohongshu Pugongying creator notes", "Pugongying KOL note list", "Xiaohongshu creator content history", "小红书蒲公英达人笔记", "蒲公英KOL笔记列表", "小红书达人内容列表" ], "x-highlights": [], "x-endpoint-family": "xiaohongshu_pgy_get_kol_note_list" } }, "/api/douyin/search-video/v4": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "Video Search", "description": "Searches Douyin (TikTok China) videos by keyword with sort, publish-time, duration, and page filters; later pages require the previous search ID. Use it to support content discovery and trend research.", "operationId": "getApiDouyinSearchVideoV4", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "The search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "sortType", "in": "query", "description": "Sorting criteria for search results.\n\nAvailable Values:\n- `_0`: General\n- `_1`: More likes\n- `_2`: Newest", "required": false, "schema": { "type": "string", "default": "_0", "description": "Douyin - Video Search Sort Type", "enum": [ "_0", "_1", "_2" ] } }, { "name": "publishTime", "in": "query", "description": "Filter by video publish time range.\n\nAvailable Values:\n- `_0`: No Limit\n- `_1`: Last 24 Hours\n- `_7`: Last 7 Days\n- `_180`: Last 6 Months", "required": false, "schema": { "type": "string", "default": "_0", "description": "Douyin - Video Search Publish Time Filter", "enum": [ "_0", "_1", "_7", "_180" ] } }, { "name": "duration", "in": "query", "description": "Filter by video duration.\n\nAvailable Values:\n- `_0`: No Limit\n- `_1`: Under 1 Minute\n- `_2`: 1-5 Minutes\n- `_3`: Over 5 Minutes", "required": false, "schema": { "type": "string", "default": "_0", "description": "Douyin - Video Search Duration Filter", "enum": [ "_0", "_1", "_2", "_3" ] } }, { "name": "page", "in": "query", "description": "Page number (starting from 1).", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "searchId", "in": "query", "description": "Search ID; required for pages > 1. Use data.business_config.next_page.search_id from the previous response, and stop paging when data.business_config.has_more is 0.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001000", "x-api-version": "v4", "x-search-aliases": [ "Douyin video search API", "Douyin keyword video search", "TikTok China content search", "抖音视频搜索接口", "抖音关键词搜视频", "抖音内容搜索 V4" ], "x-highlights": [], "x-endpoint-family": "douyin_search_video" } }, "/api/douyin/search-image/v1": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "Image Post Search", "description": "Searches Douyin (TikTok China) image posts by keyword with search-session pagination. Omit searchId for the first page, then use the search ID from the previous response to continue. Use it for visual-content discovery and topic research.", "operationId": "getApiDouyinSearchImageV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "The search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "searchId", "in": "query", "description": "Search ID returned by the previous response. Leave it empty for the first page.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001025", "x-api-version": "v1", "x-search-aliases": [ "Douyin image post search API", "Douyin photo post keyword search", "TikTok China image content search", "抖音图文搜索接口", "抖音关键词搜图文", "抖音图片内容搜索" ], "x-highlights": [], "x-endpoint-family": "douyin_search_image" } }, "/api/douyin/hot-search/v1": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "Hot Search", "description": "Searches Douyin (TikTok China) content with optional keyword, category, video-type, ranking, pagination, engagement, and creator-follower filters. Use it to support trend discovery and campaign research.", "operationId": "getApiDouyinHotSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Optional search keyword.", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Top-level content type. Only one content type can be selected.\n\nAvailable Values:\n- `ALL`: All content types.\n- `FASHION`: Fashion.\n- `TECHNOLOGY`: Technology.\n- `SCIENCE`: Science.\n- `PHOTOGRAPHY`: Photography and videography.\n- `FOOD`: Food.\n- `MOTHER_BABY`: Mother and baby.\n- `PARENTING`: Parenting.\n- `DRAMA`: Drama.\n- `GAME`: Game.\n- `AUTOMOTIVE`: Automotive.\n- `ANIMAL`: Animal.\n- `TRAVEL`: Travel.\n- `DANCE`: Dance.\n- `TRADITIONAL_CULTURE`: Traditional culture.\n- `ART`: Art.\n- `SPORTS`: Sports.\n- `MUSIC`: Music.\n- `LIFE_RECORD`: Life records.\n- `HOME_LIVING`: Home and living.\n- `LEISURE_ENTERTAINMENT`: Leisure entertainment.\n- `WORKPLACE`: Workplace.\n- `AGRICULTURE`: Agriculture.\n- `CASUAL`: Casual videos.\n- `ACG`: Animation, comics, and games.\n- `MOVIE`: Movie.\n- `TV_SERIES`: TV series.\n- `VARIETY_SHOW`: Variety show.\n- `CELEBRITY`: Celebrity.\n- `HUMANITIES_SOCIAL_SCIENCE`: Humanities and social science.\n- `EDUCATION_CAMPUS`: Education and campus.\n- `EMOTION`: Emotion.\n- `FINANCE`: Finance.\n- `PUBLIC_WELFARE`: Public welfare.", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Douyin Hot Search content type.", "enum": [ "ALL", "FASHION", "TECHNOLOGY", "SCIENCE", "PHOTOGRAPHY", "FOOD", "MOTHER_BABY", "PARENTING", "DRAMA", "GAME", "AUTOMOTIVE", "ANIMAL", "TRAVEL", "DANCE", "TRADITIONAL_CULTURE", "ART", "SPORTS", "MUSIC", "LIFE_RECORD", "HOME_LIVING", "LEISURE_ENTERTAINMENT", "WORKPLACE", "AGRICULTURE", "CASUAL", "ACG", "MOVIE", "TV_SERIES", "VARIETY_SHOW", "CELEBRITY", "HUMANITIES_SOCIAL_SCIENCE", "EDUCATION_CAMPUS", "EMOTION", "FINANCE", "PUBLIC_WELFARE" ] } }, { "name": "videoType", "in": "query", "description": "Video type filter.\n\nAvailable Values:\n- `ALL`: All video types.\n- `XINGTU_VIDEO`: Xingtu commercial videos.\n- `NATURAL_VIDEO`: Natural videos.", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Douyin Hot Search video type.", "enum": [ "ALL", "XINGTU_VIDEO", "NATURAL_VIDEO" ] } }, { "name": "sortType", "in": "query", "description": "Sorting criteria for hot content results.\n\nAvailable Values:\n- `COMPREHENSIVE`: Comprehensive ranking.\n- `HIGH_INTERACTION`: Highest interaction count.\n- `HIGH_LIKE`: Highest like count.\n- `HIGH_COMMENT`: Highest comment count.\n- `HIGH_SHARE`: Highest share count.", "required": false, "schema": { "type": "string", "default": "COMPREHENSIVE", "description": "Douyin Hot Search sort type.", "enum": [ "COMPREHENSIVE", "HIGH_INTERACTION", "HIGH_LIKE", "HIGH_COMMENT", "HIGH_SHARE" ] } }, { "name": "page", "in": "query", "description": "Page number (starting from 1). Page size is fixed at 10.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "likeCountMin", "in": "query", "description": "Minimum raw like count.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "likeCountMax", "in": "query", "description": "Maximum raw like count.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "commentCountMin", "in": "query", "description": "Minimum raw comment count.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "commentCountMax", "in": "query", "description": "Maximum raw comment count.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "shareCountMin", "in": "query", "description": "Minimum raw share count.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "shareCountMax", "in": "query", "description": "Maximum raw share count.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "interactionCountMin", "in": "query", "description": "Minimum raw interaction count.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "interactionCountMax", "in": "query", "description": "Maximum raw interaction count.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "followerCountMin", "in": "query", "description": "Minimum raw creator follower count.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "followerCountMax", "in": "query", "description": "Maximum raw creator follower count.", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001050", "x-api-version": "v1", "x-search-aliases": [ "Douyin hot content search", "Douyin trending video search", "Douyin content ranking filters", "抖音热门内容搜索", "抖音热搜接口", "抖音热点视频查询" ], "x-highlights": [], "x-endpoint-family": "douyin_hot_search" } }, "/api/douyin/search-user/v2": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "User Search", "description": "Searches Douyin (TikTok China) users by keyword with page-based pagination and optional account-type filtering. Use it to discover creators, brands, or verified accounts for research.", "operationId": "getApiDouyinSearchUserV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "The search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number (starting from 1).", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "userType", "in": "query", "description": "Filter by user type.\n\nAvailable Values:\n- `common_user`: Common User\n- `enterprise_user`: Enterprise User\n- `personal_user`: Verified Individual User", "required": false, "schema": { "type": "string", "description": "Douyin - User Search Type Filter", "enum": [ "common_user", "enterprise_user", "personal_user" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001100", "x-api-version": "v2", "x-search-aliases": [ "Douyin user search API", "Douyin creator search", "TikTok China account search", "抖音用户搜索接口", "抖音达人搜索", "抖音账号关键词查询" ], "x-highlights": [], "x-endpoint-family": "douyin_search_user" } }, "/api/douyin/get-user-video-list/v1": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "User Published Videos", "description": "Retrieves videos published by a Douyin (TikTok China) user, with cursor pagination and newest or most-popular sorting. Use it to browse or monitor a creator's public video output.", "operationId": "getApiDouyinGetUserVideoListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "secUid", "in": "query", "description": "The unique user ID (sec_user_id) on Douyin.", "required": true, "schema": { "type": "string" } }, { "name": "maxCursor", "in": "query", "description": "Pagination cursor; use 0 for the first page, and the `max_cursor` from the previous response for subsequent pages.", "required": false, "schema": { "type": "string", "default": "0" } }, { "name": "sortType", "in": "query", "description": "Sort order: `LATEST` for newest first (default), or `MOST_POPULAR` for most popular first.\n\nAvailable Values:\n- `LATEST`: Newest first (default)\n- `MOST_POPULAR`: Most popular first", "required": false, "schema": { "type": "string", "default": "LATEST", "description": "Douyin user video list sort type", "enum": [ "LATEST", "MOST_POPULAR" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001100", "x-api-version": "v1", "x-search-aliases": [ "Douyin user published videos", "Douyin creator video list", "Douyin videos by user", "抖音用户发布视频", "抖音用户作品列表", "抖音博主视频" ], "x-recommended": true, "x-highlights": [], "x-endpoint-family": "douyin_get_user_video_list" } }, "/api/douyin/get-user-video-list/v3": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "User Published Videos", "description": "Retrieves videos published by a Douyin (TikTok China) user with cursor pagination. Use it to browse a known creator's public video history or continue through video pages.", "operationId": "getApiDouyinGetUserVideoListV3", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "secUid", "in": "query", "description": "The unique user ID (sec_uid) on Douyin.", "required": true, "schema": { "type": "string" } }, { "name": "maxCursor", "in": "query", "description": "Pagination cursor; use 0 for the first page, and the `max_cursor` from the previous response for subsequent pages.", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001200", "x-api-version": "v3", "x-search-aliases": [ "Douyin user published videos v3", "Douyin creator video list", "Douyin videos by user", "抖音用户发布视频 V3", "抖音用户作品列表", "抖音博主视频" ], "x-highlights": [ { "type": "tip", "kind": "CONDITION", "content": "For some users, their latest videos may not be accessible.", "concept": "published_video_availability", "aliases": [ "published videos", "latest videos", "用户作品", "最新作品" ] } ], "x-endpoint-family": "douyin_get_user_video_list" } }, "/api/douyin/get-video-detail/v2": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "Video Details", "description": "Retrieves details for a Douyin (TikTok China) video by video ID. Use it to look up a known video before content review, archiving, or related analysis.", "operationId": "getApiDouyinGetVideoDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "videoId", "in": "query", "description": "The unique video identifier (aweme_id or model_id).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001300", "x-api-version": "v2", "x-search-aliases": [ "Douyin video details API", "Douyin aweme lookup", "TikTok China video information", "抖音视频详情接口", "抖音作品详情", "抖音视频 ID 查询" ], "x-highlights": [], "x-endpoint-family": "douyin_get_video_detail" } }, "/api/douyin/get-video-comment/v1": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "Video Comments", "description": "Retrieves top-level comments for a Douyin (TikTok China) video by aweme ID with page-based pagination. Use it to review audience feedback or analyze discussion around a known video.", "operationId": "getApiDouyinGetVideoCommentV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "awemeId", "in": "query", "description": "The unique video identifier (aweme_id).", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number (starting from 1).", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001400", "x-api-version": "v1", "x-search-aliases": [ "Douyin video comments API", "Douyin comment list", "TikTok China video feedback", "抖音视频评论接口", "抖音评论列表", "抖音作品评论" ], "x-highlights": [], "x-endpoint-family": "douyin_get_video_comment" } }, "/api/douyin/get-video-sub-comment/v1": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "Comment Replies", "description": "Retrieves replies to a top-level Douyin (TikTok China) video comment with page-based pagination. Use it to inspect threaded discussions and review feedback under a known comment.", "operationId": "getApiDouyinGetVideoSubCommentV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "commentId", "in": "query", "description": "The unique identifier of the top-level comment.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number (starting from 1).", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001500", "x-api-version": "v1", "x-search-aliases": [ "Douyin comment replies", "Douyin subcomment list", "TikTok China reply thread", "抖音评论回复", "抖音二级评论", "抖音子评论列表" ], "x-highlights": [], "x-endpoint-family": "douyin_get_video_sub_comment" } }, "/api/douyin/get-user-detail/v3": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "User Profile", "description": "Retrieves a Douyin (TikTok China) user profile by secUid. Use it to review a known creator or account before monitoring related content or conducting account research.", "operationId": "getApiDouyinGetUserDetailV3", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "secUid", "in": "query", "description": "The unique user ID (sec_uid) on Douyin.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001600", "x-api-version": "v3", "x-search-aliases": [ "Douyin user profile API", "Douyin creator profile lookup", "TikTok China account details", "抖音用户资料接口", "抖音用户信息查询", "抖音达人主页查询" ], "x-highlights": [], "x-endpoint-family": "douyin_get_user_detail" } }, "/api/douyin/share-url-transfer/v1": { "get": { "tags": [ "Douyin (TikTok China)" ], "summary": "Share Link Resolution", "description": "Resolve a supported Douyin (TikTok China) short share link that targets a video and return its public redirect URL. Use it to expand video links before subsequent Douyin content lookup or processing.", "operationId": "getApiDouyinShareUrlTransferV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "shareUrl", "in": "query", "description": "A Douyin short share URL beginning with https://v.douyin.com/.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14001700", "x-api-version": "v1", "x-search-aliases": [ "Douyin short link resolution", "Douyin video share link expansion", "Douyin redirect URL", "抖音短链解析", "抖音视频分享链接解析", "抖音跳转链接" ], "x-highlights": [], "x-endpoint-family": "douyin_share_url_transfer" } }, "/api/douyin-ec/get-item-detail/v2": { "get": { "tags": [ "Douyin E-commerce" ], "summary": "Item Details", "description": "Retrieves Douyin E-commerce product details by item ID. Use it to inspect a known marketplace item for catalog or product research.", "operationId": "getApiDouyinEcGetItemDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "The unique ID of the item on Douyin E-commerce.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14502025", "x-api-version": "v2", "x-search-aliases": [ "Douyin ecommerce product detail", "Douyin shop item detail", "Douyin product by item ID", "抖音电商商品详情", "抖音商城商品详情", "抖店商品 ID 查询" ], "x-highlights": [ { "type": "tip", "kind": "CAPABILITY", "content": "This endpoint includes product sales data.", "concept": "product_sales_data", "aliases": [ "product sales", "sales data", "商品销量", "销售数据" ] } ], "x-endpoint-family": "douyin_ec_get_item_detail" } }, "/api/douyin-ec/get-item-sku-info/v1": { "get": { "tags": [ "Douyin E-commerce" ], "summary": "Product SKU Info", "description": "Retrieves SKU information for a Douyin E-commerce product by item ID. Use it to inspect the purchasable variations of a known product during catalog review.", "operationId": "getApiDouyinEcGetItemSkuInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "The unique ID of the item on Douyin E-commerce.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14502035", "x-api-version": "v1", "x-search-aliases": [ "Douyin ecommerce SKU info", "Douyin product variants", "Douyin shop item SKU lookup", "抖音电商 SKU 信息", "抖店商品规格查询", "抖音商城商品变体" ], "x-highlights": [], "x-endpoint-family": "douyin_ec_get_item_sku_info" } }, "/api/douyin-ec/get-item-sku-info/v2": { "get": { "tags": [ "Douyin E-commerce" ], "summary": "Product SKU Info", "description": "Retrieves SKU information for a Douyin E-commerce product by item ID. Returns code 202 when the product is not supported.", "operationId": "getApiDouyinEcGetItemSkuInfoV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "The unique ID of the item on Douyin E-commerce.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14502040", "x-api-version": "v2", "x-search-aliases": [ "Douyin ecommerce SKU info", "Douyin product variants", "Douyin shop item SKU lookup", "抖音电商 SKU 信息", "抖店商品规格查询", "抖音商城商品变体" ], "x-highlights": [], "x-endpoint-family": "douyin_ec_get_item_sku_info" } }, "/api/douyin-ec/search-item-list/v1": { "get": { "tags": [ "Douyin E-commerce" ], "summary": "Product Search", "description": "Searches Douyin E-commerce products by keyword with page and search-ID pagination. Use it to discover marketplace products and continue a multi-page search.", "operationId": "getApiDouyinEcSearchItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "string" } }, { "name": "searchId", "in": "query", "description": "Search ID; use the search_id value returned by the last response for subsequent pages.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14502050", "x-api-version": "v1", "x-search-aliases": [ "Douyin ecommerce product search", "Douyin shop keyword search", "Douyin marketplace items", "抖音电商商品搜索", "抖店关键词商品查询", "抖音商城找商品" ], "x-highlights": [], "x-endpoint-family": "douyin_ec_search_item_list" } }, "/api/douyin-ec/get-item-comments/v1": { "get": { "tags": [ "Douyin E-commerce" ], "summary": "Item Comments", "description": "Retrieves paginated customer comments for a Douyin E-commerce product by item ID. Use it to review product feedback for a known marketplace item.", "operationId": "getApiDouyinEcGetItemCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "The unique ID of the item on Douyin E-commerce.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for paginated comments.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14502100", "x-api-version": "v1", "x-search-aliases": [ "Douyin ecommerce item comments", "Douyin product reviews", "Douyin shop customer feedback", "抖音电商商品评论", "抖店商品评价", "抖音商城买家反馈" ], "x-highlights": [], "x-endpoint-family": "douyin_ec_get_item_comments" } }, "/api/douyin-ec/get-shop-item-list/v1": { "get": { "tags": [ "Douyin E-commerce" ], "summary": "Shop Product List", "description": "Retrieves a paginated product list for a Douyin E-commerce shop by shop ID. Use it to browse a known seller's marketplace catalog page by page.", "operationId": "getApiDouyinEcGetShopItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "description": "The unique ID of the shop on Douyin E-commerce.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "14502150", "x-api-version": "v1", "x-search-aliases": [ "Douyin ecommerce shop products", "Douyin seller item list", "Douyin shop catalog", "抖音电商店铺商品", "抖店商品列表", "抖音商城店铺目录" ], "x-highlights": [], "x-endpoint-family": "douyin_ec_get_shop_item_list" } }, "/api/douyin-xingtu/gw/api/gsearch/search_for_author_square/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Search", "description": "Searches Douyin Creator Marketplace (Xingtu) creators by keyword and structured filters for audience, pricing, content, performance, and campaign fit. Use it to build and compare campaign shortlists.", "operationId": "getApiDouyinXingtuGwApiGsearchSearchForAuthorSquareV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "sort", "in": "query", "description": "Creator search sorting. Values: FANS sorts by follower count descending, DEFAULT uses Xingtu score ranking.\n\nAvailable Values:\n- `DEFAULT`: Platform default score ranking\n- `FANS`: Sort by follower count descending", "required": false, "schema": { "type": "string", "default": "FANS", "description": "Creator search sorting", "enum": [ "DEFAULT", "FANS" ] } }, { "name": "searchType", "in": "query", "description": "Search criteria type.\n\nAvailable Values:\n- `NICKNAME`: By Nickname\n- `CONTENT`: By Content", "required": false, "schema": { "type": "string", "default": "NICKNAME", "description": "Search criteria type", "enum": [ "NICKNAME", "CONTENT" ] } }, { "name": "marketingTarget", "in": "query", "description": "Marketing goal. Available values: BRAND_EXPOSURE/1/品牌曝光, CIRCLE_SEEDING/2/破圈种草, ACTION_CONVERSION/3/行动转化.\n\nAvailable Values:\n- `BRAND_EXPOSURE`: Brand exposure\n- `CIRCLE_SEEDING`: Out-of-circle seeding\n- `ACTION_CONVERSION`: Action conversion", "required": false, "schema": { "type": "string", "description": "Marketing goal", "enum": [ "BRAND_EXPOSURE", "CIRCLE_SEEDING", "ACTION_CONVERSION" ] } }, { "name": "industry", "in": "query", "description": "Recommended industry filter. Pass enum name, numeric industry ID, or Chinese industry label. Available values: - ALL/0/不限; - 1901: 3C及电器; - 1938: 购物; - 1903: 食品饮料; - 1904: 服装配饰; - 1905: 医药健康; - 1936: 医疗机构; - 1909: 家居建材; - 1907: 生活服务; - 1906: 商务服务; - 1921: 休闲娱乐; - 1937: 丽人; - 1908: 房地产; - 1910: 教育培训; - 1911: 出行旅游; - 1912: 社会公共; - 1913: 游戏; - 1914: 互联网电商服务; - 1915: 交通工具; - 1916: 汽车; - 1917: 农资园艺; - 1920: 机械设备; - 1939: 文化用品; - 1940: 运动户外; - 1922: 传媒资讯; - 1924: 通信; - 1925: 金融业; - 1927: 餐饮服务; - 1928: 工具类软件; - 1929: 招商加盟; - 1930: 美妆; - 1931: 母婴宠物; - 1933: 日化; - 1934: 实体书籍; - 1935: 社交通讯.\n\nAvailable Values:\n- `ALL`: All\n- `ELECTRONICS_AND_APPLIANCES`: Electronics and Appliances\n- `SHOPPING`: Shopping\n- `FOOD_AND_BEVERAGE`: Food and Beverage\n- `CLOTHING_AND_ACCESSORIES`: Clothing and Accessories\n- `HEALTHCARE_AND_MEDICAL`: Healthcare and Medical\n- `MEDICAL_INSTITUTIONS`: Medical Institutions\n- `HOME_AND_BUILDING_MATERIALS`: Home and Building Materials\n- `LOCAL_SERVICES`: Local Services\n- `BUSINESS_SERVICES`: Business Services\n- `CULTURE_SPORTS_ENTERTAINMENT`: Leisure and Entertainment\n- `BEAUTY_SERVICES`: Beauty Services\n- `REAL_ESTATE`: Real Estate\n- `EDUCATION_AND_TRAINING`: Education and Training\n- `TRAVEL_AND_TOURISM`: Travel and Tourism\n- `PUBLIC_SERVICES`: Public Services\n- `GAMES`: Games\n- `RETAIL`: Internet E-commerce Services\n- `TRANSPORTATION_EQUIPMENT`: Transportation Equipment\n- `AUTOMOTIVE`: Automotive\n- `AGRICULTURE_FORESTRY_FISHERY`: Agriculture Forestry Fishery\n- `CHEMICAL_AND_ENERGY`: Chemical and Energy\n- `ELECTRONICS_AND_ELECTRICAL`: Electronics and Electrical\n- `MACHINERY_EQUIPMENT`: Machinery Equipment\n- `MEDIA_AND_INFORMATION`: Media and Information\n- `LOGISTICS`: Logistics\n- `TELECOMMUNICATIONS`: Telecommunications\n- `FINANCIAL_SERVICES`: Financial Services\n- `CATERING_SERVICES`: Catering Services\n- `SOFTWARE_TOOLS`: Software Tools\n- `FRANCHISING_AND_INVESTMENT`: Franchising and Investment\n- `BEAUTY_AND_COSMETICS`: Beauty and Cosmetics\n- `MOTHER_BABY_AND_PET`: Mother Baby and Pet\n- `DAILY_CHEMICALS`: Daily Chemicals\n- `PHYSICAL_BOOKS`: Physical Books\n- `SOCIAL_AND_COMMUNICATION`: Social and Communication\n- `CULTURAL_SUPPLIES`: Cultural Supplies\n- `SPORTS_OUTDOOR`: Sports and Outdoors", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Industry category", "enum": [ "ALL", "ELECTRONICS_AND_APPLIANCES", "SHOPPING", "FOOD_AND_BEVERAGE", "CLOTHING_AND_ACCESSORIES", "HEALTHCARE_AND_MEDICAL", "MEDICAL_INSTITUTIONS", "HOME_AND_BUILDING_MATERIALS", "LOCAL_SERVICES", "BUSINESS_SERVICES", "CULTURE_SPORTS_ENTERTAINMENT", "BEAUTY_SERVICES", "REAL_ESTATE", "EDUCATION_AND_TRAINING", "TRAVEL_AND_TOURISM", "PUBLIC_SERVICES", "GAMES", "RETAIL", "TRANSPORTATION_EQUIPMENT", "AUTOMOTIVE", "AGRICULTURE_FORESTRY_FISHERY", "CHEMICAL_AND_ENERGY", "ELECTRONICS_AND_ELECTRICAL", "MACHINERY_EQUIPMENT", "MEDIA_AND_INFORMATION", "LOGISTICS", "TELECOMMUNICATIONS", "FINANCIAL_SERVICES", "CATERING_SERVICES", "SOFTWARE_TOOLS", "FRANCHISING_AND_INVESTMENT", "BEAUTY_AND_COSMETICS", "MOTHER_BABY_AND_PET", "DAILY_CHEMICALS", "PHYSICAL_BOOKS", "SOCIAL_AND_COMMUNICATION", "CULTURAL_SUPPLIES", "SPORTS_OUTDOOR" ] } }, { "name": "isSuperstar", "in": "query", "description": "Whether to filter celebrity creators.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "followerRange", "in": "query", "description": "Raw follower count range in min-max format. Example: 1000-2000 means 1,000 to 2,000 followers; 5000000-10000000 means 5 million to 10 million followers.", "required": false, "schema": { "type": "string" } }, { "name": "kolPriceType", "in": "query", "description": "KOL price type.\n\nAvailable Values:\n- `VIDEO_1_20S`: Video 1-20s\n- `VIDEO_21_60S`: Video 21-60s\n- `VIDEO_OVER_60S`: Video > 60s\n- `CUSTOM_SHORT_DRAMA_EPISODE`: Mini-drama episode\n- `NATURAL_PLAY_CPM`: CPM naturally\n- `SHORT_LIVE_SEEDING_VIDEO`: Short-live seeding video\n- `SHORT_LIVE_WARMUP_VIDEO`: Short-live warm-up video\n- `CELEBRITY_SHORT_LIVE_SEEDING`: Celebrity short-live seeding\n- `CELEBRITY_SHORT_LIVE_WARMUP`: Celebrity short-live warm-up\n- `CELEBRITY_VIDEO`: Celebrity video\n- `COLLECTION_VIDEO`: Collection video\n- `DOUYIN_SHORT_VIDEO_CO_CREATION_MAIN_CREATOR`: Douyin short video co-creation - main creator\n- `DOUYIN_SHORT_VIDEO_CO_CREATION_PARTICIPANT`: Douyin short video co-creation - participant", "required": false, "schema": { "type": "string", "description": "KOL price category", "enum": [ "VIDEO_1_20S", "VIDEO_21_60S", "VIDEO_OVER_60S", "CUSTOM_SHORT_DRAMA_EPISODE", "NATURAL_PLAY_CPM", "SHORT_LIVE_SEEDING_VIDEO", "SHORT_LIVE_WARMUP_VIDEO", "CELEBRITY_SHORT_LIVE_SEEDING", "CELEBRITY_SHORT_LIVE_WARMUP", "CELEBRITY_VIDEO", "COLLECTION_VIDEO", "DOUYIN_SHORT_VIDEO_CO_CREATION_MAIN_CREATOR", "DOUYIN_SHORT_VIDEO_CO_CREATION_PARTICIPANT" ] } }, { "name": "kolPriceRange", "in": "query", "description": "KOL price range (e.g., 10000-50000).", "required": false, "schema": { "type": "string" } }, { "name": "contentTag", "in": "query", "description": "Creator category filter. Pass Xingtu first-level or second-level category labels separated by commas. Available values: - 美妆: 美妆教程, 妆容展示, 护肤保养, 美妆测评种草; - 时尚: 穿搭, 街拍, 造型, 时尚媒体; - 萌宠: 日常宠物, 特别宠物, 宠物周边; - 测评: 美妆测评, 3C数码测评, 汽车测评, 美食产品测评, 母婴产品测评, 综合测评, 酒店测评; - 游戏: 游戏剧情, 游戏解说, 游戏资讯, 游戏其他, 游戏录屏, 游戏集锦; - 二次元: 二次元真人, 动画漫画, 配音声优, 宅物手办; - 旅行: 旅行记录, 旅行攻略, 旅行推荐, 户外生活; - 汽车: 汽车测评, 汽车知识, 汽车周边; - 生活: 生活记录, 生活小窍门, 好物推荐, 健康养生, 婚恋; - 音乐: 歌曲演唱, 乐器演奏, 音乐教学, 音乐其他, 音乐剪辑; - 舞蹈; - 美食: 美食教程, 美食探店, 美食产品测评, 乡村野食, 美食其他, 酒类; - 母婴亲子: 育儿科普, 萌娃日常, 亲子互动, 测评种草; - 运动健身: 健身, 极限运动, 体育资讯, 冰雪, 垂钓, 格斗, 球类项目, 综合体育; - 科技数码: 3C数码, 家居电器, 科技; - 教育培训: 考学培训, 语言教学, 个人管理, 职业教育; - 颜值达人: 美女, 帅哥; - 生活家居: 硬装, 软装, 生活技巧, 家居氛围; - 才艺技能: 创意才能, 手工, 摄影, 绘画, 其他才艺; - 影视娱乐: 影视解说, 影视混剪, 明星资讯, 综艺解说, 综艺混剪; - 艺术文化: 传统文化, 人文科普, 自然科学; - 财经投资: 传统金融, 互联网金融, 财经知识; - 三农; - 剧情搞笑: 剧情, 搞笑; - 情感; - 园艺; - 房产: 其他房产, 房产知识, 房产及投资, 楼盘评测, 楼市资讯, 租房; - 随拍; - 媒体号. Example: 美妆,穿搭,剧情搞笑", "required": false, "schema": { "type": "string" } }, { "name": "contentTheme", "in": "query", "description": "Content theme filter. Pass Xingtu second-level content theme labels separated by commas. Only labels listed after each colon are accepted; category headings before the colons are descriptive only and must not be passed. Available values include: - 妆容妆造: 淡妆教程, 变装造型, 韩系妆容, 甜美妆容, 清透妆容, 复古妆容, 男性妆容; - 穿搭指南: 日常穿搭, 简约气质穿搭, 国风穿搭, 运动穿搭, 通勤穿搭, 旅行穿搭, 职业穿搭, 约会穿搭; - 亲子育儿: 亲子活动, 亲子沟通, 学前训练, 新手爸妈指导, 儿童护理, 宝宝辅食, 奶粉测评, 孕产饮食; - 美食教程与测评: 地方美食, 家常菜谱, 美食探店, 零食测评, 酒水品鉴, 厨房用品, 海鲜烹饪, 减脂美食; - 精彩车生活: 汽车行业资讯, 用车知识, 车辆保养, 自驾旅行, 新能源汽车资讯, 汽车用品测评, SUV测评; - 手机/数码/家电分享: 科技科普, 电子产品测评, 家电推荐, 手机评测, 智能家居, AI应用, 数码开箱; - 剧情演绎: 搞笑剧情, 剧情反转, 情感演绎, 家庭幽默演绎, 职场趣闻, 古风剧情, 生存挑战; - 萌宠养护: 宠物狗故事, 动物萌态, 宠物养护, 猫咪萌态, 宠物健康, 宠物护理, 宠物救助; - 旅行攻略: 国内旅行, 海外旅行, 城市旅行攻略, 酒店体验, 露营体验, 亲子旅行, 网红景点种草; - 家居好物: 清洁技巧, 生活好物评测, 家居选购, 家居装修, 家居收纳, 家装避坑, 房间布置; - 运动户外: 户外运动, 健身塑形, 赛事回顾, 体重管理, 极限运动, 跑步健身, 户外露营. Example: 亲子活动,宝宝辅食", "required": false, "schema": { "type": "string" } }, { "name": "personaTag", "in": "query", "description": "Creator persona or background labels. Pass Xingtu labels or numeric tag IDs separated by commas. Available values: - 人群属性: Z世代, 新锐白领, 精致妈妈, 都市蓝领, 资深中产, 小镇青年, 小镇中老年, 都市银发; - 社会身份: 音乐人, 非遗传人, 画家; - 主要出镜人物: 海外华人, 外国友人, 情侣, 夫妻, 家庭, 朋友, 同事, 亲子, 个人; - 肤质肤色: 混油皮, 干皮, 油皮, 敏感肌, 痘痘肌, 黄皮, 白皮, 瑕疵皮; - 皮肤养护: 美白, 抗老, 祛皱, 抗炎, 修复, 控油, 眼部护理, 补水保湿, 祛斑, 祛痘祛闭口, 隔离防晒; - 母婴阶段: 孕期, 0-6月, 7-12月, 1-3岁, 3-6岁, 6-12岁, 12-15岁, 15-18岁; - 爱好: 摄影, 时尚穿搭, 美食制作, 科普, 星座, 绘画; - 职业: 法律从业者, 航空业从业者, 健身/舞蹈教练, 专业美食从业者, 室内设计师; - 学历: 大学生, 硕士生, 博士, 留学生; - 黄v认证: 美妆创作者, 体育创作者, 媒体人/主持人, 科技创作者, 运动员; - Other labels: 潮流运动, 球类, 非球类, 室内健身, 城市运动, 户外运动, 数码潮流玩家, 户外爱好者, 室内设计师, 品酒家/调酒师, 美食评论人, 母婴行业专家, 奶爸, 旧屋改造, 装修设计, 收纳, 新生儿妈妈, 孕妈, 时尚妈妈, 二三胎妈妈, 西餐, 火锅, 国风爱好者, 成分党. Example: 大学生,美妆创作者", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Creator gender. Available values: MALE/1/男性, FEMALE/2/女性.\n\nAvailable Values:\n- `MALE`: Male\n- `FEMALE`: Female", "required": false, "schema": { "type": "string", "description": "Creator gender", "enum": [ "MALE", "FEMALE" ] } }, { "name": "location", "in": "query", "description": "Creator location filter. Pass Chinese province or city names separated by commas. Available province values include: 北京市, 天津市, 河北省, 山西省, 内蒙古自治区, 辽宁省, 吉林省, 黑龙江省, 上海市, 江苏省, 浙江省, 安徽省, 福建省, 江西省, 山东省, 河南省, 湖北省, 湖南省, 广东省, 广西壮族自治区, 海南省, 重庆市, 四川省, 贵州省, 云南省, 西藏自治区, 陕西省, 甘肃省, 青海省, 宁夏回族自治区, 新疆维吾尔自治区, 台湾省, 香港特别行政区, 澳门特别行政区. Example: 广东省,深圳市", "required": false, "schema": { "type": "string" } }, { "name": "tonalityTag", "in": "query", "description": "Creator tonality labels. Pass Xingtu first-level or second-level tonality labels separated by commas. Available values: - 身份/爱好: 马术, 高尔夫, 橄榄球, 时尚爱好者, 企业高管, 汽车爱好者, 学者专家, 古玩收藏; - 精致达人: 设计师, 高阶潮玩, 职业模特, 造型顾问, 独立设计师, 美术/画廊/展览, 歌剧舞台剧, 流行, 潮流买手, 电影; - 潮流酷: 冲浪, 浮潜, 说唱, 滑雪, 普拉提, 网球. Example: 精致达人,设计师", "required": false, "schema": { "type": "string" } }, { "name": "connectedUserRange", "in": "query", "description": "Connected user count range. Pass raw user counts in min-max format. Example: 1000000-3000000", "required": false, "schema": { "type": "string" } }, { "name": "audienceImage", "in": "query", "description": "Audience profile filter from Xingtu Audience Image. Pass one or more shortcut values separated by commas. Only the values listed below are accepted. For gender thresholds, pass at most one GENDER_MALE_* value and at most one GENDER_FEMALE_* value. Available values: - Gender: GENDER_MALE_50, GENDER_MALE_60, GENDER_MALE_70, GENDER_MALE_80, GENDER_FEMALE_50, GENDER_FEMALE_60, GENDER_FEMALE_70, GENDER_FEMALE_80; - Age: AGE_18_23, AGE_24_30, AGE_31_40, AGE_41_50, AGE_GT_50; - Device: DEVICE_IPHONE, DEVICE_HUAWEI, DEVICE_XIAOMI, DEVICE_VIVO, DEVICE_OPPO; - City tier: CITY_TIER_1, CITY_TIER_2, CITY_TIER_3, CITY_TIER_4, CITY_TIER_5; - Average order amount: SPEND_0_50, SPEND_50_100, SPEND_100_200, SPEND_200_500, SPEND_GT_500; - Crowd profile: CROWD_REFINED_MOTHER(53 精致妈妈), CROWD_URBAN_SILVER(54 都市银发), CROWD_NEW_WHITE_COLLAR(55 新锐白领), CROWD_SENIOR_MIDDLE_CLASS(56 资深中产), CROWD_URBAN_BLUE_COLLAR(57 都市蓝领), CROWD_GEN_Z(58 Z世代), CROWD_TOWN_MIDDLE_AGED(59 小镇中老年), CROWD_TOWN_YOUTH(60 小镇青年). Numeric IDs and Chinese labels in parentheses are for reference only and are not accepted as input values. Example: GENDER_FEMALE_50,CROWD_REFINED_MOTHER", "required": false, "schema": { "type": "string" } }, { "name": "fansImage", "in": "query", "description": "Fan profile filter from Xingtu Fan Image. Pass one or more shortcut values separated by commas. Only the values listed below are accepted. For gender thresholds, pass at most one GENDER_MALE_* value and at most one GENDER_FEMALE_* value. Available values: - Gender: GENDER_MALE_50, GENDER_MALE_60, GENDER_MALE_70, GENDER_MALE_80, GENDER_FEMALE_50, GENDER_FEMALE_60, GENDER_FEMALE_70, GENDER_FEMALE_80; - Age: AGE_18_23, AGE_24_30, AGE_31_40, AGE_41_50, AGE_GT_50; - Device: DEVICE_IPHONE, DEVICE_HUAWEI, DEVICE_XIAOMI, DEVICE_VIVO, DEVICE_OPPO; - City tier: CITY_TIER_1, CITY_TIER_2, CITY_TIER_3, CITY_TIER_4, CITY_TIER_5; - Average order amount: SPEND_0_50, SPEND_50_100, SPEND_100_200, SPEND_200_500, SPEND_GT_500; - Crowd profile: CROWD_REFINED_MOTHER(53 精致妈妈), CROWD_URBAN_SILVER(54 都市银发), CROWD_NEW_WHITE_COLLAR(55 新锐白领), CROWD_SENIOR_MIDDLE_CLASS(56 资深中产), CROWD_URBAN_BLUE_COLLAR(57 都市蓝领), CROWD_GEN_Z(58 Z世代), CROWD_TOWN_MIDDLE_AGED(59 小镇中老年), CROWD_TOWN_YOUTH(60 小镇青年). Numeric IDs and Chinese labels in parentheses are for reference only and are not accepted as input values. Example: GENDER_FEMALE_50,CROWD_REFINED_MOTHER", "required": false, "schema": { "type": "string" } }, { "name": "expectedPlayRange", "in": "query", "description": "Expected play count range. Use raw counts in min-max format. Page presets include 10000000 or above, 5000000-10000000, 3000000-5000000, 1000000-3000000, 100000-1000000, and 0-100000. For open-ended presets, pass a high upper bound such as 10000000-1000000000. Example: 1000000-3000000.", "required": false, "schema": { "type": "string" } }, { "name": "expectedCpmRange", "in": "query", "description": "Expected CPM range in min-max format. Example values matching Xingtu packs: 0-10, 0-20, 0-30, 0-50, 0-100, 100-1000000.", "required": false, "schema": { "type": "string" } }, { "name": "expectedCpeRange", "in": "query", "description": "Expected CPE range in min-max format. Example values matching Xingtu packs: 0-1, 0-2, 0-3, 0-5, 0-10, 10-1000000.", "required": false, "schema": { "type": "string" } }, { "name": "interactionRateRange", "in": "query", "description": "Interaction rate range in decimal min-max format. Example values: 0.01-1 for 1% or above, 0.02-1 for 2% or above.", "required": false, "schema": { "type": "string" } }, { "name": "completionRateRange", "in": "query", "description": "Completion rate range in decimal min-max format. Example values: 0.1-1 for 10% or above, 0.2-1 for 20% or above.", "required": false, "schema": { "type": "string" } }, { "name": "viralRateRange", "in": "query", "description": "Viral content rate range in decimal min-max format. Page presets include 0-0.1, 0.1-0.25, 0.25-0.5, 0.5-0.99, and 0.99 or above. For open-ended presets, pass a high upper bound such as 0.99-1. Example: 0.1-0.25.", "required": false, "schema": { "type": "string" } }, { "name": "progressTaskRange", "in": "query", "description": "In-progress task count range. Place a colon between the day count and the min-max range; omit either bound for an open range. Example: 30:8-", "required": false, "schema": { "type": "string" } }, { "name": "isCuratedAuthor", "in": "query", "description": "Whether to include only Xingtu curated creators under Topic Recommendations.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "authorList", "in": "query", "description": "Activity-curated creator list under Xingtu Topic Recommendations. Select at most one value. Pass an enum name, numeric list ID, or Chinese label. Available values: SHORT_LIVE_ENTERTAINMENT_CREATORS/7540478044453486642/短直联动娱播达人; SHORT_DRAMA_ACTORS/7591708652957155378/短剧演员; WECHAT_QUICK_CONNECT_CREATORS/7644854622347100210/企微可快速建联达人; AI_STAR_PLAN_CREATORS/7658250094571814938/AI星企划达人; COMMERCE_ADVANTAGE_CREATORS/7648906835038568499/带货优势达人; HIGH_VALUE_CREATORS/7656639212045516826/高性价比达人; SEEDING_ADVANTAGE_CREATORS/7663404694186033202/种草优势达人; BASKETBALL_CREATORS/7501674900550238234/运动圈层达人-篮球; PREMIUM_CONTENT_MEDIA/7586629331582222374/精品内容型媒体推荐; TREND_SETTING_MEDIA/7586616213569781769/趋势造风型媒体推荐; FACTORY_TRACEABILITY_MEDIA/7586616269403832370/探厂溯源型媒体推荐; RUNNING_CREATORS/7501675026170281994/运动圈层达人-跑步; LIGHT_OUTDOOR_CREATORS/7501674458878181413/运动圈层达人-轻户外; FITNESS_CREATORS/7501674307430236197/运动圈层达人-运动健身; YOGA_CREATORS/7501678481074929674/运动圈层达人-瑜伽; STREET_SPORTS_CREATORS/7501677564604383259/运动圈层达人-街头运动; CYCLING_CREATORS/7501677556094042149/运动圈层达人-骑行; FOOTBALL_CREATORS/7501674900550483994/运动圈层达人-足球; FISHING_CREATORS/7501676465915215881/运动圈层达人-垂钓; BEAUTY_QUALITY_CREATORS/7460387606572875826/美妆质感达人.\n\nAvailable Values:\n- `SHORT_LIVE_ENTERTAINMENT_CREATORS`: Short-video and livestream entertainment creators\n- `SHORT_DRAMA_ACTORS`: Short-drama actors\n- `WECHAT_QUICK_CONNECT_CREATORS`: Creators available for fast WeChat Work contact\n- `AI_STAR_PLAN_CREATORS`: AI Star Plan creators\n- `COMMERCE_ADVANTAGE_CREATORS`: Creators with commerce conversion advantages\n- `HIGH_VALUE_CREATORS`: High-value creators\n- `SEEDING_ADVANTAGE_CREATORS`: Creators with product-seeding advantages\n- `BASKETBALL_CREATORS`: Basketball creators\n- `PREMIUM_CONTENT_MEDIA`: Premium-content media recommendations\n- `TREND_SETTING_MEDIA`: Trend-setting media recommendations\n- `FACTORY_TRACEABILITY_MEDIA`: Factory and product-origin media recommendations\n- `RUNNING_CREATORS`: Running creators\n- `LIGHT_OUTDOOR_CREATORS`: Light-outdoor creators\n- `FITNESS_CREATORS`: Exercise and fitness creators\n- `YOGA_CREATORS`: Yoga creators\n- `STREET_SPORTS_CREATORS`: Street-sports creators\n- `CYCLING_CREATORS`: Cycling creators\n- `FOOTBALL_CREATORS`: Football creators\n- `FISHING_CREATORS`: Fishing creators\n- `BEAUTY_QUALITY_CREATORS`: Beauty creators with premium visual quality", "required": false, "schema": { "type": "string", "description": "Xingtu activity-curated creator list", "enum": [ "SHORT_LIVE_ENTERTAINMENT_CREATORS", "SHORT_DRAMA_ACTORS", "WECHAT_QUICK_CONNECT_CREATORS", "AI_STAR_PLAN_CREATORS", "COMMERCE_ADVANTAGE_CREATORS", "HIGH_VALUE_CREATORS", "SEEDING_ADVANTAGE_CREATORS", "BASKETBALL_CREATORS", "PREMIUM_CONTENT_MEDIA", "TREND_SETTING_MEDIA", "FACTORY_TRACEABILITY_MEDIA", "RUNNING_CREATORS", "LIGHT_OUTDOOR_CREATORS", "FITNESS_CREATORS", "YOGA_CREATORS", "STREET_SPORTS_CREATORS", "CYCLING_CREATORS", "FOOTBALL_CREATORS", "FISHING_CREATORS", "BEAUTY_QUALITY_CREATORS" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15000010", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator search", "Xingtu influencer discovery filters", "Douyin creator campaign shortlist", "抖音星图达人搜索", "星图达人筛选", "抖音达人投放名单" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_gsearch_search_for_author_square" } }, "/api/douyin-xingtu/gw/api/author/get_author_base_info/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Profile", "description": "Returns the Douyin Creator Marketplace (Xingtu) profile for a specified creator and content channel. Use it to review creator information before shortlisting or campaign outreach.", "operationId": "getApiDouyinXingtuGwApiAuthorGetAuthorBaseInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001000", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator profile", "Xingtu influencer base info", "Douyin creator marketplace profile", "抖音星图达人资料", "星图达人基础信息", "抖音达人市场档案" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_author_get_author_base_info" } }, "/api/douyin-xingtu/gw/api/data_sp/author_link_struct/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Link Structure", "description": "Returns Douyin Creator Marketplace (Xingtu) creator-link structure data for a specified creator and content channel. Use it to compare creator link structures during performance research.", "operationId": "getApiDouyinXingtuGwApiDataSpAuthorLinkStructV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001100", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator link structure", "Xingtu influencer link structure", "Douyin creator relationship structure", "抖音星图达人链路结构", "星图达人关系链路", "抖音达人链路分析" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_author_link_struct" } }, "/api/douyin-xingtu/gw/api/data_sp/check_author_display/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Visibility Status", "description": "Returns whether a specified creator can be displayed in Douyin Creator Marketplace (Xingtu) for the selected content channel. Use it to check creator availability before building a campaign shortlist.", "operationId": "getApiDouyinXingtuGwApiDataSpCheckAuthorDisplayV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001200", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator visibility check", "Xingtu creator display status", "Douyin influencer marketplace availability", "抖音星图达人展示状态", "星图达人可见性检查", "抖音达人市场可用状态" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_check_author_display" } }, "/api/douyin-xingtu/gw/api/author/get_author_platform_channel_info_v2/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Channel Metrics", "description": "Returns Douyin Creator Marketplace (Xingtu) channel information for a specified creator and content format. Use it to compare a creator's short-video, live, image-text, or short-drama presence.", "operationId": "getApiDouyinXingtuGwApiAuthorGetAuthorPlatformChannelInfoV2V1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001300", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator channel info", "Xingtu creator content channels", "Douyin influencer platform channel metrics", "抖音星图达人渠道信息", "星图达人内容渠道", "抖音达人平台渠道数据" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_author_get_author_platform_channel_info_v2" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_order_experience/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Order Experience", "description": "Returns Douyin Creator Marketplace (Xingtu) creator order-experience information for the last 30 or 90 days. Use it to review marketplace order history during creator evaluation.", "operationId": "getApiDouyinXingtuGwApiAggregatorGetAuthorOrderExperienceV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Time period.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "DAY_30", "description": "Time period", "enum": [ "DAY_30", "DAY_90" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001400", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator order experience", "Xingtu creator order history", "Douyin creator marketplace cooperation record", "抖音星图达人接单经验", "星图达人订单经历", "抖音达人合作记录" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_aggregator_get_author_order_experience" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_link_info/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Link Metrics", "description": "Returns Douyin Creator Marketplace (Xingtu) creator-link metrics for a specified creator, content channel, and industry category. Use it to review creator link information in an industry context.", "operationId": "getApiDouyinXingtuGwApiDataSpGetAuthorLinkInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } }, { "name": "industryTag", "in": "query", "description": "Industry tag.\n\nAvailable Values:\n- `ALL`: All\n- `ELECTRONICS_AND_APPLIANCES`: Electronics and Appliances\n- `SHOPPING`: Shopping\n- `FOOD_AND_BEVERAGE`: Food and Beverage\n- `CLOTHING_AND_ACCESSORIES`: Clothing and Accessories\n- `HEALTHCARE_AND_MEDICAL`: Healthcare and Medical\n- `MEDICAL_INSTITUTIONS`: Medical Institutions\n- `HOME_AND_BUILDING_MATERIALS`: Home and Building Materials\n- `LOCAL_SERVICES`: Local Services\n- `BUSINESS_SERVICES`: Business Services\n- `CULTURE_SPORTS_ENTERTAINMENT`: Leisure and Entertainment\n- `BEAUTY_SERVICES`: Beauty Services\n- `REAL_ESTATE`: Real Estate\n- `EDUCATION_AND_TRAINING`: Education and Training\n- `TRAVEL_AND_TOURISM`: Travel and Tourism\n- `PUBLIC_SERVICES`: Public Services\n- `GAMES`: Games\n- `RETAIL`: Internet E-commerce Services\n- `TRANSPORTATION_EQUIPMENT`: Transportation Equipment\n- `AUTOMOTIVE`: Automotive\n- `AGRICULTURE_FORESTRY_FISHERY`: Agriculture Forestry Fishery\n- `CHEMICAL_AND_ENERGY`: Chemical and Energy\n- `ELECTRONICS_AND_ELECTRICAL`: Electronics and Electrical\n- `MACHINERY_EQUIPMENT`: Machinery Equipment\n- `MEDIA_AND_INFORMATION`: Media and Information\n- `LOGISTICS`: Logistics\n- `TELECOMMUNICATIONS`: Telecommunications\n- `FINANCIAL_SERVICES`: Financial Services\n- `CATERING_SERVICES`: Catering Services\n- `SOFTWARE_TOOLS`: Software Tools\n- `FRANCHISING_AND_INVESTMENT`: Franchising and Investment\n- `BEAUTY_AND_COSMETICS`: Beauty and Cosmetics\n- `MOTHER_BABY_AND_PET`: Mother Baby and Pet\n- `DAILY_CHEMICALS`: Daily Chemicals\n- `PHYSICAL_BOOKS`: Physical Books\n- `SOCIAL_AND_COMMUNICATION`: Social and Communication\n- `CULTURAL_SUPPLIES`: Cultural Supplies\n- `SPORTS_OUTDOOR`: Sports and Outdoors", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Industry category", "enum": [ "ALL", "ELECTRONICS_AND_APPLIANCES", "SHOPPING", "FOOD_AND_BEVERAGE", "CLOTHING_AND_ACCESSORIES", "HEALTHCARE_AND_MEDICAL", "MEDICAL_INSTITUTIONS", "HOME_AND_BUILDING_MATERIALS", "LOCAL_SERVICES", "BUSINESS_SERVICES", "CULTURE_SPORTS_ENTERTAINMENT", "BEAUTY_SERVICES", "REAL_ESTATE", "EDUCATION_AND_TRAINING", "TRAVEL_AND_TOURISM", "PUBLIC_SERVICES", "GAMES", "RETAIL", "TRANSPORTATION_EQUIPMENT", "AUTOMOTIVE", "AGRICULTURE_FORESTRY_FISHERY", "CHEMICAL_AND_ENERGY", "ELECTRONICS_AND_ELECTRICAL", "MACHINERY_EQUIPMENT", "MEDIA_AND_INFORMATION", "LOGISTICS", "TELECOMMUNICATIONS", "FINANCIAL_SERVICES", "CATERING_SERVICES", "SOFTWARE_TOOLS", "FRANCHISING_AND_INVESTMENT", "BEAUTY_AND_COSMETICS", "MOTHER_BABY_AND_PET", "DAILY_CHEMICALS", "PHYSICAL_BOOKS", "SOCIAL_AND_COMMUNICATION", "CULTURAL_SUPPLIES", "SPORTS_OUTDOOR" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001500", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator link metrics", "Xingtu influencer link info", "Douyin creator industry link analysis", "抖音星图达人链路指标", "星图达人链路信息", "抖音达人行业链路分析" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_get_author_link_info" } }, "/api/douyin-xingtu/gw/api/data_sp/author_video_distribution/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Video Distribution", "description": "Returns Douyin Creator Marketplace (Xingtu) video-distribution data for a specified creator and content channel. Use it to analyze how the creator's videos are distributed during campaign research.", "operationId": "getApiDouyinXingtuGwApiDataSpAuthorVideoDistributionV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001600", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator video distribution", "Xingtu influencer content distribution", "Douyin creator video mix", "抖音星图达人视频分布", "星图达人内容分布", "抖音达人视频构成" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_author_video_distribution" } }, "/api/douyin-xingtu/gw/api/data_sp/author_audience_distribution/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Audience Distribution", "description": "Returns Douyin Creator Marketplace (Xingtu) audience-distribution data for a creator, content channel, and selected relationship stage. Use it to assess audience fit for campaign targeting.", "operationId": "getApiDouyinXingtuGwApiDataSpAuthorAudienceDistributionV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } }, { "name": "linkType", "in": "query", "description": "Link type filter.\n\nAvailable Values:\n- `CONNECTED`: Connected\n- `AWARE`: Aware\n- `INTERESTED`: Interested\n- `LIKE`: Like\n- `FOLLOW`: Follow", "required": false, "schema": { "type": "string", "default": "CONNECTED", "description": "Link type", "enum": [ "CONNECTED", "AWARE", "INTERESTED", "LIKE", "FOLLOW" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001700", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator audience distribution", "Xingtu audience relationship stages", "Douyin influencer audience profile", "抖音星图达人受众分布", "星图达人关系阶段分布", "抖音达人受众画像" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_author_audience_distribution" } }, "/api/douyin-xingtu/gw/api/author/get_author_marketing_info/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Marketing Metrics", "description": "Returns Douyin Creator Marketplace (Xingtu) marketing information for a specified creator and content channel. Use it to compare creator commercial offerings during campaign planning.", "operationId": "getApiDouyinXingtuGwApiAuthorGetAuthorMarketingInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001800", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator marketing info", "Xingtu influencer commercial services", "Douyin creator marketing data", "抖音星图达人营销信息", "星图达人商业服务信息", "抖音达人营销数据" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_author_get_author_marketing_info" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Spread Metrics", "description": "Returns Douyin Creator Marketplace (Xingtu) spread metrics for a creator, with channel, period, video-type, assignment, and flow filters. Use it to compare creator spread performance during campaign planning.", "operationId": "getApiDouyinXingtuGwApiDataSpGetAuthorSpreadInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } }, { "name": "range", "in": "query", "description": "Time range.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "DAY_30", "description": "Time range", "enum": [ "DAY_30", "DAY_90" ] } }, { "name": "type", "in": "query", "description": "Video type.\n\nAvailable Values:\n- `PERSONAL_VIDEO`: Personal video\n- `XINTU_VIDEO`: Xingtu video", "required": false, "schema": { "type": "string", "default": "PERSONAL_VIDEO", "description": "Author video type", "enum": [ "PERSONAL_VIDEO", "XINTU_VIDEO" ] } }, { "name": "onlyAssign", "in": "query", "description": "Whether to only include assigned videos.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "flowType", "in": "query", "description": "Flow type filter.\n\nAvailable Values:\n- `EXCLUDE`: Exclude\n- `INCLUDE`: Include", "required": false, "schema": { "type": "string", "default": "EXCLUDE", "description": "Flow filter type", "enum": [ "EXCLUDE", "INCLUDE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15001900", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator spread metrics", "Xingtu influencer content reach", "Douyin creator video spread analysis", "抖音星图达人传播指标", "星图达人内容传播数据", "抖音达人视频传播分析" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_get_author_spread_info" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_convert_ability/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Conversion Analysis", "description": "Returns Douyin Creator Marketplace (Xingtu) conversion analysis for a creator, content channel, and 30- or 90-day period. Use it to compare creator conversion performance during commerce campaign planning.", "operationId": "getApiDouyinXingtuGwApiDataSpGetAuthorConvertAbilityV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } }, { "name": "range", "in": "query", "description": "Time range.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "DAY_30", "description": "Time range", "enum": [ "DAY_30", "DAY_90" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15002000", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator conversion analysis", "Xingtu influencer conversion ability", "Douyin creator commerce conversion", "抖音星图达人转化能力", "星图达人转化分析", "抖音达人商业转化数据" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_get_author_convert_ability" } }, "/api/douyin-xingtu/gw/api/author/get_author_show_items_v2/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Showcase Items", "description": "Returns Douyin Creator Marketplace (Xingtu) showcase items for a creator, with content-channel, assignment, and flow filters. Use it to review a creator's marketplace showcase during commerce campaign planning.", "operationId": "getApiDouyinXingtuGwApiAuthorGetAuthorShowItemsV2V1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } }, { "name": "onlyAssign", "in": "query", "description": "Whether to only include assigned items.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "flowType", "in": "query", "description": "Flow type filter.\n\nAvailable Values:\n- `EXCLUDE`: Exclude\n- `INCLUDE`: Include", "required": false, "schema": { "type": "string", "default": "EXCLUDE", "description": "Flow filter type", "enum": [ "EXCLUDE", "INCLUDE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15002100", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator showcase items", "Xingtu influencer showcase", "Douyin creator marketplace items", "抖音星图达人橱窗内容", "星图达人展示项目", "抖音达人星图项目" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_author_get_author_show_items_v2" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_convert_videos_or_products/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Conversion Resources", "description": "Lists Douyin Creator Marketplace (Xingtu) conversion-related videos or products for a creator, with industry, period, resource-type, and page filters. Use it to review commerce examples before creator selection.", "operationId": "getApiDouyinXingtuGwApiDataSpGetAuthorConvertVideosOrProductsV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } }, { "name": "industryId", "in": "query", "description": "Industry category.\n\nAvailable Values:\n- `ALL`: All\n- `ELECTRONICS_AND_APPLIANCES`: Electronics and Appliances\n- `SHOPPING`: Shopping\n- `FOOD_AND_BEVERAGE`: Food and Beverage\n- `CLOTHING_AND_ACCESSORIES`: Clothing and Accessories\n- `HEALTHCARE_AND_MEDICAL`: Healthcare and Medical\n- `MEDICAL_INSTITUTIONS`: Medical Institutions\n- `HOME_AND_BUILDING_MATERIALS`: Home and Building Materials\n- `LOCAL_SERVICES`: Local Services\n- `BUSINESS_SERVICES`: Business Services\n- `CULTURE_SPORTS_ENTERTAINMENT`: Leisure and Entertainment\n- `BEAUTY_SERVICES`: Beauty Services\n- `REAL_ESTATE`: Real Estate\n- `EDUCATION_AND_TRAINING`: Education and Training\n- `TRAVEL_AND_TOURISM`: Travel and Tourism\n- `PUBLIC_SERVICES`: Public Services\n- `GAMES`: Games\n- `RETAIL`: Internet E-commerce Services\n- `TRANSPORTATION_EQUIPMENT`: Transportation Equipment\n- `AUTOMOTIVE`: Automotive\n- `AGRICULTURE_FORESTRY_FISHERY`: Agriculture Forestry Fishery\n- `CHEMICAL_AND_ENERGY`: Chemical and Energy\n- `ELECTRONICS_AND_ELECTRICAL`: Electronics and Electrical\n- `MACHINERY_EQUIPMENT`: Machinery Equipment\n- `MEDIA_AND_INFORMATION`: Media and Information\n- `LOGISTICS`: Logistics\n- `TELECOMMUNICATIONS`: Telecommunications\n- `FINANCIAL_SERVICES`: Financial Services\n- `CATERING_SERVICES`: Catering Services\n- `SOFTWARE_TOOLS`: Software Tools\n- `FRANCHISING_AND_INVESTMENT`: Franchising and Investment\n- `BEAUTY_AND_COSMETICS`: Beauty and Cosmetics\n- `MOTHER_BABY_AND_PET`: Mother Baby and Pet\n- `DAILY_CHEMICALS`: Daily Chemicals\n- `PHYSICAL_BOOKS`: Physical Books\n- `SOCIAL_AND_COMMUNICATION`: Social and Communication\n- `CULTURAL_SUPPLIES`: Cultural Supplies\n- `SPORTS_OUTDOOR`: Sports and Outdoors", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Industry category", "enum": [ "ALL", "ELECTRONICS_AND_APPLIANCES", "SHOPPING", "FOOD_AND_BEVERAGE", "CLOTHING_AND_ACCESSORIES", "HEALTHCARE_AND_MEDICAL", "MEDICAL_INSTITUTIONS", "HOME_AND_BUILDING_MATERIALS", "LOCAL_SERVICES", "BUSINESS_SERVICES", "CULTURE_SPORTS_ENTERTAINMENT", "BEAUTY_SERVICES", "REAL_ESTATE", "EDUCATION_AND_TRAINING", "TRAVEL_AND_TOURISM", "PUBLIC_SERVICES", "GAMES", "RETAIL", "TRANSPORTATION_EQUIPMENT", "AUTOMOTIVE", "AGRICULTURE_FORESTRY_FISHERY", "CHEMICAL_AND_ENERGY", "ELECTRONICS_AND_ELECTRICAL", "MACHINERY_EQUIPMENT", "MEDIA_AND_INFORMATION", "LOGISTICS", "TELECOMMUNICATIONS", "FINANCIAL_SERVICES", "CATERING_SERVICES", "SOFTWARE_TOOLS", "FRANCHISING_AND_INVESTMENT", "BEAUTY_AND_COSMETICS", "MOTHER_BABY_AND_PET", "DAILY_CHEMICALS", "PHYSICAL_BOOKS", "SOCIAL_AND_COMMUNICATION", "CULTURAL_SUPPLIES", "SPORTS_OUTDOOR" ] } }, { "name": "range", "in": "query", "description": "Time range.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "DAY_30", "description": "Time range", "enum": [ "DAY_30", "DAY_90" ] } }, { "name": "detailType", "in": "query", "description": "Resource type.\n\nAvailable Values:\n- `VIDEO`: Video\n- `PRODUCT`: Product", "required": false, "schema": { "type": "string", "default": "VIDEO", "description": "Detail resource type", "enum": [ "VIDEO", "PRODUCT" ] } }, { "name": "page", "in": "query", "description": "Page number.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15002200", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu conversion videos and products", "Xingtu creator conversion resources", "Douyin influencer commerce examples", "抖音星图达人转化视频商品", "星图达人转化资源", "抖音达人商业转化案例" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_get_author_convert_videos_or_products" } }, "/api/douyin-xingtu/gw/api/data_sp/author_cp_info/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Cost Performance Analysis", "description": "Returns Douyin Creator Marketplace (Xingtu) cost-performance information for a specified creator and content channel. Use it to compare creator efficiency during campaign budgeting.", "operationId": "getApiDouyinXingtuGwApiDataSpAuthorCpInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15002300", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator cost performance", "Xingtu influencer cost efficiency", "Douyin creator campaign value analysis", "抖音星图达人性价比分析", "星图达人成本效果数据", "抖音达人投放价值分析" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_author_cp_info" } }, "/api/douyin-xingtu/gw/api/data_sp/author_touch_distribution/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Audience Touchpoint Distribution", "description": "Returns Douyin Creator Marketplace (Xingtu) audience-touchpoint distribution data for a specified creator and content channel. Use it to compare audience-contact patterns during campaign research.", "operationId": "getApiDouyinXingtuGwApiDataSpAuthorTouchDistributionV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15002400", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu audience touchpoint distribution", "Xingtu creator audience touch analysis", "Douyin influencer contact distribution", "抖音星图受众触点分布", "星图达人受众触达分析", "抖音达人触点数据" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_author_touch_distribution" } }, "/api/douyin-xingtu/gw/api/data_sp/author_rec_videos_v2/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Recommended Videos", "description": "Returns Douyin Creator Marketplace (Xingtu) recommended videos for a specified creator and content channel. Use it to inspect representative content during creator research.", "operationId": "getApiDouyinXingtuGwApiDataSpAuthorRecVideosV2V1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform type.\n\nAvailable Values:\n- `SHORT_VIDEO`: Short video\n- `LIVE_STREAMING`: Live streaming\n- `PICTURE_TEXT`: Picture and text\n- `SHORT_DRAMA`: Short drama", "required": false, "schema": { "type": "string", "default": "SHORT_VIDEO", "description": "Platform type", "enum": [ "SHORT_VIDEO", "LIVE_STREAMING", "PICTURE_TEXT", "SHORT_DRAMA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15002500", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator recommended videos", "Xingtu influencer representative videos", "Douyin creator reference content", "抖音星图达人推荐视频", "星图达人代表视频", "抖音达人参考内容" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_author_rec_videos_v2" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_fans_distribution/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Follower Distribution", "description": "Returns Douyin Creator Marketplace (Xingtu) follower or loyal-follower distribution data for a specified creator. Use it to compare audience-profile distributions during creator selection.", "operationId": "getApiDouyinXingtuGwApiDataSpGetAuthorFansDistributionV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "authorType", "in": "query", "description": "Author type filter.\n\nAvailable Values:\n- `FAN`: Fan\n- `DIE_HARD_FAN`: Die Hard Fan", "required": false, "schema": { "type": "string", "default": "FAN", "description": "Author relationship type", "enum": [ "FAN", "DIE_HARD_FAN" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15002600", "x-api-version": "v1", "x-search-aliases": [ "Douyin fan profile city distribution", "Xingtu follower distribution", "Douyin creator loyal follower profile", "抖音粉丝画像城市分布", "星图达人粉丝分布", "抖音达人铁粉画像" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_get_author_fans_distribution" } }, "/api/douyin-xingtu/gw/api/data_sp/item_report_trend/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Item Report Trends", "description": "Returns Douyin Creator Marketplace (Xingtu) report trend data for a specified video item. Use it to review how a video's reported performance changes over time.", "operationId": "getApiDouyinXingtuGwApiDataSpItemReportTrendV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Item's unique ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15002800", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu video report trends", "Xingtu item performance trend", "Douyin campaign video trend data", "抖音星图视频报告趋势", "星图作品表现趋势", "抖音投放视频趋势数据" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_item_report_trend" } }, "/api/douyin-xingtu/gw/api/data_sp/item_report_detail/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Video Details", "description": "Returns Douyin Creator Marketplace (Xingtu) report details for a specified video item. Use it to inspect a video's marketplace report during content performance analysis.", "operationId": "getApiDouyinXingtuGwApiDataSpItemReportDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Item's unique ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15002900", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu video report details", "Xingtu item performance report", "Douyin campaign video detail", "抖音星图视频报告详情", "星图作品表现报告", "抖音投放视频详情" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_item_report_detail" } }, "/api/douyin-xingtu/gw/api/data_sp/item_report_th_analysis/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Item Report Analysis", "description": "Returns Douyin Creator Marketplace (Xingtu) report analysis for a specified video item. Use it to evaluate a video's reported performance during campaign review.", "operationId": "getApiDouyinXingtuGwApiDataSpItemReportThAnalysisV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Item's unique ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003000", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu video report analysis", "Xingtu item performance analysis", "Douyin campaign video report diagnostics", "抖音星图视频报告分析", "星图作品表现分析", "抖音投放视频分析" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_item_report_th_analysis" } }, "/api/douyin-xingtu/gw/api/data/get_author_hot_comment_tokens/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Comment Keyword Analysis", "description": "Returns Douyin Creator Marketplace (Xingtu) comment keyword analysis for a specified creator. Use it to identify recurring audience discussion themes during creator research.", "operationId": "getApiDouyinXingtuGwApiDataGetAuthorHotCommentTokensV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003050", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu comment keyword analysis", "Xingtu creator comment topics", "Douyin influencer audience discussion keywords", "抖音星图达人评论关键词", "星图达人评论话题分析", "抖音达人受众讨论词" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_get_author_hot_comment_tokens" } }, "/api/douyin-xingtu/gw/api/data_sp/get_author_daily_fans/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Follower Growth Trend", "description": "Returns Douyin Creator Marketplace (Xingtu) daily follower trend data for a specified creator and date range. Use it to review follower growth patterns during creator evaluation.", "operationId": "getApiDouyinXingtuGwApiDataSpGetAuthorDailyFansV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Start Date (yyyy-MM-dd).", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "End Date (yyyy-MM-dd).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003060", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu daily follower trend", "Xingtu creator follower growth", "Douyin influencer daily fan data", "抖音星图达人每日涨粉", "星图达人粉丝增长趋势", "抖音达人每日粉丝数据" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_data_sp_get_author_daily_fans" } }, "/api/douyin-xingtu/gw/api/gauthor/get_author_content_hot_keywords/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Content Keyword Analysis", "description": "Returns Douyin Creator Marketplace (Xingtu) content keyword analysis for a specified creator. Use it to identify recurring content themes during creator positioning research.", "operationId": "getApiDouyinXingtuGwApiGauthorGetAuthorContentHotKeywordsV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003070", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu content keyword analysis", "Xingtu creator content themes", "Douyin influencer content positioning keywords", "抖音星图达人内容关键词", "星图达人内容主题分析", "抖音达人内容定位词" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_gauthor_get_author_content_hot_keywords" } }, "/api/douyin-xingtu/gw/api/gauthor/author_get_business_card_info/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Business Card", "description": "Returns the Douyin Creator Marketplace (Xingtu) business-card profile for a specified creator. Use it to review creator identity and business context before campaign outreach.", "operationId": "getApiDouyinXingtuGwApiGauthorAuthorGetBusinessCardInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003075", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator business card", "Xingtu influencer business profile", "Douyin creator commercial profile", "抖音星图达人商业名片", "星图达人商务资料", "抖音达人商业档案" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_gauthor_author_get_business_card_info" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_commerce_spread_info/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Commerce Spread Info", "description": "Returns Douyin Creator Marketplace (Xingtu) commerce spread information for a specified creator. Use it to compare creators during commerce campaign planning.", "operationId": "getApiDouyinXingtuGwApiAggregatorGetAuthorCommerceSpreadInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003080", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu commerce spread info", "Xingtu creator commerce reach", "Douyin creator commercial spread analysis", "抖音星图达人商业传播信息", "星图达人商业传播分析", "抖音达人商业传播数据" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_aggregator_get_author_commerce_spread_info" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_homepage_videos/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Homepage Videos", "description": "Lists a Douyin Creator Marketplace (Xingtu) creator's homepage videos with keyword, video-type, assignment, date, and page filters. Use it to review relevant content before campaign selection.", "operationId": "getApiDouyinXingtuGwApiAggregatorGetAuthorHomepageVideosV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique Xingtu ID.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number, starting from 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "keyword", "in": "query", "description": "Keyword used to search creator homepage videos.", "required": false, "schema": { "type": "string" } }, { "name": "videoType", "in": "query", "description": "Homepage video type filter.\n\nAvailable Values:\n- `ALL`: All videos\n- `PERSONAL`: Personal videos\n- `XINGTU`: Xingtu videos", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Creator homepage video type", "enum": [ "ALL", "PERSONAL", "XINGTU" ] } }, { "name": "onlyAssign", "in": "query", "description": "Whether to include only assigned videos. Xingtu usually shows this option when `videoType` is `XINGTU`.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "startDate", "in": "query", "description": "Start publish date in yyyyMMdd format. The filter starts at 00:00:00 in Asia/Shanghai.", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "End publish date in yyyyMMdd format. The filter ends at 23:59:59 in Asia/Shanghai.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003082", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator homepage videos", "Xingtu creator video list", "Douyin creator video keyword search", "抖音星图达人主页视频", "星图达人视频列表", "抖音达人主页视频搜索" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_aggregator_get_author_homepage_videos" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_tags/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Tags", "description": "Returns Douyin Creator Marketplace (Xingtu) tags for a specified creator. Use it to classify creators and compare their fit for campaign briefs.", "operationId": "getApiDouyinXingtuGwApiAggregatorGetAuthorTagsV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "starAuthorId", "in": "query", "description": "Creator's unique Xingtu ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003084", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator tags", "Xingtu influencer category tags", "Douyin creator positioning labels", "抖音星图达人标签", "星图达人分类标签", "抖音达人定位标签" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_aggregator_get_author_tags" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_side_base_info/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Side Base Info", "description": "Returns the Douyin Creator Marketplace (Xingtu) side-card baseline information for a specified creator. Use it to review a creator's marketplace overview during shortlisting.", "operationId": "getApiDouyinXingtuGwApiAggregatorGetAuthorSideBaseInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003085", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator side card info", "Xingtu creator marketplace overview", "Douyin creator sidebar profile", "抖音星图达人侧边基础信息", "星图达人侧卡信息", "抖音达人市场概览" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_aggregator_get_author_side_base_info" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_live_statistics/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Live Statistics", "description": "Returns Douyin Creator Marketplace (Xingtu) live-stream statistics for a creator, with live-room, period, marketplace-order, and flow filters. Use it to compare live-streaming creators for campaign planning.", "operationId": "getApiDouyinXingtuGwApiAggregatorGetAuthorLiveStatisticsV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "liveType", "in": "query", "description": "Live room type filter.\n\nAvailable Values:\n- `ALL`: All live rooms\n- `GAME`: Game live rooms\n- `ECOMMERCE`: E-commerce live rooms\n- `OTHER`: Other live rooms", "required": false, "schema": { "type": "string", "default": "1", "description": "Live room type", "enum": [ "ALL", "GAME", "ECOMMERCE", "OTHER" ] } }, { "name": "period", "in": "query", "description": "Live data time period.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "30", "description": "Live data time period", "enum": [ "DAY_30", "DAY_90" ] } }, { "name": "onlyStarOrder", "in": "query", "description": "Whether to include only Xingtu marketplace orders.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "flowType", "in": "query", "description": "Flow type filter.\n\nAvailable Values:\n- `EXCLUDE`: Exclude\n- `INCLUDE`: Include", "required": false, "schema": { "type": "string", "default": "0", "description": "Flow filter type", "enum": [ "EXCLUDE", "INCLUDE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003086", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu creator live statistics", "Xingtu live creator performance", "Douyin creator livestream data", "抖音星图达人直播统计", "星图直播达人数据", "抖音达人直播表现" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_aggregator_get_author_live_statistics" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_live_watch_distribution/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Live Watch Distribution", "description": "Returns Douyin Creator Marketplace (Xingtu) live audience or follower watch-distribution data for a creator and selected live-room type. Use it to assess live audience fit for a campaign.", "operationId": "getApiDouyinXingtuGwApiAggregatorGetAuthorLiveWatchDistributionV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "liveCrowdType", "in": "query", "description": "Live audience profile type.\n\nAvailable Values:\n- `AUDIENCE`: Viewer profile\n- `FANS`: Follower profile", "required": false, "schema": { "type": "string", "default": "2", "description": "Live audience profile type", "enum": [ "AUDIENCE", "FANS" ] } }, { "name": "liveType", "in": "query", "description": "Live room type filter.\n\nAvailable Values:\n- `ALL`: All live rooms\n- `GAME`: Game live rooms\n- `ECOMMERCE`: E-commerce live rooms\n- `OTHER`: Other live rooms", "required": false, "schema": { "type": "string", "default": "1", "description": "Live room type", "enum": [ "ALL", "GAME", "ECOMMERCE", "OTHER" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003087", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu live audience distribution", "Xingtu live viewer profile", "Douyin creator live follower profile", "抖音星图直播观众分布", "星图直播粉丝画像", "抖音达人直播受众画像" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_aggregator_get_author_live_watch_distribution" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_commerce_seed_base_info/v1": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Commerce Seeding Base Info", "description": "Returns Douyin Creator Marketplace (Xingtu) commerce-seeding baseline information for a creator over a selectable 30- or 90-day period. Use it to research creators for product-seeding campaigns.", "operationId": "getApiDouyinXingtuGwApiAggregatorGetAuthorCommerceSeedBaseInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "Time range.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "DAY_90", "description": "Time period", "enum": [ "DAY_30", "DAY_90" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003090", "x-api-version": "v1", "x-search-aliases": [ "Douyin Xingtu commerce seeding creator data", "Xingtu product seeding creator research", "Douyin creator seeding analysis", "抖音星图达人种草基础信息", "星图商业种草达人分析", "抖音达人种草数据" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_aggregator_get_author_commerce_seed_base_info" } }, "/api/douyin-xingtu/gw/api/aggregator/get_author_contract_base_info": { "get": { "tags": [ "Douyin Creator Marketplace (Xingtu)" ], "summary": "Creator Contract Base Info", "description": "Returns Douyin Creator Marketplace (Xingtu) contract-related baseline information for a creator over a selectable 30- or 90-day period. Use it to review creator contract context during campaign planning.", "operationId": "getApiDouyinXingtuGwApiAggregatorGetAuthorContractBaseInfo", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "oAuthorId", "in": "query", "description": "Author's unique ID.", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "Time range.\n\nAvailable Values:\n- `DAY_30`: Last 30 days\n- `DAY_90`: Last 90 days", "required": false, "schema": { "type": "string", "default": "90", "description": "Contract base information time range", "enum": [ "DAY_30", "DAY_90" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "15003095", "x-search-aliases": [ "Douyin Xingtu creator contract info", "Xingtu creator cooperation baseline", "Douyin creator marketplace contract context", "抖音星图达人合约基础信息", "星图达人合作基础数据", "抖音达人合约信息" ], "x-highlights": [], "x-endpoint-family": "douyin_xingtu_gw_api_aggregator_get_author_contract_base_info" } }, "/api/kuaishou/search-video/v1": { "get": { "tags": [ "Kuaishou" ], "summary": "Video Search", "description": "Search public Kuaishou videos by keyword with cursor-based pagination. Use it to discover relevant videos and continue through additional result pages.", "operationId": "getApiKuaishouSearchVideoV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "The search keyword to find videos.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor returned by the previous response. Omit or leave blank for the first page; maximum 256 characters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16000500", "x-api-version": "v1", "x-search-aliases": [ "Kuaishou video search", "Kuaishou keyword video search", "Kuaishou cursor video search", "快手视频搜索", "快手关键词视频搜索", "快手游标搜索" ], "x-highlights": [], "x-endpoint-family": "kuaishou_search_video" } }, "/api/kuaishou/search-video/v2": { "get": { "tags": [ "Kuaishou" ], "summary": "Video Search", "description": "Search public Kuaishou videos by keyword with page-number pagination. Use it to discover relevant videos and browse results by page.", "operationId": "getApiKuaishouSearchVideoV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "The search keyword to find videos.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for results, starting from 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16001000", "x-api-version": "v2", "x-search-aliases": [ "Kuaishou video search", "Kuaishou keyword video search", "Kuaishou paged video search", "快手视频搜索", "快手关键词视频搜索", "快手分页视频搜索" ], "x-highlights": [], "x-endpoint-family": "kuaishou_search_video" } }, "/api/kuaishou/search-user/v2": { "get": { "tags": [ "Kuaishou" ], "summary": "User Search", "description": "Search public Kuaishou user accounts by keyword with page-number pagination. Use it to discover relevant creators or accounts before requesting profile and published-video data.", "operationId": "getApiKuaishouSearchUserV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "The search keyword to find users.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for results, starting from 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16001100", "x-api-version": "v2", "x-search-aliases": [ "Kuaishou user search", "Kuaishou creator search", "Kuaishou account search", "快手用户搜索", "快手达人搜索", "快手账号搜索" ], "x-highlights": [], "x-endpoint-family": "kuaishou_search_user" } }, "/api/kuaishou/get-user-video-list/v2": { "get": { "tags": [ "Kuaishou" ], "summary": "User Published Videos", "description": "Retrieve public videos published by a Kuaishou user, with optional cursor-based pagination. Use it to review a creator's content history or select videos for detail and comment requests.", "operationId": "getApiKuaishouGetUserVideoListV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "The unique user ID on Kuaishou.", "required": true, "schema": { "type": "string" } }, { "name": "pcursor", "in": "query", "description": "Pagination cursor for subsequent pages.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16001200", "x-api-version": "v2", "x-search-aliases": [ "Kuaishou user videos", "Kuaishou creator video list", "Kuaishou published videos", "快手用户作品", "快手达人视频列表", "快手用户发布视频" ], "x-highlights": [], "x-endpoint-family": "kuaishou_get_user_video_list" } }, "/api/kuaishou/get-video-detail/v2": { "get": { "tags": [ "Kuaishou" ], "summary": "Video Details", "description": "Retrieve public details for a Kuaishou video identified by its video ID. Use it to inspect a selected video after search or user-published-video discovery.", "operationId": "getApiKuaishouGetVideoDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "videoId", "in": "query", "description": "The unique video identifier returned by Kuaishou.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16001300", "x-api-version": "v2", "x-search-aliases": [ "Kuaishou video details", "Kuaishou video information", "Kuaishou video lookup", "快手视频详情", "快手作品详情", "快手视频信息" ], "x-highlights": [ { "type": "tip", "kind": "GUIDANCE", "content": "Read `videoId` from the `clientCacheKey` parameter in `main_url` and remove the `.jpg` suffix." } ], "x-endpoint-family": "kuaishou_get_video_detail" } }, "/api/kuaishou/get-video-comment/v1": { "get": { "tags": [ "Kuaishou" ], "summary": "Video Comments", "description": "Retrieve public comments for a Kuaishou video, with optional cursor-based pagination. Use it to review audience discussion and continue through additional comment pages.", "operationId": "getApiKuaishouGetVideoCommentV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "videoId", "in": "query", "description": "The Kuaishou video identifier or numeric refer_photo_id returned by a related response.", "required": true, "schema": { "type": "string" } }, { "name": "pcursor", "in": "query", "description": "Pagination cursor for subsequent pages.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16001400", "x-search-aliases": [ "Kuaishou video comments", "Kuaishou comment list", "Kuaishou video discussion", "快手视频评论", "快手评论列表", "快手作品评论" ], "x-highlights": [], "x-endpoint-family": "kuaishou_get_video_comment" } }, "/api/kuaishou/get-user-detail/v1": { "get": { "tags": [ "Kuaishou" ], "summary": "User Profile", "description": "Retrieve the public profile for a Kuaishou user identified by user ID. Use it to inspect an account found through user or video results.", "operationId": "getApiKuaishouGetUserDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "The unique user ID on Kuaishou.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16001500", "x-api-version": "v1", "x-search-aliases": [ "Kuaishou user profile", "Kuaishou account details", "Kuaishou creator profile", "快手用户资料", "快手账号详情", "快手达人资料" ], "x-highlights": [], "x-endpoint-family": "kuaishou_get_user_detail" } }, "/api/kuaishou/share-url-transfer/v1": { "get": { "tags": [ "Kuaishou" ], "summary": "Share Link Resolution", "description": "Resolve a supported Kuaishou short share link and return its public redirect URL. Use it to expand shared links before subsequent Kuaishou content lookup or processing.", "operationId": "getApiKuaishouShareUrlTransferV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "shareUrl", "in": "query", "description": "A Kuaishou short share URL beginning with https://v.kuaishou.com/.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16001600", "x-api-version": "v1", "x-search-aliases": [ "Kuaishou short link resolution", "Kuaishou share link expansion", "Kuaishou redirect URL", "快手短链解析", "快手分享链接解析", "快手跳转链接" ], "x-highlights": [], "x-endpoint-family": "kuaishou_share_url_transfer" } }, "/api/weixin/get-account-today-articles/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Account Today Articles", "description": "Retrieves articles published today by a WeChat Official Account identified by biz ID, article URL, account name, or wxid. Use it to monitor same-day publishing activity for a known account.", "operationId": "getApiWeixinGetAccountTodayArticlesV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "biz", "in": "query", "description": "WeChat Official Account biz id. You can read it from the __biz query parameter in an article URL. Use one of biz, url, or name.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "url", "in": "query", "description": "WeChat Official Account article URL used to identify the account. Use one of biz, url, or name.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "name", "in": "query", "description": "WeChat Official Account name or wxid. Use one of biz, url, or name.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": "16101000", "x-api-version": "v1", "x-search-aliases": [ "WeChat Official Account today's articles", "WeChat account daily posts", "WeChat same-day article list", "微信公众号今日文章", "公众号当天发文", "微信公众号每日文章" ], "x-highlights": [], "x-endpoint-family": "weixin_get_account_today_articles" } }, "/api/weixin/get-account-history-articles/v1": { "post": { "tags": [ "WeChat Official Accounts" ], "summary": "Account Historical Articles", "description": "Retrieves page-number-paginated historical articles for a WeChat Official Account identified by biz ID, article URL, account name, or wxid. Use it to browse an account's article archive one page at a time.", "operationId": "postApiWeixinGetAccountHistoryArticlesV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "biz", "in": "query", "description": "WeChat Official Account biz id. You can read it from the __biz query parameter in an article URL. Use one of biz, url, or name.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "url", "in": "query", "description": "WeChat Official Account article URL used to identify the account. Use one of biz, url, or name.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "name", "in": "query", "description": "WeChat Official Account name or wxid. Use one of biz, url, or name.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "Page number starting from 1 for paginated WeChat Official Account historical articles.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": "16101010", "x-api-version": "v1", "x-search-aliases": [ "WeChat Official Account article history", "WeChat account article archive", "WeChat historical posts by page", "微信公众号历史文章", "公众号文章归档", "微信公众号历史发文分页" ], "x-highlights": [], "x-endpoint-family": "weixin_get_account_history_articles" } }, "/api/weixin/get-account-history-articles/v2": { "post": { "tags": [ "WeChat Official Accounts" ], "summary": "Account Historical Articles", "description": "Retrieves historical articles for a WeChat Official Account identified by ghid or article URL, with an offset cursor from the previous page. Use it to continue through an account's article archive with cursor pagination.", "operationId": "postApiWeixinGetAccountHistoryArticlesV2", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "ghid": { "type": "string", "default": "", "description": "WeChat Official Account original identifier, using the gh_ prefix returned by WeChat. Use either ghid or url." }, "url": { "type": "string", "default": "", "description": "WeChat Official Account article URL used to identify the account and fetch historical articles. Use either ghid or url." }, "offset": { "type": "string", "default": "", "description": "PagingInfo.Offset cursor returned by the previous response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101020", "x-api-version": "v2", "x-search-aliases": [ "WeChat Official Account article history v2", "WeChat ghid article archive", "WeChat offset cursor articles", "微信公众号历史文章 V2", "公众号 ghid 文章查询", "微信公众号游标分页文章" ], "x-highlights": [], "x-endpoint-family": "weixin_get_account_history_articles" } }, "/api/weixin/get-article-metrics/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Metrics", "description": "Retrieves basic interaction metrics for a WeChat Official Account article URL that ends with #rd or #wechat_redirect. Use it to perform a lightweight popularity check for a known article.", "operationId": "getApiWeixinGetArticleMetricsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "articleUrl", "in": "query", "description": "WeChat Official Account article URL used to fetch basic interaction metrics such as reads and likes. It must end with #rd or #wechat_redirect.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101100", "x-api-version": "v1", "x-search-aliases": [ "WeChat article metrics API", "WeChat article read and like stats", "WeChat Official Account engagement metrics", "微信公众号文章数据", "公众号阅读点赞数据", "微信文章互动指标" ], "x-highlights": [], "x-endpoint-family": "weixin_get_article_metrics" } }, "/api/weixin/get-article-metrics/v2": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Metrics", "description": "Retrieves extended interaction metrics for a WeChat Official Account article by URL. Use it to compare article performance or support deeper engagement analysis for known content.", "operationId": "getApiWeixinGetArticleMetricsV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "articleUrl", "in": "query", "description": "WeChat Official Account article URL used to fetch extended interaction and article performance metrics.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101110", "x-api-version": "v2", "x-search-aliases": [ "WeChat extended article metrics", "WeChat article performance API", "WeChat Official Account engagement analytics", "微信公众号文章详细数据", "公众号文章表现分析", "微信文章扩展互动指标" ], "x-highlights": [], "x-endpoint-family": "weixin_get_article_metrics" } }, "/api/weixin/get-article-detail/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Details", "description": "Retrieves a WeChat Official Account article by URL with selectable plain-text or rich-text content mode. Use it to collect a known article in the preferred representation for reading, extraction, or storage.", "operationId": "getApiWeixinGetArticleDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "articleUrl", "in": "query", "description": "WeChat Official Account article URL used to fetch article detail content and metadata.", "required": true, "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "Article body format. TEXT returns plain text, and RICH_TEXT returns rich text when supported.\n\nAvailable Values:\n- `TEXT`: Plain text article detail\n- `RICH_TEXT`: Rich text article detail", "required": false, "schema": { "type": "string", "default": "TEXT", "description": "Weixin article detail mode", "enum": [ "TEXT", "RICH_TEXT" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101200", "x-api-version": "v1", "x-search-aliases": [ "WeChat article details API", "WeChat article text or rich text", "WeChat Official Account article lookup", "微信公众号文章详情", "微信文章正文提取", "公众号富文本文章" ], "x-highlights": [], "x-endpoint-family": "weixin_get_article_detail" } }, "/api/weixin/get-article-detail/v2": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Details", "description": "Retrieves structured details for a WeChat Official Account article by URL. Use it to collect a known article for parsing, indexing, or structured content archiving.", "operationId": "getApiWeixinGetArticleDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "articleUrl", "in": "query", "description": "WeChat Official Account article URL used to fetch structured article detail fields and an HTML content fragment.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101210", "x-api-version": "v2", "x-search-aliases": [ "WeChat structured article details", "WeChat article parsing API", "WeChat Official Account article data", "微信公众号结构化文章", "微信文章解析接口", "公众号文章数据提取" ], "x-highlights": [], "x-endpoint-family": "weixin_get_article_detail" } }, "/api/weixin/get-article-detail/v3": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Details", "description": "Retrieves details for a WeChat Official Account article that may include video content, with selectable plain-text or rich-text mode. Use it to process known articles containing video material.", "operationId": "getApiWeixinGetArticleDetailV3", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "articleUrl", "in": "query", "description": "WeChat Official Account article URL used to fetch article details with video-related fields when available.", "required": true, "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "Article body format. TEXT returns plain text, and RICH_TEXT returns rich text when supported.\n\nAvailable Values:\n- `TEXT`: Plain text article detail\n- `RICH_TEXT`: Rich text article detail", "required": false, "schema": { "type": "string", "default": "TEXT", "description": "Weixin article detail mode", "enum": [ "TEXT", "RICH_TEXT" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101220", "x-api-version": "v3", "x-search-aliases": [ "WeChat video article details", "WeChat article with video lookup", "WeChat rich text video article", "微信公众号视频文章详情", "微信含视频文章提取", "公众号视频内容解析" ], "x-highlights": [], "x-endpoint-family": "weixin_get_article_detail" } }, "/api/weixin/get-article-detail/v4": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Details", "description": "Retrieves an HTML representation of a WeChat Official Account article by URL. Use it to preserve, render, or archive a known article as a web document.", "operationId": "getApiWeixinGetArticleDetailV4", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "articleUrl", "in": "query", "description": "WeChat Official Account article URL used to fetch a full HTML document for rendering or archiving.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101230", "x-api-version": "v4", "x-search-aliases": [ "WeChat article HTML API", "WeChat full article HTML", "WeChat article web document", "微信公众号文章 HTML", "微信文章网页源码", "公众号文章页面归档" ], "x-highlights": [], "x-endpoint-family": "weixin_get_article_detail" } }, "/api/weixin/get-article-detail/v5": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Details", "description": "Retrieves lightweight information for a WeChat Official Account article by URL. Use it to perform a quick article lookup before deeper content, metric, or comment retrieval.", "operationId": "getApiWeixinGetArticleDetailV5", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "articleUrl", "in": "query", "description": "WeChat Official Account article URL used to fetch lightweight article metadata and status information.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101240", "x-api-version": "v5", "x-search-aliases": [ "WeChat lightweight article info", "WeChat quick article lookup", "WeChat Official Account article info", "微信公众号文章基础信息", "微信文章快速查询", "公众号文章信息查询" ], "x-highlights": [], "x-endpoint-family": "weixin_get_article_detail" } }, "/api/weixin/get-article-comment/v1": { "post": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Comments", "description": "Retrieves top-level comments for a WeChat Official Account article by URL, with an optional buffer cursor for pagination. Use it to review reader discussion or continue through comment pages for a known article.", "operationId": "postApiWeixinGetArticleCommentV1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "articleUrl": { "type": "string", "description": "WeChat Official Account article URL used to fetch top-level article comments." }, "buffer": { "type": "string", "default": "", "description": "Comment pagination buffer returned by the previous response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "articleUrl", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101300", "x-api-version": "v1", "x-search-aliases": [ "WeChat article comments API", "WeChat Official Account comment list", "WeChat article comment pagination", "微信公众号文章评论", "微信文章留言列表", "公众号评论分页" ], "x-highlights": [], "x-endpoint-family": "weixin_get_article_comment" } }, "/api/weixin/get-article-sub-comment/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Comment Replies", "description": "Retrieves replies under a top-level comment for a WeChat Official Account article, identified by article URL and contentId. Use it to inspect threaded discussion beneath a known comment.", "operationId": "getApiWeixinGetArticleSubCommentV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "articleUrl", "in": "query", "description": "WeChat Official Account article URL used to fetch replies under a top-level comment.", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "query", "description": "Top-level comment content id used to fetch nested comment replies.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101310", "x-api-version": "v1", "x-search-aliases": [ "WeChat comment replies API", "WeChat article reply thread", "WeChat comment contentId lookup", "微信公众号评论回复", "微信文章二级评论", "公众号留言回复查询" ], "x-highlights": [], "x-endpoint-family": "weixin_get_article_sub_comment" } }, "/api/weixin/search-article-hot/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Hot Article Search", "description": "Searches hot WeChat Official Account articles within a required date range of up to 7 days, with optional keyword plus publication-format, category, and page filters. Use it to identify high-interest content for trend research or editorial benchmarking.", "operationId": "getApiWeixinSearchArticleHotV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Optional keyword used to filter hot WeChat Official Account articles.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "publishType", "in": "query", "description": "Publish type filter for hot WeChat Official Account article results.\n\nAvailable Values:\n- `IMAGE_TEXT`: Image and text article\n- `VIDEO`: Pure video article\n- `AUDIO`: Pure audio or music article\n- `IMAGE`: Pure image article\n- `TEXT`: Pure text article\n- `REPRINT`: Reprinted article", "required": false, "schema": { "type": "string", "default": "IMAGE_TEXT", "description": "Weixin hot article publish type", "enum": [ "IMAGE_TEXT", "VIDEO", "AUDIO", "IMAGE", "TEXT", "REPRINT" ] } }, { "name": "category", "in": "query", "description": "Category filter for hot WeChat Official Account article results.\n\nAvailable Values:\n- `ALL`: All categories\n- `INTERNATIONAL`: International\n- `SPORTS`: Sports\n- `ENTERTAINMENT`: Entertainment\n- `SOCIETY`: Society\n- `FINANCE`: Finance\n- `CURRENT_AFFAIRS`: Current affairs\n- `TECHNOLOGY`: Technology\n- `EMOTION`: Emotion\n- `AUTOMOTIVE`: Automotive\n- `EDUCATION`: Education\n- `FASHION`: Fashion\n- `GAMES`: Games\n- `MILITARY`: Military\n- `TRAVEL`: Travel\n- `FOOD`: Food\n- `CULTURE`: Culture\n- `HEALTH`: Health\n- `HUMOR`: Humor\n- `HOME`: Home\n- `ANIMATION`: Animation\n- `PETS`: Pets\n- `PARENTING`: Parenting\n- `ASTROLOGY`: Astrology\n- `HISTORY`: History\n- `MUSIC`: Music\n- `UNCATEGORIZED`: Uncategorized\n- `COMPREHENSIVE`: Comprehensive\n- `WORKPLACE`: Workplace\n- `AGRICULTURE`: Agriculture\n- `ELDERLY_CARE`: Elderly care", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Weixin hot article category", "enum": [ "ALL", "INTERNATIONAL", "SPORTS", "ENTERTAINMENT", "SOCIETY", "FINANCE", "CURRENT_AFFAIRS", "TECHNOLOGY", "EMOTION", "AUTOMOTIVE", "EDUCATION", "FASHION", "GAMES", "MILITARY", "TRAVEL", "FOOD", "CULTURE", "HEALTH", "HUMOR", "HOME", "ANIMATION", "PETS", "PARENTING", "ASTROLOGY", "HISTORY", "MUSIC", "UNCATEGORIZED", "COMPREHENSIVE", "WORKPLACE", "AGRICULTURE", "ELDERLY_CARE" ] } }, { "name": "page", "in": "query", "description": "Page number starting from 1 for hot WeChat Official Account article results.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "startDay", "in": "query", "description": "Start date for hot article search in yyyy-MM-dd format. The range through endDay must not exceed 7 days.", "required": true, "schema": { "type": "string" } }, { "name": "endDay", "in": "query", "description": "End date for hot article search in yyyy-MM-dd format. It must be on or after startDay and no more than 7 days later.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": "16101420", "x-api-version": "v1", "x-search-aliases": [ "WeChat hot article search", "WeChat viral Official Account articles", "WeChat trending article finder", "微信公众号热门文章", "微信爆文搜索", "公众号热文榜查询" ], "x-highlights": [], "x-endpoint-family": "weixin_search_article_hot" } }, "/api/weixin/search-article/v1": { "post": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Search", "description": "Searches WeChat Official Account articles by keyword with publish-time and sort filters plus page, offset, and continuation-state pagination. Use it to discover recent or high-interest articles for topic research and content monitoring.", "operationId": "postApiWeixinSearchArticleV1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "keyword": { "type": "string", "description": "Search keyword for WeChat Official Account articles." }, "publishTimeType": { "type": "string", "default": "ALL", "description": "Weixin web article search publish time filter", "enum": [ "ALL", "ONE_DAY", "SEVEN_DAYS", "HALF_YEAR" ] }, "sortType": { "type": "string", "default": "COMPREHENSIVE", "description": "Weixin web article search sort type", "enum": [ "COMPREHENSIVE", "LATEST", "HOT" ] }, "currentPage": { "type": "integer", "format": "int32", "default": 1, "description": "Current page number starting from 1 for WeChat web search pagination." }, "offset": { "type": "integer", "format": "int32", "default": 0, "description": "Search result offset returned by the previous response. Use 0 for the first page." }, "cookies_buffer": { "type": "string", "default": "", "description": "Opaque pagination state returned by the previous WeChat web search response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "keyword", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101430", "x-api-version": "v1", "x-search-aliases": [ "WeChat Official Account article search", "WeChat article keyword search", "WeChat article time and sort filters", "微信公众号文章搜索", "微信文章关键词搜索", "公众号文章时间排序筛选" ], "x-highlights": [], "x-endpoint-family": "weixin_search_article" } }, "/api/weixin/search-article/v2": { "post": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Search", "description": "Searches WeChat Official Account articles by keyword within a selected category such as followed accounts, latest, recently read, or hot, with continuation pagination. Use it to focus article discovery on a particular result stream.", "operationId": "postApiWeixinSearchArticleV2", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "keyword": { "type": "string", "description": "Search keyword for categorized WeChat Official Account article web search." }, "subSearchType": { "type": "string", "default": "ALL", "description": "Weixin article category search subtype", "enum": [ "ALL", "FOLLOWED", "LATEST", "RECENT_READ", "HOT" ] }, "currentPage": { "type": "integer", "format": "int32", "default": 1, "description": "Current page number starting from 1 for WeChat web search pagination." }, "offset": { "type": "integer", "format": "int32", "default": 0, "description": "Search result offset returned by the previous response. Use 0 for the first page." }, "cookies_buffer": { "type": "string", "default": "", "description": "Opaque pagination state returned by the previous WeChat web search response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "keyword", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101440", "x-api-version": "v2", "x-search-aliases": [ "WeChat categorized article search", "WeChat followed account article search", "WeChat latest or hot article search", "微信公众号分类文章搜索", "微信关注公众号文章搜索", "公众号最新热门文章查询" ], "x-highlights": [], "x-endpoint-family": "weixin_search_article" } }, "/api/weixin/search-miniprogram/v1": { "post": { "tags": [ "WeChat Official Accounts" ], "summary": "Mini Program Search", "description": "Searches WeChat Mini Programs by keyword with page, offset, and continuation-state pagination. Use it to discover mini programs related to a brand, service, topic, or product.", "operationId": "postApiWeixinSearchMiniprogramV1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "keyword": { "type": "string", "description": "Search keyword for WeChat mini program web search." }, "currentPage": { "type": "integer", "format": "int32", "default": 1, "description": "Current page number starting from 1 for WeChat web search pagination." }, "offset": { "type": "integer", "format": "int32", "default": 0, "description": "Search result offset returned by the previous response. Use 0 for the first page." }, "cookies_buffer": { "type": "string", "default": "", "description": "Opaque pagination state returned by the previous WeChat web search response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "keyword", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101450", "x-api-version": "v1", "x-search-aliases": [ "WeChat Mini Program search API", "WeChat applet keyword search", "WeChat Mini Program discovery", "微信小程序搜索", "小程序关键词查询", "微信应用发现" ], "x-highlights": [], "x-endpoint-family": "weixin_search_miniprogram" } }, "/api/weixin/search-wechat-index/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "WeChat Index Search", "description": "Queries WeChat Index for a keyword. Use it to examine trend interest within WeChat before planning content, campaigns, or further article research.", "operationId": "getApiWeixinSearchWechatIndexV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Keyword used to query WeChat Index trend signals.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101460", "x-api-version": "v1", "x-search-aliases": [ "WeChat Index API", "WeChat keyword trend lookup", "WeChat search index", "微信指数查询", "微信关键词热度", "微信趋势指数" ], "x-highlights": [], "x-endpoint-family": "weixin_search_wechat_index" } }, "/api/weixin/search-suggestions/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Search Suggestions", "description": "Retrieves WeChat search suggestions for a keyword, optionally scoped by a supported business type. Use it to expand or refine a query before a targeted WeChat search.", "operationId": "getApiWeixinSearchSuggestionsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Keyword used to fetch WeChat search suggestions.", "required": true, "schema": { "type": "string" } }, { "name": "businessType", "in": "query", "description": "WeChat search business type used to scope suggestion results.\n\nAvailable Values:\n- `ALL`: All\n- `ACCOUNT`: Official accounts\n- `ARTICLE`: Articles\n- `CHANNEL`: Channels\n- `MOMENTS`: Moments\n- `LIVE`: Live\n- `EMOJI`: Emoji\n- `AUDIO`: Audio\n- `BOOK`: Books\n- `WECHAT_INDEX`: WeChat index\n- `NEWS`: News\n- `MINI_PROGRAM`: Mini programs\n- `ENCYCLOPEDIA`: Encyclopedia", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Weixin search business type", "enum": [ "ALL", "ACCOUNT", "ARTICLE", "CHANNEL", "MOMENTS", "LIVE", "EMOJI", "AUDIO", "BOOK", "WECHAT_INDEX", "NEWS", "MINI_PROGRAM", "ENCYCLOPEDIA" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101470", "x-api-version": "v1", "x-search-aliases": [ "WeChat search suggestions API", "WeChat keyword autocomplete", "WeChat related query ideas", "微信搜索建议", "微信关键词联想", "微信搜索补全" ], "x-highlights": [], "x-endpoint-family": "weixin_search_suggestions" } }, "/api/weixin/search-account/v1": { "post": { "tags": [ "WeChat Official Accounts" ], "summary": "Account Search", "description": "Searches WeChat Official Accounts by keyword with page-number pagination and one result per page. Use it to find an account by name or related term before profile or article lookup.", "operationId": "postApiWeixinSearchAccountV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword for WeChat Official Account profiles.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number starting from 1 for WeChat Official Account profile search.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101500", "x-api-version": "v1", "x-search-aliases": [ "WeChat Official Account search", "WeChat account name lookup", "WeChat publisher search by page", "微信公众号搜索", "微信公众账号查询", "公众号名称搜索" ], "x-highlights": [], "x-endpoint-family": "weixin_search_account" } }, "/api/weixin/search-account/v2": { "post": { "tags": [ "WeChat Official Accounts" ], "summary": "Account Search", "description": "Searches WeChat Official Accounts by keyword with page, offset, and continuation-state pagination. Use it to browse broader account results for creator, brand, or publisher discovery.", "operationId": "postApiWeixinSearchAccountV2", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "keyword": { "type": "string", "description": "Search keyword for WeChat Official Account web search." }, "currentPage": { "type": "integer", "format": "int32", "default": 1, "description": "Current page number starting from 1 for WeChat web search pagination." }, "offset": { "type": "integer", "format": "int32", "default": 0, "description": "Search result offset returned by the previous response. Use 0 for the first page." }, "cookies_buffer": { "type": "string", "default": "", "description": "Opaque pagination state returned by the previous WeChat web search response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "keyword", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101510", "x-api-version": "v2", "x-search-aliases": [ "WeChat paginated account search", "WeChat account keyword discovery", "WeChat Official Account finder", "微信公众号分页搜索", "微信账号关键词查询", "公众号品牌搜索" ], "x-highlights": [], "x-endpoint-family": "weixin_search_account" } }, "/api/weixin/get-account-original-count/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Account Original Article Count", "description": "Retrieves the original-article count for a WeChat Official Account identified by ghid or article URL. Use it to compare original publishing activity across known accounts.", "operationId": "getApiWeixinGetAccountOriginalCountV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "ghid", "in": "query", "description": "WeChat Official Account original identifier, using the gh_ prefix returned by WeChat. Use either ghid or url.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "url", "in": "query", "description": "WeChat Official Account article URL used to identify the account. Use either ghid or url.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101600", "x-api-version": "v1", "x-search-aliases": [ "WeChat original article count", "WeChat Official Account originality", "WeChat ghid original posts", "微信公众号原创文章数", "公众号原创内容统计", "微信 ghid 原创文章查询" ], "x-highlights": [], "x-endpoint-family": "weixin_get_account_original_count" } }, "/api/weixin/get-account-principal-info/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Account Principal Info", "description": "Retrieves principal information for a WeChat Official Account identified by biz ID, article URL, or wxid. Use it to review the ownership or operating entity behind a known account.", "operationId": "getApiWeixinGetAccountPrincipalInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "biz", "in": "query", "description": "WeChat Official Account biz id. Use one of biz, url, or wxid.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "url", "in": "query", "description": "WeChat Official Account article URL used to identify the account. Use one of biz, url, or wxid.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "wxid", "in": "query", "description": "WeChat Official Account wxid used to identify the account. Use one of biz, url, or wxid.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101610", "x-api-version": "v1", "x-search-aliases": [ "WeChat Official Account principal info", "WeChat account ownership lookup", "WeChat account operating entity", "微信公众号主体信息", "公众号运营主体查询", "微信账号归属信息" ], "x-highlights": [], "x-endpoint-family": "weixin_get_account_principal_info" } }, "/api/weixin/get-account-basic-info/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Account Basic Info", "description": "Retrieves basic profile information for a WeChat Official Account by account name. Use it to identify or enrich a known account before article, ownership, or publishing research.", "operationId": "getApiWeixinGetAccountBasicInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "WeChat Official Account name used to fetch basic profile information.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101620", "x-api-version": "v1", "x-search-aliases": [ "WeChat Official Account basic info", "WeChat account name lookup", "WeChat publisher profile", "微信公众号基础信息", "公众号名称查询", "微信公众账号资料" ], "x-highlights": [], "x-endpoint-family": "weixin_get_account_basic_info" } }, "/api/weixin/convert-article-link/v1": { "get": { "tags": [ "WeChat Official Accounts" ], "summary": "Article Link Conversion", "description": "Expands a WeChat Official Account article link to its resolved long-form destination. Use it to normalize a short or intermediate link before article lookup or collection.", "operationId": "getApiWeixinConvertArticleLinkV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "link", "in": "query", "description": "WeChat Official Account article short link or intermediate link to convert.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16101700", "x-api-version": "v1", "x-search-aliases": [ "WeChat article link expansion", "WeChat short article link resolver", "WeChat Official Account URL conversion", "微信公众号文章链接转换", "微信文章短链解析", "公众号文章长链接还原" ], "x-highlights": [], "x-endpoint-family": "weixin_convert_article_link" } }, "/api/weixin-channels/search-video/v1": { "post": { "tags": [ "WeChat Channels" ], "summary": "Video Search", "description": "Searches WeChat Channels videos by keyword with publish-time, sort, page, offset, and continuation-state controls. Use it to find recent or ordered video results and continue web-search pages.", "operationId": "postApiWeixinChannelsSearchVideoV1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "keyword": { "type": "string", "description": "Search keyword for WeChat Channels video results." }, "publishTimeType": { "type": "string", "default": "ALL", "description": "WeChat Channels video search publish time filter", "enum": [ "ALL", "ONE_DAY", "SEVEN_DAYS", "HALF_YEAR" ] }, "sortType": { "type": "string", "default": "COMPREHENSIVE", "description": "WeChat Channels video search sort type", "enum": [ "COMPREHENSIVE", "LATEST", "HOT" ] }, "currentPage": { "type": "integer", "format": "int32", "default": 1, "description": "Current page number starting from 1 for WeChat Channels web search pagination." }, "offset": { "type": "integer", "format": "int32", "default": 0, "description": "Search result offset returned by the previous WeChat Channels search response. Use 0 for the first page." }, "cookies_buffer": { "type": "string", "default": "", "description": "Opaque pagination state returned by the previous WeChat Channels web search response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "keyword", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201000", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels video search V1", "Weixin Channels video web search", "WeChat video search with filters", "微信视频号视频搜索 V1", "视频号关键词视频查询", "视频号按时间排序搜索" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_search_video" } }, "/api/weixin-channels/search-video/v2": { "post": { "tags": [ "WeChat Channels" ], "summary": "Video Search", "description": "Searches the WeChat Channels video category by keyword with page, offset, and continuation-state controls. Use it to retrieve categorized video results and continue additional pages.", "operationId": "postApiWeixinChannelsSearchVideoV2", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "keyword": { "type": "string", "description": "Search keyword for categorized WeChat Channels video results." }, "currentPage": { "type": "integer", "format": "int32", "default": 1, "description": "Current page number starting from 1 for WeChat Channels web search pagination." }, "offset": { "type": "integer", "format": "int32", "default": 0, "description": "Search result offset returned by the previous WeChat Channels search response. Use 0 for the first page." }, "cookies_buffer": { "type": "string", "default": "", "description": "Opaque pagination state returned by the previous WeChat Channels web search response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "keyword", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201010", "x-api-version": "v2", "x-search-aliases": [ "WeChat Channels video search V2", "Weixin Channels categorized video search", "WeChat video category keyword search", "微信视频号视频搜索 V2", "视频号分类视频查询", "视频号关键词搜索翻页" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_search_video" } }, "/api/weixin-channels/search-account/v1": { "post": { "tags": [ "WeChat Channels" ], "summary": "Account Search", "description": "Searches the WeChat Channels account category by keyword with page, offset, and continuation-state controls. Use it to discover creator accounts through paginated web-search results.", "operationId": "postApiWeixinChannelsSearchAccountV1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "keyword": { "type": "string", "description": "Search keyword for WeChat Channels account web search." }, "currentPage": { "type": "integer", "format": "int32", "default": 1, "description": "Current page number starting from 1 for WeChat Channels web search pagination." }, "offset": { "type": "integer", "format": "int32", "default": 0, "description": "Search result offset returned by the previous WeChat Channels account search response. Use 0 for the first page." }, "cookies_buffer": { "type": "string", "default": "", "description": "Opaque pagination state returned by the previous WeChat Channels account search response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "keyword", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201100", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels account search V1", "Weixin Channels creator web search", "WeChat account keyword search", "微信视频号账号搜索 V1", "视频号创作者查询", "视频号账号关键词搜索" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_search_account" } }, "/api/weixin-channels/search-account/v2": { "post": { "tags": [ "WeChat Channels" ], "summary": "Account Search", "description": "Searches WeChat Channels account-related records by keyword using the direct Channels lookup. Use it to discover creator accounts and related channel objects without pagination input.", "operationId": "postApiWeixinChannelsSearchAccountV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword used to find WeChat Channels accounts and related video objects.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201110", "x-api-version": "v2", "x-search-aliases": [ "WeChat Channels account search V2", "Weixin Channels direct account lookup", "WeChat creator and video object search", "微信视频号账号搜索 V2", "视频号账号直接查询", "视频号创作者和视频对象搜索" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_search_account" } }, "/api/weixin-channels/search-account/v3": { "post": { "tags": [ "WeChat Channels" ], "summary": "Account Search", "description": "Looks up a specific WeChat Channels account identity by keyword. Use it to resolve a creator name or account term to the identifier required by account-video queries.", "operationId": "postApiWeixinChannelsSearchAccountV3", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword used to resolve a WeChat Channels account id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201120", "x-api-version": "v3", "x-search-aliases": [ "WeChat Channels account search V3", "Weixin Channels account ID lookup", "WeChat creator identifier resolution", "微信视频号账号搜索 V3", "视频号账号 ID 查询", "视频号创作者标识解析" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_search_account" } }, "/api/weixin-channels/get-account-videos/v1": { "post": { "tags": [ "WeChat Channels" ], "summary": "Account Videos", "description": "Retrieves a paginated WeChat Channels account feed by v2Name with continuation-buffer support. Use it to browse videos and other feed entries published by a known creator account.", "operationId": "postApiWeixinChannelsGetAccountVideosV1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "v2Name": { "type": "string", "description": "WeChat Channels account unique id, usually ending with @finder." }, "last_buffer": { "type": "string", "default": "", "description": "Pagination buffer returned by the previous WeChat Channels account videos response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "token", "v2Name" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201200", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels account videos", "Weixin Channels creator feed", "WeChat videos by v2Name", "微信视频号账号视频", "视频号创作者作品列表", "视频号 v2Name 视频查询" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_get_account_videos" } }, "/api/weixin-channels/get-bound-channel/v1": { "get": { "tags": [ "WeChat Channels" ], "summary": "Get Bound Channel", "description": "Finds the WeChat Channels account bound to a WeChat Official Account using either its original ID or an article URL. Use it to connect an official account with its Channels identity.", "operationId": "getApiWeixinChannelsGetBoundChannelV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "ghid", "in": "query", "description": "WeChat Official Account original id used to find the bound WeChat Channels account. Use either ghid or url.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "url", "in": "query", "description": "WeChat Official Account article URL used to find the bound WeChat Channels account. Use either ghid or url.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201300", "x-api-version": "v1", "x-search-aliases": [ "WeChat Official Account bound Channel", "Weixin ghid to Channels account", "WeChat article to Channels creator", "微信公众号绑定视频号", "微信原始 ID 查询视频号", "公众号文章查视频号" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_get_bound_channel" } }, "/api/weixin-channels/get-video-basic-info/v1": { "get": { "tags": [ "WeChat Channels" ], "summary": "Video Basic Info", "description": "Resolves a copied WeChat Channels video link, preview URL, or short feed ID to basic video information. Use it to identify a shared Channels video before further lookups.", "operationId": "getApiWeixinChannelsGetVideoBasicInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "feedInfo", "in": "query", "description": "WeChat Channels copied video link, finder-preview URL, or short feed id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201400", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels video basic info", "Weixin video link lookup", "WeChat Channels feed ID resolution", "微信视频号基础信息", "视频号链接解析", "视频号 feed ID 查询" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_get_video_basic_info" } }, "/api/weixin-channels/get-video-title/v1": { "get": { "tags": [ "WeChat Channels" ], "summary": "Video Title", "description": "Retrieves lightweight title information for a WeChat Channels video by object ID and optional nonce ID. Use it to identify known video content without requesting downloadable media.", "operationId": "getApiWeixinChannelsGetVideoTitleV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "objectId", "in": "query", "description": "WeChat Channels video object id.", "required": true, "schema": { "type": "string" } }, { "name": "objectNonceId", "in": "query", "description": "Optional WeChat Channels object nonce id. Supplying it can improve lookup accuracy.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201410", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels video title", "Weixin video title lookup", "WeChat object ID metadata", "微信视频号标题查询", "视频号 objectId 基础信息", "视频号轻量元数据" ], "x-highlights": [ { "type": "warning", "kind": "LIMITATION", "content": "This endpoint does not return downloadable media links.", "concept": "video_download", "aliases": [ "video download", "downloadable media", "下载视频", "视频下载链接" ] } ], "x-endpoint-family": "weixin_channels_get_video_title" } }, "/api/weixin-channels/convert-export-id/v1": { "get": { "tags": [ "WeChat Channels" ], "summary": "Export Id Conversion", "description": "Converts an encrypted WeChat Channels export ID from search results into a usable video object identity. Use it to prepare the identifier required by video lookup endpoints.", "operationId": "getApiWeixinChannelsConvertExportIdV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "exportId", "in": "query", "description": "Encrypted WeChat Channels exportId returned by video search results.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201420", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels export ID conversion", "Weixin exportId to objectId", "WeChat encrypted video ID resolution", "微信视频号 exportId 转换", "视频号加密 ID 解析", "视频号 exportId 转 objectId" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_convert_export_id" } }, "/api/weixin-channels/get-video-download-url/v1": { "get": { "tags": [ "WeChat Channels" ], "summary": "Video Download URL", "description": "Retrieves a downloadable media URL for a WeChat Channels video by object ID and optional nonce ID. Use it to download or play media from a known Channels video.", "operationId": "getApiWeixinChannelsGetVideoDownloadUrlV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "objectId", "in": "query", "description": "WeChat Channels video object id used to fetch downloadable media links.", "required": true, "schema": { "type": "string" } }, { "name": "objectNonceId", "in": "query", "description": "Optional WeChat Channels object nonce id. Supplying it can improve media lookup accuracy.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201430", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels video download URL", "download Weixin Channels video", "WeChat video media link", "微信视频号下载链接", "下载视频号视频", "视频号媒体地址" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_get_video_download_url" } }, "/api/weixin-channels/get-video-metrics/v1": { "post": { "tags": [ "WeChat Channels" ], "summary": "Video Metrics", "description": "Retrieves interaction metrics for a WeChat Channels video by object ID with optional continuation-buffer input. Use it to review engagement for known video content.", "operationId": "postApiWeixinChannelsGetVideoMetricsV1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "objectId": { "type": "string", "description": "WeChat Channels video object id used to fetch interaction metrics." }, "objectNonceId": { "type": "string", "default": "", "description": "Optional WeChat Channels object nonce id." }, "last_buffer": { "type": "string", "default": "", "description": "Pagination buffer returned by the previous WeChat Channels metrics response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "objectId", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201500", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels video metrics", "Weixin video engagement", "WeChat object ID interaction data", "微信视频号互动数据", "视频号视频指标", "视频号 objectId 互动查询" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_get_video_metrics" } }, "/api/weixin-channels/get-video-comment/v1": { "post": { "tags": [ "WeChat Channels" ], "summary": "Video Comments", "description": "Retrieves first-level comments for a WeChat Channels video by object ID with continuation-buffer pagination. Use it to review audience discussion on known video content.", "operationId": "postApiWeixinChannelsGetVideoCommentV1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "objectId": { "type": "string", "description": "WeChat Channels video object id used to fetch first-level comments. If you only have the exportId returned by a video search result, first call the Export Id Conversion (V1) endpoint at /api/weixin-channels/convert-export-id/v1 to convert it to an objectId." }, "objectNonceId": { "type": "string", "default": "", "description": "Optional WeChat Channels object nonce id." }, "last_buffer": { "type": "string", "default": "", "description": "Pagination buffer returned by the previous first-level WeChat Channels comment response. Leave it empty for the first page. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "objectId", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201600", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels video comments", "Weixin first-level comments", "WeChat object ID comment list", "微信视频号视频评论", "视频号一级评论", "视频号 objectId 评论列表" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_get_video_comment" } }, "/api/weixin-channels/get-video-sub-comment/v1": { "post": { "tags": [ "WeChat Channels" ], "summary": "Video Sub Comments", "description": "Retrieves replies under a first-level WeChat Channels video comment using the video and root-comment IDs. Use it to continue a threaded comment discussion with buffer pagination.", "operationId": "postApiWeixinChannelsGetVideoSubCommentV1", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Access token for this API service." }, "objectId": { "type": "string", "description": "WeChat Channels video object id used to fetch second-level comment replies." }, "rootCommentId": { "type": "string", "description": "Root first-level comment id returned by the WeChat Channels video comments endpoint." }, "last_buffer": { "type": "string", "default": "", "description": "Pagination buffer for WeChat Channels second-level comment replies. Use the first-level comment's last_buffer for the first reply page when present. For this POST endpoint, send it in an application/x-www-form-urlencoded form body." } }, "required": [ "objectId", "rootCommentId", "token" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16201610", "x-api-version": "v1", "x-search-aliases": [ "WeChat Channels comment replies", "Weixin video sub comments", "WeChat root comment replies", "微信视频号评论回复", "视频号二级评论", "视频号根评论回复" ], "x-highlights": [], "x-endpoint-family": "weixin_channels_get_video_sub_comment" } }, "/api/qq-huxuan/cgi-bin/advertiser/finder_publisher/search/v1": { "get": { "tags": [ "QQ Huxuan Creator Marketplace" ], "summary": "Video Account Creator Search", "description": "Searches or browses QQ Huxuan Video Account creators by optional nickname keyword with page-number pagination. Use it to discover and shortlist video creators for Tencent Huxuan campaign planning.", "operationId": "getApiQqHuxuanCgiBinAdvertiserFinderPublisherSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Creator nickname keyword. Leave empty to browse the default marketplace list.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "Page number. The first page is 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16250100", "x-api-version": "v1", "x-search-aliases": [ "QQ Huxuan Video Account creator search", "Tencent Huxuan video creator discovery", "WeChat Channels creator marketplace search", "腾讯互选视频号达人搜索", "QQ 互选视频号博主查询", "腾讯视频号创作者筛选" ], "x-highlights": [], "x-endpoint-family": "qq_huxuan_cgi_bin_advertiser_finder_publisher_search" } }, "/api/qq-huxuan/cgi-bin/advertiser/mp_publisher/search/v1": { "get": { "tags": [ "QQ Huxuan Creator Marketplace" ], "summary": "Official Account Creator Search", "description": "Searches or browses QQ Huxuan Official Account creators by optional nickname or account keyword with page-number pagination. Use it to discover and shortlist publishers for Tencent Huxuan campaign planning.", "operationId": "getApiQqHuxuanCgiBinAdvertiserMpPublisherSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Creator nickname or account keyword. Leave empty to browse the default marketplace list.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "Page number. The first page is 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16250200", "x-api-version": "v1", "x-search-aliases": [ "QQ Huxuan Official Account creator search", "Tencent Huxuan publisher discovery", "WeChat Official Account creator marketplace", "腾讯互选公众号达人搜索", "QQ 互选公众号博主查询", "微信公众号创作者筛选" ], "x-highlights": [], "x-endpoint-family": "qq_huxuan_cgi_bin_advertiser_mp_publisher_search" } }, "/api/qq-huxuan/cgi-bin/advertiser/finder_publisher/detail/v1": { "get": { "tags": [ "QQ Huxuan Creator Marketplace" ], "summary": "Video Account Creator Details", "description": "Retrieves QQ Huxuan Video Account creator details for a known creator app ID. Use it to review a shortlisted video creator before Tencent Huxuan campaign selection.", "operationId": "getApiQqHuxuanCgiBinAdvertiserFinderPublisherDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "appId", "in": "query", "description": "Video Account creator app ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16250300", "x-api-version": "v1", "x-search-aliases": [ "QQ Huxuan Video Account creator details", "Tencent Huxuan video creator profile", "WeChat Channels creator lookup", "腾讯互选视频号达人详情", "QQ 互选视频号博主资料", "微信视频号创作者查询" ], "x-highlights": [], "x-endpoint-family": "qq_huxuan_cgi_bin_advertiser_finder_publisher_detail" } }, "/api/qq-huxuan/cgi-bin/advertiser/finder_publisher/get_finder_video_show/v1": { "get": { "tags": [ "QQ Huxuan Creator Marketplace" ], "summary": "Video Account Recent Videos", "description": "Lists videos from a QQ Huxuan Video Account creator within a required date range, with a choice of all, Huxuan order, hot, or personal videos. Use it to review a shortlisted creator's content for campaign planning.", "operationId": "getApiQqHuxuanCgiBinAdvertiserFinderPublisherGetFinderVideoShowV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "appId", "in": "query", "description": "Video Account creator app ID.", "required": true, "schema": { "type": "string" } }, { "name": "videoType", "in": "query", "description": "Tencent Huxuan video type filter.\n\nAvailable Values:\n- `ALL`: All videos\n- `ORDER`: QQ Huxuan order videos\n- `HOT`: Hot videos\n- `PERSON`: Personal videos", "required": false, "schema": { "type": "string", "default": "ALL", "description": "QQ Huxuan Video Account recent video type filter", "enum": [ "ALL", "ORDER", "HOT", "PERSON" ] } }, { "name": "beginDate", "in": "query", "description": "Start date in yyyyMMdd format.", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "End date in yyyyMMdd format.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number. The first page is 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16250400", "x-api-version": "v1", "x-search-aliases": [ "QQ Huxuan Video Account recent videos", "Tencent Huxuan creator video list", "WeChat Channels campaign video search", "腾讯互选视频号作品列表", "QQ 互选达人近期视频", "微信视频号投放作品查询" ], "x-highlights": [], "x-endpoint-family": "qq_huxuan_cgi_bin_advertiser_finder_publisher_get_finder_video_show" } }, "/api/qq-huxuan/cgi-bin/advertiser/mp_publisher/detail/v1": { "get": { "tags": [ "QQ Huxuan Creator Marketplace" ], "summary": "Official Account Creator Details", "description": "Retrieves QQ Huxuan Official Account creator details for a known creator app ID. Use it to review a shortlisted publisher before Tencent Huxuan campaign selection.", "operationId": "getApiQqHuxuanCgiBinAdvertiserMpPublisherDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "appId", "in": "query", "description": "Official Account creator app ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16250500", "x-api-version": "v1", "x-search-aliases": [ "QQ Huxuan Official Account creator details", "Tencent Huxuan publisher profile", "WeChat Official Account creator lookup", "腾讯互选公众号达人详情", "QQ 互选公众号博主资料", "微信公众号创作者查询" ], "x-highlights": [], "x-endpoint-family": "qq_huxuan_cgi_bin_advertiser_mp_publisher_detail" } }, "/api/qq-huxuan/cgi-bin/advertiser/mp_publisher/get_user_articles/v1": { "get": { "tags": [ "QQ Huxuan Creator Marketplace" ], "summary": "Official Account Article List", "description": "Lists articles from a QQ Huxuan Official Account creator within a required date range, with an optional title keyword and a choice between all articles and Huxuan order articles. Use it to review a publisher's content for campaign planning.", "operationId": "getApiQqHuxuanCgiBinAdvertiserMpPublisherGetUserArticlesV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "appId", "in": "query", "description": "Official Account creator app ID.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Article title keyword. Leave empty to return all matched articles.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "articleType", "in": "query", "description": "Tencent Huxuan article type filter.\n\nAvailable Values:\n- `ALL`: All articles\n- `ORDER`: QQ Huxuan order articles", "required": false, "schema": { "type": "string", "default": "ALL", "description": "QQ Huxuan Official Account article type filter", "enum": [ "ALL", "ORDER" ] } }, { "name": "startDate", "in": "query", "description": "Start date in yyyyMMdd format.", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "End date in yyyyMMdd format.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number. The first page is 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "16250600", "x-api-version": "v1", "x-search-aliases": [ "QQ Huxuan Official Account articles", "Tencent Huxuan publisher article list", "WeChat Official Account campaign articles", "腾讯互选公众号文章列表", "QQ 互选博主文章查询", "微信公众号投放文章筛选" ], "x-highlights": [], "x-endpoint-family": "qq_huxuan_cgi_bin_advertiser_mp_publisher_get_user_articles" } }, "/api/weibo/search-all/v2": { "get": { "tags": [ "Weibo" ], "summary": "Keyword Search", "description": "Searches Weibo posts by keyword within a required day-and-hour time range, with page-based pagination, hot or time sorting, and filters for pictures, video, music, or links. Use it to find time-bounded posts for topic research or monitoring.", "operationId": "getApiWeiboSearchAllV2", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Search Keywords.", "required": true, "schema": { "type": "string" } }, { "name": "startDay", "in": "query", "description": "Start Day (yyyy-MM-dd).", "required": true, "schema": { "type": "string" } }, { "name": "startHour", "in": "query", "description": "Start Hour (0-23).", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "endDay", "in": "query", "description": "End Day (yyyy-MM-dd).", "required": true, "schema": { "type": "string" } }, { "name": "endHour", "in": "query", "description": "End Hour (0-23).", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "hotSort", "in": "query", "description": "Hot sort, true for hot sort, false for time sort. Default is false.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "contains", "in": "query", "description": "Contains filter for the result set.\n\nAvailable Values:\n- `ALL`: All\n- `PICTURE`: Has Picture\n- `VIDEO`: Has Video\n- `MUSIC`: Has Music\n- `LINK`: Has Link", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Contains", "enum": [ "ALL", "PICTURE", "VIDEO", "MUSIC", "LINK" ] } }, { "name": "page", "in": "query", "description": "Page number, starting with 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001000", "x-api-version": "v2", "x-search-aliases": [ "Weibo advanced post search", "Weibo time range search", "Weibo media-filtered search", "微博高级搜索", "微博时间范围搜索", "微博按图片视频筛选" ], "x-highlights": [], "x-endpoint-family": "weibo_search_all" } }, "/api/weibo/get-weibo-detail/v1": { "get": { "tags": [ "Weibo" ], "summary": "Post Details", "description": "Retrieves details for a Weibo post identified by its post ID. Use it to look up a known post for content review, archiving, or related engagement analysis.", "operationId": "getApiWeiboGetWeiboDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Weibo post ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001100", "x-api-version": "v1", "x-search-aliases": [ "Weibo post details API", "Weibo status ID lookup", "Weibo post ID query", "微博博文详情", "微博状态 ID 查询", "微博帖子 ID 查询" ], "x-highlights": [], "x-endpoint-family": "weibo_get_weibo_detail" } }, "/api/weibo/get-user-detail/v3": { "get": { "tags": [ "Weibo" ], "summary": "User Profile", "description": "Retrieves a Weibo user profile identified by UID. Use it to look up a known account for creator research, profile review, or subsequent retrieval of that user's posts and videos.", "operationId": "getApiWeiboGetUserDetailV3", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "Weibo User ID (UID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001200", "x-api-version": "v3", "x-search-aliases": [ "Weibo user profile API", "Weibo UID lookup", "Weibo creator profile", "微博用户资料", "微博 UID 查询", "微博博主信息" ], "x-highlights": [], "x-endpoint-family": "weibo_get_user_detail" } }, "/api/weibo/get-fans/v1": { "get": { "tags": [ "Weibo" ], "summary": "User Fans", "description": "Retrieves a page of fan accounts that follow a Weibo user identified by UID. Use it to browse the account's follower audience or continue through its fan list.", "operationId": "getApiWeiboGetFansV1", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "Weibo User ID (UID).", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number, starting with 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001300", "x-api-version": "v1", "x-search-aliases": [ "Weibo user fans API", "Weibo follower list", "Weibo fans by UID", "微博用户粉丝列表", "微博关注该用户的人", "微博 UID 粉丝查询" ], "x-highlights": [], "x-endpoint-family": "weibo_get_fans" } }, "/api/weibo/get-followers/v1": { "get": { "tags": [ "Weibo" ], "summary": "User Followers", "description": "Retrieves a page of accounts followed by a Weibo user identified by UID. Use it to examine the account's outgoing follow network or continue through its following list.", "operationId": "getApiWeiboGetFollowersV1", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "Weibo User ID (UID).", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number, starting with 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001400", "x-api-version": "v1", "x-search-aliases": [ "Weibo user following API", "Weibo accounts followed by user", "Weibo following list", "微博用户关注列表", "微博关注的人", "微博 UID 关注查询" ], "x-highlights": [], "x-endpoint-family": "weibo_get_followers" } }, "/api/weibo/get-user-post/v1": { "get": { "tags": [ "Weibo" ], "summary": "User Published Posts", "description": "Retrieves posts published by a Weibo user identified by UID, using page numbers and a required sinceId cursor after the first page. Use it to browse an account's posting history or continue through its post feed.", "operationId": "getApiWeiboGetUserPostV1", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "Weibo User ID (UID).", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number, starting with 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "sinceId", "in": "query", "description": "Pagination cursor (since_id). Required if page > 1.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001500", "x-api-version": "v1", "x-search-aliases": [ "Weibo user posts API", "Weibo profile post list", "Weibo UID posts", "微博用户发布博文", "微博博主帖子列表", "微博 UID 博文查询" ], "x-highlights": [], "x-endpoint-family": "weibo_get_user_post" } }, "/api/weibo/get-user-video-list/v1": { "get": { "tags": [ "Weibo" ], "summary": "User Video List", "description": "Retrieves a Weibo user's video waterfall feed by UID, with an optional cursor from a prior response. Use it to browse videos published by a known account or continue through its video feed.", "operationId": "getApiWeiboGetUserVideoListV1", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "Weibo User ID (UID).", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor returned by the previous response.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001510", "x-api-version": "v1", "x-search-aliases": [ "Weibo user videos API", "Weibo profile video feed", "Weibo UID video list", "微博用户视频列表", "微博博主视频瀑布流", "微博 UID 视频查询" ], "x-highlights": [], "x-endpoint-family": "weibo_get_user_video_list" } }, "/api/weibo/tv-component/v1": { "get": { "tags": [ "Weibo" ], "summary": "TV Video Details", "description": "Retrieves Weibo TV video details for a colon-delimited object ID (OID). Use it to look up a known TV video for content review, cataloging, or downstream processing.", "operationId": "getApiWeiboTvComponentV1", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "oid", "in": "query", "description": "Weibo video/object ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001600", "x-api-version": "v1", "x-search-aliases": [ "Weibo TV video details API", "Weibo OID video lookup", "Weibo TV component lookup", "微博 TV 视频详情", "微博 OID 视频查询", "微博视频组件查询" ], "x-highlights": [], "x-endpoint-family": "weibo_tv_component" } }, "/api/weibo/hot-search/v1": { "get": { "tags": [ "Weibo" ], "summary": "Hot Search", "description": "Retrieves the current Weibo hot-search ranking. Use it to identify trending topics for newsroom monitoring, content planning, or timely topic discovery.", "operationId": "getApiWeiboHotSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001700", "x-api-version": "v1", "x-search-aliases": [ "Weibo hot search API", "Weibo trending topics", "Weibo hot-search ranking", "微博热搜榜", "微博热门话题", "微博实时热点" ], "x-highlights": [], "x-endpoint-family": "weibo_hot_search" } }, "/api/weibo/get-post-comments/v1": { "get": { "tags": [ "Weibo" ], "summary": "Post Comments", "description": "Retrieves comments for a Weibo post identified by MID, with optional maxId cursor pagination and time or hot sorting. Use it to review audience discussion, continue through comment pages, or support moderation and feedback analysis.", "operationId": "getApiWeiboGetPostCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "mid", "in": "query", "description": "Weibo post mid.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `TIME`: Time\n- `HOT`: Hot", "required": false, "schema": { "type": "string", "default": "TIME", "description": "Post Comments Sort", "enum": [ "TIME", "HOT" ] } }, { "name": "maxId", "in": "query", "description": "Pagination cursor returned by the previous response.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001800", "x-api-version": "v1", "x-search-aliases": [ "Weibo post comments API", "Weibo MID comments", "Weibo sorted comment list", "微博博文评论", "微博 MID 评论查询", "微博评论时间热度排序" ], "x-highlights": [], "x-endpoint-family": "weibo_get_post_comments" } }, "/api/weibo/search-profile/v1": { "get": { "tags": [ "Weibo" ], "summary": "Search User Published Posts", "description": "Searches posts published by a specific Weibo user, using a keyword, optional date range, and page-based pagination. Use it to find historical posts from a known account for topic research or campaign review.", "operationId": "getApiWeiboSearchProfileV1", "parameters": [ { "name": "token", "in": "query", "description": "API access token.", "required": true, "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "Weibo User ID (UID).", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Search Keywords.", "required": true, "schema": { "type": "string" } }, { "name": "startDay", "in": "query", "description": "Start Day (yyyy-MM-dd).", "required": false, "schema": { "type": "string" } }, { "name": "endDay", "in": "query", "description": "End Day (yyyy-MM-dd).", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number, starting with 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "17001900", "x-api-version": "v1", "x-search-aliases": [ "Weibo profile post search", "Weibo user post keyword search", "Weibo UID history search", "微博用户主页搜索", "微博博主博文搜索", "微博 UID 历史帖子查询" ], "x-highlights": [], "x-endpoint-family": "weibo_search_profile" } }, "/api/bilibili/get-video-detail/v2": { "get": { "tags": [ "Bilibili" ], "summary": "Video Details", "description": "Retrieves details for a Bilibili video identified by its BVID. Use it to look up a known video for content review, cataloging, or subsequent engagement analysis.", "operationId": "getApiBilibiliGetVideoDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API.", "required": true, "schema": { "type": "string" } }, { "name": "bvid", "in": "query", "description": "Bilibili Video ID (BVID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 18001000, "x-api-version": "v2", "x-search-aliases": [ "Bilibili video details API", "Bilibili BVID lookup", "Bilibili video information", "哔哩哔哩视频详情", "B站 BV号查询", "B站视频信息" ], "x-highlights": [], "x-endpoint-family": "bilibili_get_video_detail" } }, "/api/bilibili/get-user-video-list/v2": { "get": { "tags": [ "Bilibili" ], "summary": "User Published Videos", "description": "Retrieves videos published by a Bilibili user identified by UID, with an optional continuation parameter from a prior response. Use it to browse a creator's uploads or continue through their video list.", "operationId": "getApiBilibiliGetUserVideoListV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API.", "required": true, "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "Bilibili User ID (UID).", "required": true, "schema": { "type": "string" } }, { "name": "param", "in": "query", "description": "Pagination parameter from previous response.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 18001100, "x-api-version": "v2", "x-search-aliases": [ "Bilibili user videos API", "Bilibili creator uploads", "Bilibili UID video list", "哔哩哔哩用户视频", "B站 UP主投稿列表", "B站 UID作品查询" ], "x-highlights": [], "x-endpoint-family": "bilibili_get_user_video_list" } }, "/api/bilibili/get-user-detail/v2": { "get": { "tags": [ "Bilibili" ], "summary": "User Profile", "description": "Retrieves a Bilibili user profile identified by UID. Use it to look up a known account for creator research, profile review, or subsequent retrieval of that user's videos.", "operationId": "getApiBilibiliGetUserDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API.", "required": true, "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "Bilibili User ID (UID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 18001200, "x-api-version": "v2", "x-search-aliases": [ "Bilibili user profile API", "Bilibili UID lookup", "Bilibili creator profile", "哔哩哔哩用户资料", "B站 UID查询", "B站 UP主信息" ], "x-highlights": [], "x-endpoint-family": "bilibili_get_user_detail" } }, "/api/bilibili/get-video-danmu/v2": { "get": { "tags": [ "Bilibili" ], "summary": "Video Danmaku", "description": "Retrieves one page of danmaku comments for a Bilibili video segment identified by AID and CID. Use it to review time-synchronized audience reactions or page through danmaku for a known video.", "operationId": "getApiBilibiliGetVideoDanmuV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API.", "required": true, "schema": { "type": "string" } }, { "name": "aid", "in": "query", "description": "Bilibili Archive ID (AID).", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "query", "description": "Bilibili Chat ID (CID).", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 18001300, "x-api-version": "v2", "x-search-aliases": [ "Bilibili video danmaku API", "Bilibili bullet comments", "Bilibili AID CID danmaku", "哔哩哔哩视频弹幕", "B站弹幕查询", "B站 AID CID弹幕" ], "x-highlights": [], "x-endpoint-family": "bilibili_get_video_danmu" } }, "/api/bilibili/get-video-comment/v2": { "get": { "tags": [ "Bilibili" ], "summary": "Video Comments", "description": "Retrieves comments for a Bilibili video identified by AID, with optional cursor pagination. Use it to review audience discussion, continue through comment pages, or support comment moderation and analysis.", "operationId": "getApiBilibiliGetVideoCommentV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API.", "required": true, "schema": { "type": "string" } }, { "name": "aid", "in": "query", "description": "Bilibili Archive ID (AID).", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 18001400, "x-api-version": "v2", "x-search-aliases": [ "Bilibili video comments API", "Bilibili comment list", "Bilibili AID comments", "哔哩哔哩视频评论", "B站评论列表", "B站 AID评论查询" ], "x-highlights": [], "x-endpoint-family": "bilibili_get_video_comment" } }, "/api/bilibili/search-video/v2": { "get": { "tags": [ "Bilibili" ], "summary": "Video Search", "description": "Searches Bilibili videos by keyword with page-based pagination and sorting by general ranking, play count, publish time, danmaku count, or favorites. Use it to support content discovery, topic research, or ranking-focused searches.", "operationId": "getApiBilibiliSearchVideoV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Sorting criteria for search results.\n\nAvailable Values:\n- `general`: General\n- `click`: Most Played\n- `pubdate`: Latest\n- `dm`: Most Danmaku\n- `stow`: Most Favorite", "required": false, "schema": { "type": "string", "default": "general", "description": "Bilibili Video Search Order Criteria", "enum": [ "general", "click", "pubdate", "dm", "stow" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 18001500, "x-api-version": "v2", "x-search-aliases": [ "Bilibili video search API", "Bilibili keyword video search", "Bilibili sorted video search", "哔哩哔哩视频搜索", "B站关键词搜视频", "B站视频排序查询" ], "x-highlights": [], "x-endpoint-family": "bilibili_search_video" } }, "/api/bilibili/share-url-transfer/v1": { "get": { "tags": [ "Bilibili" ], "summary": "Share Link Resolution", "description": "Resolve a supported Bilibili short share link that targets a video and return its public redirect URL. Use it to expand video links before subsequent Bilibili content lookup or processing.", "operationId": "getApiBilibiliShareUrlTransferV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API.", "required": true, "schema": { "type": "string" } }, { "name": "shareUrl", "in": "query", "description": "A Bilibili short share URL beginning with https://b23.tv/.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 18001600, "x-api-version": "v1", "x-search-aliases": [ "Bilibili short link resolution", "Bilibili video share link expansion", "Bilibili redirect URL", "哔哩哔哩短链解析", "B站短链解析", "B站视频分享链接解析" ], "x-highlights": [ { "type": "warning", "kind": "LIMITATION", "title": "Video Links Only", "content": "This endpoint does not support share links that resolve to non-video destinations.", "concept": "non_video_share_link_resolution", "aliases": [ "non-video share link", "non-video short link", "article link", "dynamic post link", "profile link", "live link", "bangumi link", "非视频分享链接", "非视频短链", "专栏链接", "专栏短链", "动态链接", "动态短链", "主页链接", "主页短链", "直播链接", "直播短链", "番剧链接", "番剧短链" ] } ], "x-endpoint-family": "bilibili_share_url_transfer" } }, "/api/bilibili/get-user-relation-stat/v1": { "get": { "tags": [ "Bilibili" ], "summary": "User Relation Stats", "description": "Retrieves relation statistics for a Bilibili user identified by WMID. Use it to compare audience relationships across creator accounts or track relation-count changes for a known user.", "operationId": "getApiBilibiliGetUserRelationStatV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API.", "required": true, "schema": { "type": "string" } }, { "name": "wmid", "in": "query", "description": "Bilibili User ID (WMID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 18001700, "x-api-version": "v1", "x-search-aliases": [ "Bilibili user relation stats API", "Bilibili WMID relation lookup", "Bilibili follower statistics", "哔哩哔哩用户关系数据", "B站关注粉丝统计", "B站 WMID查询" ], "x-highlights": [], "x-endpoint-family": "bilibili_get_user_relation_stat" } }, "/api/bilibili/get-video-caption/v2": { "get": { "tags": [ "Bilibili" ], "summary": "Video Captions", "description": "Retrieves caption data for a Bilibili video segment identified by BVID, AID, and CID. Use it to obtain subtitles for transcript extraction, accessibility review, or language-focused content analysis.", "operationId": "getApiBilibiliGetVideoCaptionV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API.", "required": true, "schema": { "type": "string" } }, { "name": "bvid", "in": "query", "description": "Bilibili Video ID (BVID).", "required": true, "schema": { "type": "string" } }, { "name": "aid", "in": "query", "description": "Bilibili AID.", "required": true, "schema": { "type": "string" } }, { "name": "cid", "in": "query", "description": "Bilibili CID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 18001800, "x-api-version": "v2", "x-search-aliases": [ "Bilibili video captions API", "Bilibili subtitle lookup", "Bilibili BVID AID CID captions", "哔哩哔哩视频字幕", "B站字幕查询", "B站视频文稿提取" ], "x-highlights": [], "x-endpoint-family": "bilibili_get_video_caption" } }, "/api/dewu/search-item-list/v1": { "get": { "tags": [ "Dewu (Poizon)" ], "summary": "Product Search", "description": "Searches Dewu (Poizon) products by keyword with page-based pagination. Use it to discover marketplace products matching a title or product term.", "operationId": "getApiDewuSearchItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination. The first page is 1.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": "18951000", "x-api-version": "v1", "x-search-aliases": [ "Dewu product search", "Poizon keyword search", "Dewu marketplace products", "得物商品搜索", "得物关键词查询", "毒 App 商品搜索" ], "x-highlights": [], "x-endpoint-family": "dewu_search_item_list" } }, "/api/jd/get-item-detail/v1": { "get": { "tags": [ "JD.com" ], "summary": "Product Details", "description": "Retrieve JD.com product details for a known item ID. Use it to inspect an individual product after finding its identifier.", "operationId": "getApiJdGetItemDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "A unique product identifier on JD.com (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001000", "x-api-version": "v1", "x-search-aliases": [ "JD.com product details", "JD product lookup", "JD item details", "京东商品详情", "京东商品查询", "京东商品信息" ], "x-highlights": [], "x-endpoint-family": "jd_get_item_detail" } }, "/api/jd/get-item-detail/v2": { "get": { "tags": [ "JD.com" ], "summary": "Product Details", "description": "Access the asynchronous JD.com product detail workflow from the Just One API dashboard Task Management page. Use it to submit and download product detail research tasks.", "operationId": "getApiJdGetItemDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "A unique product identifier on JD.com (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001025", "x-api-version": "v2", "x-search-aliases": [ "JD.com asynchronous product details", "JD product detail task", "JD dashboard product task", "京东异步商品详情", "京东商品详情任务", "京东后台商品任务" ], "x-highlights": [ { "type": "danger", "kind": "LIMITATION", "content": "Direct calls to this endpoint do not fetch product data.", "concept": "direct_api_call", "aliases": [ "direct API call", "synchronous API call", "直接调用", "同步调用" ] }, { "type": "info", "kind": "GUIDANCE", "content": "Submit the task, wait for completion, and download the result from the Just One API dashboard Task Management page: https://dashboard.justoneapi.com/en/dashboard/task-records or https://dashboard.justoneapi.com/zh/dashboard/task-records." } ], "x-endpoint-family": "jd_get_item_detail" } }, "/api/jd/get-item-detail/v3": { "get": { "tags": [ "JD.com" ], "summary": "Product Details", "description": "Retrieves JD.com product details for a known item ID. Use it to review a known listing during product research or offer comparison.", "operationId": "getApiJdGetItemDetailV3", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "A unique product identifier on JD.com (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001030", "x-api-version": "v3", "x-search-aliases": [ "JD.com product details", "JD item ID lookup", "JD listing lookup", "京东商品详情", "京东商品 ID 查询", "京东商品查询" ], "x-highlights": [ { "type": "tip", "kind": "CAPABILITY", "content": "This endpoint can retrieve available coupons.", "concept": "available_coupons", "aliases": [ "available coupons", "coupon list", "可用优惠券", "优惠券" ] }, { "type": "tip", "kind": "CAPABILITY", "content": "This endpoint can retrieve the price after applying coupons.", "concept": "post_coupon_price", "aliases": [ "price after coupon", "post-coupon price", "券后价", "优惠券后价格" ] }, { "type": "tip", "kind": "CONDITION", "content": "Some products may not be available through this endpoint.", "concept": "product_coverage", "aliases": [ "product coverage", "supported products", "商品覆盖", "支持商品" ] } ], "x-endpoint-family": "jd_get_item_detail" } }, "/api/jd/get-item-detail/v4": { "get": { "tags": [ "JD.com" ], "summary": "Product Details", "description": "Retrieves JD.com product details by item ID through the V4 endpoint. Use it to perform direct product lookup for catalog research, product monitoring, or ecommerce analysis.", "operationId": "getApiJdGetItemDetailV4", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "A unique product identifier on JD.com (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001040", "x-api-version": "v4", "x-search-aliases": [ "JD.com product details v4", "JD item detail lookup v4", "JD product information API v4", "京东商品详情 V4", "京东商品 ID 查询 V4", "京东商品查询 V4" ], "x-highlights": [], "x-endpoint-family": "jd_get_item_detail" } }, "/api/jd/get-item-price/v1": { "get": { "tags": [ "JD.com" ], "summary": "Product Price", "description": "Retrieve the current JD.com product price for a known item ID. Use it to check a product's price before catalog comparison or purchase analysis.", "operationId": "getApiJdGetItemPriceV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "A unique product identifier on JD.com (item ID).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001050", "x-api-version": "v1", "x-search-aliases": [ "JD.com product price", "JD item price lookup", "JD price check", "京东商品价格", "京东商品价格查询", "京东价格检查" ], "x-highlights": [], "x-endpoint-family": "jd_get_item_price" } }, "/api/jd/search-item-list/v1": { "get": { "tags": [ "JD.com" ], "summary": "Product Search", "description": "Search JD.com products by keyword with page-based pagination. Use it to discover products and collect item IDs for follow-up lookups.", "operationId": "getApiJdSearchItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001075", "x-api-version": "v1", "x-search-aliases": [ "JD.com product search", "JD keyword product search", "JD item search", "京东商品搜索", "京东关键词商品搜索", "京东商品查询" ], "x-highlights": [], "x-endpoint-family": "jd_search_item_list" } }, "/api/jd/search-item-list/v2": { "get": { "tags": [ "JD.com" ], "summary": "Product Search", "description": "Search JD.com products by keyword with page-based pagination and sales-volume ordering. Use it to discover popular products and collect item IDs for follow-up lookups.", "operationId": "getApiJdSearchItemListV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001085", "x-api-version": "v2", "x-search-aliases": [ "JD.com sales volume search", "JD popular product search", "JD keyword product ranking", "京东销量排序搜索", "京东热销商品搜索", "京东商品关键词排名" ], "x-highlights": [], "x-endpoint-family": "jd_search_item_list" } }, "/api/jd/get-item-comments/v1": { "get": { "tags": [ "JD.com" ], "summary": "Product Comments", "description": "Retrieve paginated customer comments for a JD.com product identified by item ID. Use it to review buyer feedback for a known product.", "operationId": "getApiJdGetItemCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "A unique product identifier on JD.com (item ID).", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for paginated comments.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001100", "x-api-version": "v1", "x-search-aliases": [ "JD.com product comments", "JD customer review list", "JD item feedback", "京东商品评论", "京东买家评价列表", "京东商品反馈" ], "x-highlights": [], "x-endpoint-family": "jd_get_item_comments" } }, "/api/jd/get-item-comments/v2": { "get": { "tags": [ "JD.com" ], "summary": "Product Comments", "description": "Retrieve paginated JD.com product comments for a specific SKU. Use it to review buyer feedback for that product.", "operationId": "getApiJdGetItemCommentsV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "A unique product identifier on JD.com (item ID).", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for paginated comments.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001125", "x-api-version": "v2", "x-search-aliases": [ "JD.com SKU comments", "JD product comments", "JD item review list", "京东SKU评论", "京东商品评论", "京东商品评价列表" ], "x-highlights": [], "x-endpoint-family": "jd_get_item_comments" } }, "/api/jd/get-shop-item-list/v1": { "get": { "tags": [ "JD.com" ], "summary": "Shop Product List", "description": "Retrieve a page of products from a JD.com shop identified by shop ID. Use it to browse a seller's catalog and collect item IDs for follow-up lookups.", "operationId": "getApiJdGetShopItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "description": "A unique shop identifier on JD.com (Shop ID).", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for the paginated shop product list.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19001200", "x-api-version": "v1", "x-search-aliases": [ "JD.com shop products", "JD store product list", "JD seller catalog", "京东店铺商品", "京东店铺商品列表", "京东商家目录" ], "x-highlights": [], "x-endpoint-family": "jd_get_shop_item_list" } }, "/api/xianyu/search-item-list/v1": { "get": { "tags": [ "Xianyu (GooFish)" ], "summary": "Product Search", "description": "Searches Xianyu (GooFish) second-hand listings by keyword with page and sort controls. Use it to discover resale items by activity, recency, seller credit, price, or listing time.", "operationId": "getApiXianyuSearchItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination. The first page is 1.", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort order for Xianyu search results.\n\nAvailable Values:\n- `active`: Active listings first.\n- `recent`: Recent nearby or position-based results first.\n- `credit`: Seller credit first.\n- `price_asc`: Lowest price first.\n- `price_desc`: Highest price first.\n- `price_drop`: Reduced-price listings first.\n- `newest`: Newly listed items first.", "required": false, "schema": { "type": "string", "default": "active", "description": "Xianyu product search sort type.", "enum": [ "active", "recent", "credit", "price_asc", "price_desc", "price_drop", "newest" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19051000", "x-api-version": "v1", "x-search-aliases": [ "Xianyu product search", "GooFish second-hand search", "Xianyu resale listings", "闲鱼商品搜索", "闲鱼二手商品查询", "闲鱼关键词找货" ], "x-highlights": [], "x-endpoint-family": "xianyu_search_item_list" } }, "/api/xianyu/get-item-detail/v1": { "get": { "tags": [ "Xianyu (GooFish)" ], "summary": "Product Details", "description": "Retrieves the public detail for a Xianyu (GooFish) second-hand listing by item ID. Use it to inspect a known resale item after search or link discovery.", "operationId": "getApiXianyuGetItemDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "A unique product identifier on Xianyu.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19051100", "x-api-version": "v1", "x-search-aliases": [ "Xianyu product detail", "GooFish listing detail", "Xianyu item by ID", "闲鱼商品详情", "闲鱼二手商品详情", "闲鱼商品 ID 查询" ], "x-highlights": [], "x-endpoint-family": "xianyu_get_item_detail" } }, "/api/1688/get-item-detail/v1": { "get": { "tags": [ "1688" ], "summary": "Product Details", "description": "Retrieves the public product detail for a 1688 wholesale listing by item ID. Use it to review a known offer during product sourcing or catalog research.", "operationId": "getApi1688GetItemDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "A unique product identifier on 1688.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19101000", "x-api-version": "v1", "x-search-aliases": [ "1688 product detail", "1688 wholesale item lookup", "1688 offer detail", "1688 商品详情", "1688 批发商品查询", "1688 货源详情" ], "x-highlights": [], "x-endpoint-family": "1688_get_item_detail" } }, "/api/1688/search-item-list/v1": { "get": { "tags": [ "1688" ], "summary": "Product Search", "description": "Searches 1688 wholesale product listings by keyword. Use it to discover candidate products or suppliers during sourcing and market research.", "operationId": "getApi1688SearchItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "19101100", "x-api-version": "v1", "x-search-aliases": [ "1688 product search", "1688 wholesale search", "1688 supplier product discovery", "1688 商品搜索", "1688 批发货源搜索", "1688 供应商商品查询" ], "x-highlights": [], "x-endpoint-family": "1688_search_item_list" } }, "/api/temu/get-homepage-goods/v1": { "get": { "tags": [ "Temu" ], "summary": "Homepage Product Feed", "description": "Retrieves Temu homepage product feed cards for a selected site with offset pagination. Use it for product sourcing, catalog monitoring, and marketplace trend analysis.", "operationId": "getApiTemuGetHomepageGoodsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Temu site used to select the regional homepage feed.\n\nAvailable Values:\n- `US`: United States\n- `EU`: Europe\n- `UK`: United Kingdom\n- `CA`: Canada\n- `AU`: Australia", "required": true, "schema": { "type": "string", "description": "Temu site", "enum": [ "US", "EU", "UK", "CA", "AU" ] } }, { "name": "offset", "in": "query", "description": "Zero-based offset for pagination.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20001000", "x-api-version": "v1", "x-search-aliases": [ "Temu homepage product feed", "Temu homepage products by site", "Temu marketplace trend feed", "Temu 首页商品流", "Temu 首页货盘", "Temu 选品趋势监控" ], "x-highlights": [], "x-endpoint-family": "temu_get_homepage_goods" } }, "/api/shopee/get-item-detail/v1": { "get": { "tags": [ "Shopee" ], "summary": "Item Details", "description": "Retrieves Shopee item details by marketplace site and item ID.", "operationId": "getApiShopeeGetItemDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "itemId", "in": "query", "description": "Shopee item ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501000", "x-api-version": "v1", "x-search-aliases": [ "Shopee item details", "Shopee product lookup", "Shopee 商品详情" ], "x-highlights": [], "x-endpoint-family": "shopee_get_item_detail" } }, "/api/shopee/get-shop-seo/v1": { "get": { "tags": [ "Shopee" ], "summary": "Shop Profile and Rating Summary", "description": "Retrieves a Shopee shop profile and rating summary by marketplace site and shop ID.", "operationId": "getApiShopeeGetShopSeoV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501100", "x-api-version": "v1", "x-search-aliases": [ "Shopee shop SEO", "Shopee shop rating summary", "Shopee 店铺评分摘要" ], "x-highlights": [], "x-endpoint-family": "shopee_get_shop_seo" } }, "/api/shopee/get-item-detail/v2": { "get": { "tags": [ "Shopee" ], "summary": "Item Details", "description": "Retrieves Shopee item details by marketplace site, shop ID, and item ID using the version 2 data source.", "operationId": "getApiShopeeGetItemDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "itemId", "in": "query", "description": "Shopee item ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501200", "x-api-version": "v2", "x-search-aliases": [ "Shopee item details v2", "Shopee product lookup v2", "Shopee 商品详情 V2" ], "x-highlights": [], "x-endpoint-family": "shopee_get_item_detail" } }, "/api/shopee/get-shop-item-list/v1": { "get": { "tags": [ "Shopee" ], "summary": "Shop Item List", "description": "Retrieves Shopee item cards for a shop username in the selected marketplace site.", "operationId": "getApiShopeeGetShopItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "username", "in": "query", "description": "Shopee shop username.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501300", "x-api-version": "v1", "x-search-aliases": [ "Shopee shop items", "Shopee seller products", "Shopee 店铺商品" ], "x-highlights": [], "x-endpoint-family": "shopee_get_shop_item_list" } }, "/api/shopee/get-item-sku-matrix/v1": { "get": { "tags": [ "Shopee" ], "summary": "Item SKU Matrix", "description": "Retrieves the SKU option matrix for a Shopee item in the selected marketplace site.", "operationId": "getApiShopeeGetItemSkuMatrixV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "itemId", "in": "query", "description": "Shopee item ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501400", "x-api-version": "v1", "x-search-aliases": [ "Shopee SKU matrix", "Shopee item variants", "Shopee 商品规格" ], "x-highlights": [], "x-endpoint-family": "shopee_get_item_sku_matrix" } }, "/api/shopee/get-shop-base/v1": { "get": { "tags": [ "Shopee" ], "summary": "Shop Basic Profile", "description": "Retrieves the basic Shopee shop profile by username and marketplace site.", "operationId": "getApiShopeeGetShopBaseV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "username", "in": "query", "description": "Shopee shop username.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501500", "x-api-version": "v1", "x-search-aliases": [ "Shopee shop profile", "Shopee seller basics", "Shopee 店铺资料" ], "x-highlights": [], "x-endpoint-family": "shopee_get_shop_base" } }, "/api/shopee/search-item-list/v1": { "get": { "tags": [ "Shopee" ], "summary": "Item Search", "description": "Searches Shopee items by keyword in the selected marketplace site.", "operationId": "getApiShopeeSearchItemListV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "keyword", "in": "query", "description": "Product search keyword.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501600", "x-api-version": "v1", "x-search-aliases": [ "Shopee product search", "Shopee keyword items", "Shopee 商品搜索" ], "x-highlights": [], "x-endpoint-family": "shopee_search_item_list" } }, "/api/shopee/get-item-sku-models/v1": { "get": { "tags": [ "Shopee" ], "summary": "Item SKU Models", "description": "Retrieves observed SKU models for a Shopee item with offset and rating filters.", "operationId": "getApiShopeeGetItemSkuModelsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "itemId", "in": "query", "description": "Shopee item ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "description": "Zero-based result offset.", "required": false, "schema": { "type": "string" } }, { "name": "ratingType", "in": "query", "description": "Rating filter from 0 to 5, where 0 includes all ratings.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501700", "x-api-version": "v1", "x-search-aliases": [ "Shopee SKU models", "Shopee variant ratings", "Shopee SKU 型号" ], "x-highlights": [], "x-endpoint-family": "shopee_get_item_sku_models" } }, "/api/shopee/get-shop-detail/v1": { "get": { "tags": [ "Shopee" ], "summary": "Shop Details", "description": "Retrieves detailed Shopee shop information by username and marketplace site.", "operationId": "getApiShopeeGetShopDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "username", "in": "query", "description": "Shopee shop username.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501800", "x-api-version": "v1", "x-search-aliases": [ "Shopee shop details", "Shopee seller profile", "Shopee 店铺详情" ], "x-highlights": [], "x-endpoint-family": "shopee_get_shop_detail" } }, "/api/shopee/get-shop-reviews-rich/v1": { "get": { "tags": [ "Shopee" ], "summary": "Rich Shop Reviews", "description": "Retrieves enriched Shopee shop reviews using a zero-based result offset.", "operationId": "getApiShopeeGetShopReviewsRichV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "description": "Zero-based result offset.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20501900", "x-api-version": "v1", "x-search-aliases": [ "Shopee rich shop reviews", "Shopee seller reviews", "Shopee 店铺评论丰富版" ], "x-highlights": [], "x-endpoint-family": "shopee_get_shop_reviews_rich" } }, "/api/shopee/get-item-snapshot/v1": { "get": { "tags": [ "Shopee" ], "summary": "Item Display Snapshot", "description": "Retrieves a display snapshot for a Shopee item in the selected marketplace site.", "operationId": "getApiShopeeGetItemSnapshotV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "itemId", "in": "query", "description": "Shopee item ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20502000", "x-api-version": "v1", "x-search-aliases": [ "Shopee item snapshot", "Shopee product display", "Shopee 商品快照" ], "x-highlights": [], "x-endpoint-family": "shopee_get_item_snapshot" } }, "/api/shopee/get-shop-reviews/v1": { "get": { "tags": [ "Shopee" ], "summary": "Shop Reviews", "description": "Retrieves Shopee shop reviews with offset pagination and a rating filter.", "operationId": "getApiShopeeGetShopReviewsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "description": "Zero-based result offset.", "required": false, "schema": { "type": "string" } }, { "name": "ratingType", "in": "query", "description": "Rating filter from 0 to 5, where 0 includes all ratings.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20502100", "x-api-version": "v1", "x-search-aliases": [ "Shopee shop reviews", "Shopee seller ratings", "Shopee 店铺评论" ], "x-highlights": [], "x-endpoint-family": "shopee_get_shop_reviews" } }, "/api/shopee/get-item-reviews/v1": { "get": { "tags": [ "Shopee" ], "summary": "Item Reviews", "description": "Retrieves reviews for a specified Shopee item with offset pagination and a rating filter.", "operationId": "getApiShopeeGetItemReviewsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "itemId", "in": "query", "description": "Shopee item ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "description": "Zero-based result offset.", "required": false, "schema": { "type": "string" } }, { "name": "ratingType", "in": "query", "description": "Rating filter from 0 to 5, where 0 includes all ratings.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20502200", "x-api-version": "v1", "x-search-aliases": [ "Shopee item reviews", "Shopee product ratings", "Shopee 商品评论" ], "x-highlights": [], "x-endpoint-family": "shopee_get_item_reviews" } }, "/api/shopee/get-shop-categories/v1": { "get": { "tags": [ "Shopee" ], "summary": "Shop Categories", "description": "Retrieves Shopee shop categories using a zero-based result offset.", "operationId": "getApiShopeeGetShopCategoriesV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "description": "Zero-based result offset.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20502500", "x-api-version": "v1", "x-search-aliases": [ "Shopee shop categories", "Shopee seller categories", "Shopee 店铺分类" ], "x-highlights": [], "x-endpoint-family": "shopee_get_shop_categories" } }, "/api/shopee/get-item-review-models/v1": { "get": { "tags": [ "Shopee" ], "summary": "Item Review Model Distribution", "description": "Retrieves the review distribution across SKU models for a Shopee item.", "operationId": "getApiShopeeGetItemReviewModelsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "itemId", "in": "query", "description": "Shopee item ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20502600", "x-api-version": "v1", "x-search-aliases": [ "Shopee review model distribution", "Shopee variant review counts", "Shopee 评论规格分布" ], "x-highlights": [], "x-endpoint-family": "shopee_get_item_review_models" } }, "/api/shopee/get-item-review-tags/v1": { "get": { "tags": [ "Shopee" ], "summary": "Item Review Tags", "description": "Retrieves review tags for a Shopee item in the selected marketplace site.", "operationId": "getApiShopeeGetItemReviewTagsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "itemId", "in": "query", "description": "Shopee item ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20502700", "x-api-version": "v1", "x-search-aliases": [ "Shopee review tags", "Shopee item feedback tags", "Shopee 商品评论标签" ], "x-highlights": [], "x-endpoint-family": "shopee_get_item_review_tags" } }, "/api/shopee/get-search-facets/v1": { "get": { "tags": [ "Shopee" ], "summary": "Search Category Facets", "description": "Retrieves category facets for a Shopee product search keyword.", "operationId": "getApiShopeeGetSearchFacetsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "keyword", "in": "query", "description": "Product search keyword.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20502800", "x-api-version": "v1", "x-search-aliases": [ "Shopee search facets", "Shopee category facets", "Shopee 搜索类目分面" ], "x-highlights": [], "x-endpoint-family": "shopee_get_search_facets" } }, "/api/shopee/get-item-installments/v1": { "get": { "tags": [ "Shopee" ], "summary": "Item Installments and Amounts", "description": "Retrieves installment and amount information for a Shopee item. This operation supports Taiwan and Indonesia but not Thailand.", "operationId": "getApiShopeeGetItemInstallmentsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "site", "in": "query", "description": "Shopee marketplace site. Taiwan and Indonesia are supported for this operation.\n\nAvailable Values:\n- `TW`: Taiwan\n- `ID`: Indonesia\n- `TH`: Thailand", "required": true, "schema": { "type": "string", "description": "Shopee marketplace site", "enum": [ "TW", "ID", "TH" ] } }, { "name": "shopId", "in": "query", "description": "Shopee shop ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "itemId", "in": "query", "description": "Shopee item ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "detailLevel", "in": "query", "description": "Detail level for the installment response.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "20502900", "x-api-version": "v1", "x-search-aliases": [ "Shopee installments", "Shopee item payment amounts", "Shopee 商品分期金额" ], "x-highlights": [], "x-endpoint-family": "shopee_get_item_installments" } }, "/api/douban/get-movie-reviews/v1": { "get": { "tags": [ "Douban Movie" ], "summary": "Movie Reviews", "description": "Retrieves paginated Douban long-form reviews for a movie or TV subject, ordered by time or popularity. Use it to browse in-depth audience reviews for a known subject.", "operationId": "getApiDoubanGetMovieReviewsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "subjectId", "in": "query", "description": "The unique ID for a movie or TV subject on Douban.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `time`: Time\n- `hotest`: Hotest", "required": false, "schema": { "type": "string", "default": "time", "description": "Douban Reviews Sort", "enum": [ "time", "hotest" ] } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "21001000", "x-api-version": "v1", "x-search-aliases": [ "Douban movie reviews", "Douban subject long reviews", "Douban TV reviews", "豆瓣电影长评", "豆瓣条目影评", "豆瓣电视剧评论" ], "x-highlights": [], "x-endpoint-family": "douban_get_movie_reviews" } }, "/api/douban/get-movie-review-detail/v1": { "get": { "tags": [ "Douban Movie" ], "summary": "Review Details", "description": "Retrieves a single Douban long-form review by its review ID. Use it to inspect a known review after discovering it in a subject's review list.", "operationId": "getApiDoubanGetMovieReviewDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "reviewId", "in": "query", "description": "The unique ID for a specific review on Douban.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "21001100", "x-api-version": "v1", "x-search-aliases": [ "Douban review detail", "Douban long review by ID", "Douban movie review content", "豆瓣影评详情", "豆瓣长评详情", "豆瓣评论 ID 查询" ], "x-highlights": [], "x-endpoint-family": "douban_get_movie_review_detail" } }, "/api/douban/get-subject-detail/v1": { "get": { "tags": [ "Douban Movie" ], "summary": "Subject Details", "description": "Retrieves the public detail page data for a Douban movie or TV subject by subject ID. Use it to inspect a known title before requesting its reviews or comments.", "operationId": "getApiDoubanGetSubjectDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "subjectId", "in": "query", "description": "The unique ID for a movie or TV subject on Douban.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "21001200", "x-api-version": "v1", "x-search-aliases": [ "Douban subject detail", "Douban movie detail", "Douban TV detail", "豆瓣条目详情", "豆瓣电影详情", "豆瓣电视剧详情" ], "x-highlights": [], "x-endpoint-family": "douban_get_subject_detail" } }, "/api/douban/get-movie-comments/v1": { "get": { "tags": [ "Douban Movie" ], "summary": "Comments", "description": "Retrieves paginated Douban short comments for a movie or TV subject, ordered by time or newest rating. Use it to review concise audience feedback for a known subject.", "operationId": "getApiDoubanGetMovieCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "subjectId", "in": "query", "description": "The unique ID for a movie or TV subject on Douban.", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort order for the result set.\n\nAvailable Values:\n- `time`: Time\n- `new_score`: New Score", "required": false, "schema": { "type": "string", "default": "time", "description": "Douban Comments Sort", "enum": [ "time", "new_score" ] } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "21001200", "x-api-version": "v1", "x-search-aliases": [ "Douban movie short comments", "Douban subject comments", "Douban TV short reviews", "豆瓣电影短评", "豆瓣条目评论", "豆瓣电视剧短评" ], "x-highlights": [], "x-endpoint-family": "douban_get_movie_comments" } }, "/api/douban/get-recent-hot-movie/v1": { "get": { "tags": [ "Douban Movie" ], "summary": "Recent Hot Movie", "description": "Retrieves a paginated list of movies currently featured in Douban's recent-hot collection. Use it to discover popular movie titles and continue through result pages.", "operationId": "getApiDoubanGetRecentHotMovieV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "21001300", "x-api-version": "v1", "x-search-aliases": [ "Douban recent hot movies", "Douban popular movie list", "Douban trending films", "豆瓣近期热门电影", "豆瓣热门电影列表", "豆瓣电影热榜" ], "x-highlights": [], "x-endpoint-family": "douban_get_recent_hot_movie" } }, "/api/douban/get-recent-hot-tv/v1": { "get": { "tags": [ "Douban Movie" ], "summary": "Recent Hot Tv", "description": "Retrieves a paginated list of TV titles currently featured in Douban's recent-hot collection. Use it to discover popular series and continue through result pages.", "operationId": "getApiDoubanGetRecentHotTvV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "21001400", "x-api-version": "v1", "x-search-aliases": [ "Douban recent hot TV", "Douban popular series list", "Douban trending TV shows", "豆瓣近期热门电视", "豆瓣热门剧集列表", "豆瓣电视剧热榜" ], "x-highlights": [], "x-endpoint-family": "douban_get_recent_hot_tv" } }, "/api/tiktok/get-user-post/v1": { "get": { "tags": [ "TikTok" ], "summary": "User Published Posts", "description": "Retrieves posts published by a TikTok user identified by secUid, with cursor pagination and latest or popular sorting. Use it to browse a creator's posting history or continue through their public post feed.", "operationId": "getApiTiktokGetUserPostV1", "parameters": [ { "name": "token", "in": "query", "description": "Security token for API access.", "required": true, "schema": { "type": "string" } }, { "name": "secUid", "in": "query", "description": "The opaque security ID returned for the TikTok user.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor. Use '0' for the first page, then use the max_cursor value returned in the previous response.", "required": false, "schema": { "type": "string", "default": "0" } }, { "name": "sort", "in": "query", "description": "Sorting criteria for the user's posts.\n\nAvailable Values:\n- `LATEST`: Newest posts first (default)\n- `MOST_POPULAR`: Most popular posts first", "required": false, "schema": { "type": "string", "default": "LATEST", "description": "TikTok user post sorting options", "enum": [ "LATEST", "MOST_POPULAR" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 22001000, "x-api-version": "v1", "x-search-aliases": [ "TikTok user posts API", "TikTok creator post list", "TikTok secUid posts", "TikTok 用户发布作品", "TikTok 用户视频列表", "TikTok 博主作品" ], "x-highlights": [], "x-endpoint-family": "tiktok_get_user_post" } }, "/api/tiktok/get-post-detail/v1": { "get": { "tags": [ "TikTok" ], "summary": "Post Details", "description": "Retrieves details for a TikTok post identified by its post ID. Use it to look up a known TikTok video before content review, reporting, or related engagement analysis.", "operationId": "getApiTiktokGetPostDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Security token for API access.", "required": true, "schema": { "type": "string" } }, { "name": "postId", "in": "query", "description": "The unique ID of the TikTok post.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 22001100, "x-api-version": "v1", "x-search-aliases": [ "TikTok post details API", "TikTok video details", "TikTok post ID lookup", "TikTok 视频详情", "TikTok 作品详情", "TikTok 视频 ID 查询" ], "x-highlights": [], "x-endpoint-family": "tiktok_get_post_detail" } }, "/api/tiktok/get-user-detail/v1": { "get": { "tags": [ "TikTok" ], "summary": "User Profile", "description": "Retrieves a TikTok user profile by public username or secUid. Use it to look up a known account for creator research, profile review, or subsequent user-post retrieval.", "operationId": "getApiTiktokGetUserDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Security token for API access.", "required": true, "schema": { "type": "string" } }, { "name": "uniqueId", "in": "query", "description": "The public TikTok handle or username of the user.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "secUid", "in": "query", "description": "The unique security ID of the user.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 22001200, "x-api-version": "v1", "x-search-aliases": [ "TikTok user profile API", "TikTok username lookup", "TikTok secUid lookup", "TikTok 用户资料", "TikTok 用户信息查询", "TikTok 账号查询" ], "x-highlights": [], "x-endpoint-family": "tiktok_get_user_detail" } }, "/api/tiktok/get-post-comment/v1": { "get": { "tags": [ "TikTok" ], "summary": "Post Comments", "description": "Retrieves comments for a TikTok post with cursor pagination. Use it to review audience discussion, continue through comment pages, or support comment analysis for a known post.", "operationId": "getApiTiktokGetPostCommentV1", "parameters": [ { "name": "token", "in": "query", "description": "Security token for API access.", "required": true, "schema": { "type": "string" } }, { "name": "awemeId", "in": "query", "description": "The unique ID of the TikTok post (awemeId).", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor. Start with '0'.", "required": false, "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 22001300, "x-api-version": "v1", "x-search-aliases": [ "TikTok post comments API", "TikTok video comment list", "TikTok comments by aweme ID", "TikTok 视频评论", "TikTok 作品评论列表", "TikTok 评论分页" ], "x-highlights": [], "x-endpoint-family": "tiktok_get_post_comment" } }, "/api/tiktok/get-post-sub-comment/v1": { "get": { "tags": [ "TikTok" ], "summary": "Comment Replies", "description": "Retrieves replies to a specific comment on a TikTok post with cursor pagination. Use it to inspect threaded discussions and continue through reply pages for a known post comment.", "operationId": "getApiTiktokGetPostSubCommentV1", "parameters": [ { "name": "token", "in": "query", "description": "Security token for API access.", "required": true, "schema": { "type": "string" } }, { "name": "awemeId", "in": "query", "description": "The unique ID of the TikTok post.", "required": true, "schema": { "type": "string" } }, { "name": "commentId", "in": "query", "description": "The unique ID of the comment to retrieve replies for.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor. Start with '0'.", "required": false, "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 22001400, "x-api-version": "v1", "x-search-aliases": [ "TikTok comment replies API", "TikTok reply list", "TikTok subcomments", "TikTok 评论回复", "TikTok 二级评论", "TikTok 子评论列表" ], "x-highlights": [], "x-endpoint-family": "tiktok_get_post_sub_comment" } }, "/api/tiktok/search-user/v1": { "get": { "tags": [ "TikTok" ], "summary": "User Search", "description": "Searches TikTok users by keyword with cursor pagination and search-session continuity. Use it to discover accounts related to a creator name, topic, brand, or other search term.", "operationId": "getApiTiktokSearchUserV1", "parameters": [ { "name": "token", "in": "query", "description": "Security token for API access.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keywords.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor. Start with '0'.", "required": false, "schema": { "type": "string", "default": "0" } }, { "name": "searchId", "in": "query", "description": "The 'logid' returned from the previous request for consistent search results.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 22001500, "x-api-version": "v1", "x-search-aliases": [ "TikTok user search API", "TikTok creator search", "TikTok account keyword search", "TikTok 用户搜索", "TikTok 博主搜索", "TikTok 账号关键词查询" ], "x-highlights": [], "x-endpoint-family": "tiktok_search_user" } }, "/api/tiktok/search-post/v1": { "get": { "tags": [ "TikTok" ], "summary": "Post Search", "description": "Searches TikTok posts by keyword with offset pagination plus sorting, publish-time, and region controls. Use it to support regional content discovery, topic research, or monitoring keyword-related videos.", "operationId": "getApiTiktokSearchPostV1", "parameters": [ { "name": "token", "in": "query", "description": "Security token for API access.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keywords.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Pagination offset, starting from 0 and stepping by 20.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sortType", "in": "query", "description": "Sorting criteria for search results.\n\nAvailable Values:\n- `RELEVANCE`: Relevance (Default)\n- `MOST_LIKED`: Most Liked", "required": false, "schema": { "type": "string", "default": "RELEVANCE", "description": "TikTok Search Sorting criteria", "enum": [ "RELEVANCE", "MOST_LIKED" ] } }, { "name": "publishTime", "in": "query", "description": "Filter posts by publishing time.\n\nAvailable Values:\n- `ALL`: All Time\n- `ONE_DAY`: Last 24 Hours\n- `ONE_WEEK`: Last 7 Days\n- `ONE_MONTH`: Last 30 Days\n- `THREE_MONTHS`: Last 90 Days\n- `HALF_YEAR`: Last 180 Days", "required": false, "schema": { "type": "string", "default": "ALL", "description": "TikTok Post Publishing time filter", "enum": [ "ALL", "ONE_DAY", "ONE_WEEK", "ONE_MONTH", "THREE_MONTHS", "HALF_YEAR" ] } }, { "name": "region", "in": "query", "description": "ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB').", "required": false, "schema": { "type": "string", "default": "US" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 22001600, "x-api-version": "v1", "x-search-aliases": [ "TikTok post search API", "TikTok video keyword search", "TikTok regional content search", "TikTok 视频搜索", "TikTok 作品关键词搜索", "TikTok 地区内容查询" ], "x-highlights": [], "x-endpoint-family": "tiktok_search_post" } }, "/api/tiktok-shop/search-products/v1": { "get": { "tags": [ "TikTok Shop" ], "summary": "Product Search", "description": "Searches TikTok Shop products by keyword within a selected region, with offset and page-token pagination. Use it to discover regional products and continue through search results.", "operationId": "getApiTiktokShopSearchProductsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Target region for product search.\n\nAvailable Values:\n- `US`: United States\n- `GB`: United Kingdom\n- `FR`: France\n- `SG`: Singapore\n- `MY`: Malaysia\n- `PH`: Philippines\n- `TH`: Thailand\n- `VN`: Vietnam\n- `ID`: Indonesia", "required": false, "schema": { "type": "string", "default": "US", "description": "TikTok Shop Enum", "enum": [ "US", "GB", "FR", "SG", "MY", "PH", "TH", "VN", "ID" ] } }, { "name": "offset", "in": "query", "description": "Search result offset.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageToken", "in": "query", "description": "Pagination token for the next page.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "22501000", "x-api-version": "v1", "x-search-aliases": [ "TikTok Shop product search", "TikTok Shop regional products", "TikTok ecommerce search", "TikTok Shop 商品搜索", "TikTok 商城区域商品查询", "TikTok 电商关键词搜索" ], "x-highlights": [], "x-endpoint-family": "tiktok_shop_search_products" } }, "/api/tiktok-shop/get-product-detail/v1": { "get": { "tags": [ "TikTok Shop" ], "summary": "Product Details", "description": "Retrieves the public TikTok Shop product detail for a product ID in a selected region. Use it to inspect a known regional product after search or catalog discovery.", "operationId": "getApiTiktokShopGetProductDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "query", "description": "TikTok Shop Product ID.", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Target region for product detail.\n\nAvailable Values:\n- `US`: United States\n- `GB`: United Kingdom\n- `FR`: France\n- `SG`: Singapore\n- `MY`: Malaysia\n- `PH`: Philippines\n- `TH`: Thailand\n- `VN`: Vietnam\n- `ID`: Indonesia", "required": false, "schema": { "type": "string", "default": "US", "description": "TikTok Shop Enum", "enum": [ "US", "GB", "FR", "SG", "MY", "PH", "TH", "VN", "ID" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "22501100", "x-api-version": "v1", "x-search-aliases": [ "TikTok Shop product detail", "TikTok Shop item by ID", "TikTok ecommerce product lookup", "TikTok Shop 商品详情", "TikTok 商城商品 ID 查询", "TikTok 电商商品详情" ], "x-highlights": [], "x-endpoint-family": "tiktok_shop_get_product_detail" } }, "/api/youku/search-video/v1": { "get": { "tags": [ "YOUKU" ], "summary": "Video Search", "description": "Searches Youku videos by keyword with page-based pagination. Use it to discover videos related to a topic, title, creator, or other search term.", "operationId": "getApiYoukuSearchVideoV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Keyword to search for.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination, starting from 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "23001000", "x-api-version": "v1", "x-search-aliases": [ "Youku video search API", "Youku keyword video search", "Youku paginated video search", "优酷视频搜索", "优酷关键词搜视频", "优酷视频分页查询" ], "x-highlights": [], "x-endpoint-family": "youku_search_video" } }, "/api/youku/get-video-detail/v1": { "get": { "tags": [ "YOUKU" ], "summary": "Video Details", "description": "Retrieves details for a Youku video identified by video ID. Use it to look up a known video for content review, cataloging, or subsequent video analysis.", "operationId": "getApiYoukuGetVideoDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "videoId", "in": "query", "description": "The unique identifier for the video.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "23001100", "x-api-version": "v1", "x-search-aliases": [ "Youku video details API", "Youku video ID lookup", "Youku video information", "优酷视频详情", "优酷视频 ID 查询", "优酷视频信息" ], "x-highlights": [], "x-endpoint-family": "youku_get_video_detail" } }, "/api/youku/get-user-detail/v1": { "get": { "tags": [ "YOUKU" ], "summary": "User Profile", "description": "Retrieves a Youku user profile identified by UID. Use it to look up a known account for creator research, profile review, or related video discovery.", "operationId": "getApiYoukuGetUserDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "The unique identifier for the user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "23001200", "x-api-version": "v1", "x-search-aliases": [ "Youku user profile API", "Youku UID lookup", "Youku creator profile", "优酷用户资料", "优酷 UID 查询", "优酷创作者信息" ], "x-highlights": [], "x-endpoint-family": "youku_get_user_detail" } }, "/api/instagram/get-user-detail/v1": { "get": { "tags": [ "Instagram" ], "summary": "User Profile", "description": "Retrieves an Instagram user profile by username. Use it to review a known account before creator research, brand monitoring, or related post analysis.", "operationId": "getApiInstagramGetUserDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API service.", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "The Instagram username whose profile details are to be retrieved.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "24001000", "x-api-version": "v1", "x-search-aliases": [ "Instagram user profile API", "Instagram account lookup", "Instagram profile by username", "Instagram 用户资料接口", "Instagram 用户信息查询", "Instagram 用户名查主页" ], "x-highlights": [], "x-endpoint-family": "instagram_get_user_detail" } }, "/api/instagram/get-user-detail/v2": { "get": { "tags": [ "Instagram" ], "summary": "User Profile", "description": "Retrieves an Instagram user profile by username. Use it to review a known account before creator research, brand monitoring, or related post analysis.", "operationId": "getApiInstagramGetUserDetailV2", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API service.", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "The Instagram username whose profile details are to be retrieved.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "24001010", "x-api-version": "v2", "x-search-aliases": [ "Instagram user profile API", "Instagram account lookup", "Instagram profile by username", "Instagram 用户资料接口", "Instagram 用户信息查询", "Instagram 用户名查主页" ], "x-recommended": true, "x-highlights": [], "x-endpoint-family": "instagram_get_user_detail" } }, "/api/instagram/get-post-detail/v1": { "get": { "tags": [ "Instagram" ], "summary": "Post Details", "description": "Retrieves an Instagram post by its shortcode. Use it to look up a known post before content review, archiving, comment analysis, or related workflows.", "operationId": "getApiInstagramGetPostDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API service.", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "The unique shortcode from the Instagram post URL.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "24001100", "x-api-version": "v1", "x-search-aliases": [ "Instagram post details API", "Instagram post shortcode lookup", "Instagram media post information", "Instagram 帖子详情接口", "Instagram 短代码查帖子", "Instagram 帖子信息查询" ], "x-highlights": [], "x-endpoint-family": "instagram_get_post_detail" } }, "/api/instagram/get-user-posts/v1": { "get": { "tags": [ "Instagram" ], "summary": "User Published Posts", "description": "Retrieves posts published by an Instagram user with token-based pagination. Use it to browse a known account's post history or continue through subsequent result pages.", "operationId": "getApiInstagramGetUserPostsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API service.", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "The Instagram username whose published posts are to be retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "Token used for retrieving the next page of results.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "24001200", "x-api-version": "v1", "x-search-aliases": [ "Instagram user published posts", "Instagram account post list", "Instagram posts by username", "Instagram 用户发布帖子", "Instagram 用户帖子列表", "Instagram 账号内容" ], "x-highlights": [], "x-endpoint-family": "instagram_get_user_posts" } }, "/api/instagram/search-reels/v1": { "get": { "tags": [ "Instagram" ], "summary": "Reels Search", "description": "Searches Instagram Reels by keyword or hashtag with token-based pagination. Use it to discover short-form videos, monitor topics, and continue through matching results.", "operationId": "getApiInstagramSearchReelsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "The search keyword or hashtag to filter Reels.", "required": true, "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "Token used for retrieving the next page of results.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "24001300", "x-api-version": "v1", "x-search-aliases": [ "Instagram Reels search API", "Instagram short video search", "Instagram keyword Reels search", "Instagram Reels 搜索接口", "Instagram 短视频搜索", "Instagram 关键词搜 Reels" ], "x-highlights": [], "x-endpoint-family": "instagram_search_reels" } }, "/api/instagram/search-hashtag-posts/v1": { "get": { "tags": [ "Instagram" ], "summary": "Hashtag Posts Search", "description": "Searches Instagram posts by hashtag with cursor pagination. Use it to explore tagged content, monitor topics, and continue through subsequent result pages.", "operationId": "getApiInstagramSearchHashtagPostsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API service.", "required": true, "schema": { "type": "string" } }, { "name": "hashtag", "in": "query", "description": "The hashtag or keyword to search for.", "required": true, "schema": { "type": "string" } }, { "name": "endCursor", "in": "query", "description": "Cursor used for retrieving the next page of results.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "24001400", "x-api-version": "v1", "x-search-aliases": [ "Instagram hashtag posts search", "Instagram tagged post list", "Instagram posts by hashtag", "Instagram 话题标签帖子搜索", "Instagram 标签帖子列表", "Instagram 按标签查帖子" ], "x-highlights": [], "x-endpoint-family": "instagram_search_hashtag_posts" } }, "/api/instagram/get-post-comments/v1": { "get": { "tags": [ "Instagram" ], "summary": "Post Comment List", "description": "Retrieves top-level comments for an Instagram post by shortcode, with cursor pagination and popular or newest sorting. Use it to review audience feedback or analyze discussion around a known post.", "operationId": "getApiInstagramGetPostCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API service.", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "The unique shortcode for the Instagram post.", "required": true, "schema": { "type": "string" } }, { "name": "minId", "in": "query", "description": "Pagination cursor returned as next_min_id from the previous response.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "sortOrder", "in": "query", "description": "Sort order for the comments.\n\nAvailable Values:\n- `popular`: Popular\n- `newest`: Newest", "required": false, "schema": { "type": "string", "default": "newest", "description": "Instagram Comment Sort Order", "enum": [ "popular", "newest" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "24001500", "x-api-version": "v1", "x-search-aliases": [ "Instagram post comments API", "Instagram comment list", "Instagram comments by shortcode", "Instagram 帖子评论接口", "Instagram 评论列表", "Instagram 按短代码查评论" ], "x-highlights": [], "x-endpoint-family": "instagram_get_post_comments" } }, "/api/instagram/get-comment-replies/v1": { "get": { "tags": [ "Instagram" ], "summary": "Comment Reply List", "description": "Retrieves replies to a specific Instagram post comment by media and comment IDs, with cursor pagination. Use it to inspect threaded discussion and continue through reply pages.", "operationId": "getApiInstagramGetCommentRepliesV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for the API service.", "required": true, "schema": { "type": "string" } }, { "name": "mediaId", "in": "query", "description": "The numeric media ID of the Instagram post.", "required": true, "schema": { "type": "string" } }, { "name": "commentId", "in": "query", "description": "The parent comment ID whose replies are to be retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "minId", "in": "query", "description": "Pagination cursor returned as next_min_child_cursor from the previous response.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "24001600", "x-api-version": "v1", "x-search-aliases": [ "Instagram comment replies API", "Instagram reply list", "Instagram comment thread", "Instagram 评论回复接口", "Instagram 二级评论", "Instagram 子评论列表" ], "x-highlights": [], "x-endpoint-family": "instagram_get_comment_replies" } }, "/api/youtube/search/v1": { "get": { "tags": [ "YouTube" ], "summary": "General Search", "description": "Search YouTube videos by keyword with optional language, upload-date, duration, and sort filters, or continue with a pagination token. Use it to discover public videos or browse additional result pages.", "operationId": "getApiYoutubeSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search term. Required for the first page; leave empty when using nextToken.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "lang", "in": "query", "description": "Optional IETF language tag for localized results, such as en-US. Leave empty to use the default language.", "required": false, "schema": { "type": "string" } }, { "name": "uploadDate", "in": "query", "description": "Upload-date filter.\n\nAvailable Values:\n- `all`: No upload-date limit\n- `lastHour`: Uploaded within the last hour\n- `today`: Uploaded today\n- `thisWeek`: Uploaded this week\n- `thisMonth`: Uploaded this month\n- `thisYear`: Uploaded this year", "required": false, "schema": { "type": "string", "default": "all", "description": "YouTube search upload date filter", "enum": [ "all", "lastHour", "today", "thisWeek", "thisMonth", "thisYear" ] } }, { "name": "duration", "in": "query", "description": "Video-duration filter.\n\nAvailable Values:\n- `all`: No duration limit\n- `SHORT`: Short videos under 4 minutes\n- `medium`: Medium videos from 4 to 20 minutes\n- `LONG`: Long videos over 20 minutes", "required": false, "schema": { "type": "string", "default": "all", "description": "YouTube search video duration filter", "enum": [ "all", "short", "medium", "long", "all", "short", "medium", "long" ] } }, { "name": "sortBy", "in": "query", "description": "Sort order for search results.\n\nAvailable Values:\n- `relevance`: Sort by relevance\n- `uploadDate`: Sort by upload date\n- `viewCount`: Sort by view count\n- `rating`: Sort by rating", "required": false, "schema": { "type": "string", "default": "relevance", "description": "YouTube search sort order", "enum": [ "relevance", "uploadDate", "viewCount", "rating" ] } }, { "name": "nextToken", "in": "query", "description": "Pagination token returned by the previous response. When provided, the keyword and filter parameters are ignored; very long tokens may exceed GET URL limits.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "25000900", "x-api-version": "v1", "x-search-aliases": [ "YouTube search", "YouTube video search", "YouTube filtered search", "YouTube next token search", "YouTube localized search", "YouTube搜索", "YouTube视频搜索", "YouTube筛选搜索", "YouTube翻页搜索", "YouTube本地化搜索" ], "x-highlights": [], "x-endpoint-family": "youtube_search" } }, "/api/youtube/get-video-detail/v1": { "get": { "tags": [ "YouTube" ], "summary": "Video Details", "description": "Retrieve public details for a YouTube video identified by video ID. Use it to inspect a known video before further content or comment analysis.", "operationId": "getApiYoutubeGetVideoDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "videoId", "in": "query", "description": "The unique identifier for a YouTube video.", "required": true, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "description": "Optional IETF language tag for localized video details, such as en-US. Leave empty to use the default language.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "25001000", "x-api-version": "v1", "x-search-aliases": [ "YouTube video details", "YouTube video information", "YouTube video lookup", "YouTube视频详情", "YouTube视频信息", "YouTube视频查询" ], "x-highlights": [], "x-endpoint-family": "youtube_get_video_detail" } }, "/api/youtube/get-channel-videos/v1": { "get": { "tags": [ "YouTube" ], "summary": "Channel Videos", "description": "Retrieve public videos from a YouTube channel, with optional cursor-based pagination. Use it to browse a channel's uploads and continue through additional result pages.", "operationId": "getApiYoutubeGetChannelVideosV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "query", "description": "The unique identifier for a YouTube channel.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "The cursor for pagination.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "25001001", "x-api-version": "v1", "x-search-aliases": [ "YouTube channel videos", "YouTube channel uploads", "YouTube creator video list", "YouTube频道视频", "YouTube频道上传视频", "YouTube创作者视频列表" ], "x-highlights": [], "x-endpoint-family": "youtube_get_channel_videos" } }, "/api/youtube/get-video-captions/v1": { "get": { "tags": [ "YouTube" ], "summary": "Video Captions", "description": "Retrieve available caption tracks for a YouTube video or request captions in SRT, XML, JSON3, or plain-text format. Use it to support transcription, accessibility, localization, or text analysis.", "operationId": "getApiYoutubeGetVideoCaptionsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "videoId", "in": "query", "description": "The unique identifier for a YouTube video.", "required": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "Caption language code, such as en, zh-Hans, or a.en. Leave it empty to retrieve available caption tracks.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "Caption output format.\n\nAvailable Values:\n- `srt`: SubRip caption format with timeline cues\n- `xml`: Original XML caption format\n- `json3`: YouTube original JSON caption structure\n- `txt`: Plain text without timeline cues", "required": false, "schema": { "type": "string", "default": "srt", "description": "YouTube caption output format", "enum": [ "srt", "xml", "json3", "txt" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "25001002", "x-api-version": "v1", "x-search-aliases": [ "YouTube video captions", "YouTube subtitles", "YouTube caption tracks", "YouTube视频字幕", "YouTube字幕文件", "YouTube字幕轨道" ], "x-highlights": [], "x-endpoint-family": "youtube_get_video_captions" } }, "/api/youtube/get-channel-shorts/v1": { "get": { "tags": [ "YouTube" ], "summary": "Channel Shorts", "description": "Retrieve public Shorts from a YouTube channel ID with optional continuation-token pagination. Use it to browse a channel's short-form videos and continue through additional result pages.", "operationId": "getApiYoutubeGetChannelShortsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "query", "description": "The UC-prefixed unique identifier for a YouTube channel. @username handles are not supported.", "required": true, "schema": { "type": "string" } }, { "name": "continuationToken", "in": "query", "description": "Pagination token returned by the previous response.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "25001003", "x-api-version": "v1", "x-search-aliases": [ "YouTube channel Shorts", "YouTube Shorts list", "YouTube creator short videos", "YouTube频道Shorts", "YouTube短视频列表", "YouTube频道短视频" ], "x-highlights": [], "x-endpoint-family": "youtube_get_channel_shorts" } }, "/api/youtube/get-video-comment/v1": { "get": { "tags": [ "YouTube" ], "summary": "Video Comment List", "description": "Retrieve first-level comments for a YouTube video with sorting, locale options, and cursor pagination. Use it to review audience discussion or continue through additional comment pages.", "operationId": "getApiYoutubeGetVideoCommentV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "videoId", "in": "query", "description": "The unique identifier for a YouTube video.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor returned by the previous response.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "languageCode", "in": "query", "description": "Language preference for response data.", "required": false, "schema": { "type": "string", "default": "zh-CN" } }, { "name": "countryCode", "in": "query", "description": "Region code for response data.", "required": false, "schema": { "type": "string", "default": "US" } }, { "name": "sortBy", "in": "query", "description": "Sort order for the comment list.\n\nAvailable Values:\n- `top`: Top comments\n- `newest`: Newest comments", "required": false, "schema": { "type": "string", "default": "newest", "description": "YouTube Comment Sort", "enum": [ "top", "newest" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "25001100", "x-api-version": "v1", "x-search-aliases": [ "YouTube video comments", "YouTube comment list", "YouTube first-level comments", "YouTube视频评论", "YouTube评论列表", "YouTube一级评论" ], "x-highlights": [], "x-endpoint-family": "youtube_get_video_comment" } }, "/api/youtube/get-video-sub-comment/v1": { "get": { "tags": [ "YouTube" ], "summary": "Video Sub Comment List", "description": "Retrieve replies associated with a YouTube comment continuation cursor, with optional locale settings. Use it to follow threaded discussion beyond first-level comments.", "operationId": "getApiYoutubeGetVideoSubCommentV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Reply cursor from a first-level comment response.", "required": true, "schema": { "type": "string" } }, { "name": "languageCode", "in": "query", "description": "Language preference for response data.", "required": false, "schema": { "type": "string", "default": "zh-CN" } }, { "name": "countryCode", "in": "query", "description": "Region code for response data.", "required": false, "schema": { "type": "string", "default": "US" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "25001200", "x-api-version": "v1", "x-search-aliases": [ "YouTube comment replies", "YouTube sub comments", "YouTube threaded replies", "YouTube评论回复", "YouTube二级评论", "YouTube楼中楼评论" ], "x-highlights": [], "x-endpoint-family": "youtube_get_video_sub_comment" } }, "/api/reddit/get-post-detail/v1": { "get": { "tags": [ "Reddit" ], "summary": "Post Details", "description": "Retrieves details for a Reddit post identified by its full post ID. Use it to look up a known post before discussion review, content analysis, or subsequent comment retrieval.", "operationId": "getApiRedditGetPostDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "postId", "in": "query", "description": "The Reddit post identifier in t3_ format.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "26001000", "x-api-version": "v1", "x-search-aliases": [ "Reddit post details API", "Reddit full post ID lookup", "Reddit thread details", "Reddit 帖子详情", "Reddit 帖子 ID 查询", "Reddit 主题详情" ], "x-highlights": [], "x-endpoint-family": "reddit_get_post_detail" } }, "/api/reddit/get-post-comments/v1": { "get": { "tags": [ "Reddit" ], "summary": "Post Comments", "description": "Retrieves comments for a Reddit post with pagination-token support. Use it to review a thread's discussion or continue through additional comment results for a known post.", "operationId": "getApiRedditGetPostCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "postId", "in": "query", "description": "The unique identifier of the Reddit post.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination token for the next page of results.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "26001100", "x-api-version": "v1", "x-search-aliases": [ "Reddit post comments API", "Reddit thread comments", "Reddit comment pagination", "Reddit 帖子评论", "Reddit 讨论评论列表", "Reddit 评论分页" ], "x-highlights": [], "x-endpoint-family": "reddit_get_post_comments" } }, "/api/reddit/search/v1": { "get": { "tags": [ "Reddit" ], "summary": "Keyword Search", "description": "Searches Reddit posts by keyword with an optional continuation token. Use it to discover topic-related discussions or continue through additional search-result pages.", "operationId": "getApiRedditSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search query keywords.", "required": true, "schema": { "type": "string" } }, { "name": "after", "in": "query", "description": "Pagination token to retrieve the next set of results.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "26001200", "x-api-version": "v1", "x-search-aliases": [ "Reddit keyword search API", "Reddit post search", "Reddit discussion search", "Reddit 关键词搜索", "Reddit 帖子搜索", "Reddit 讨论查询" ], "x-highlights": [], "x-endpoint-family": "reddit_search" } }, "/api/toutiao/get-article-detail/v1": { "get": { "tags": [ "Toutiao" ], "summary": "Article Details", "description": "Retrieves details for a Toutiao article identified by its article ID. Use it to look up a known article for content review, archiving, or related media analysis.", "operationId": "getApiToutiaoGetArticleDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token required to access the API.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The unique identifier of the Toutiao article.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "27001000", "x-api-version": "v1", "x-search-aliases": [ "Toutiao article details API", "Toutiao article ID lookup", "Toutiao post details", "今日头条文章详情", "头条文章 ID 查询", "头条内容详情" ], "x-highlights": [], "x-endpoint-family": "toutiao_get_article_detail" } }, "/api/toutiao/get-video-detail/v1": { "get": { "tags": [ "Toutiao" ], "summary": "Video Details", "description": "Retrieves details for a Toutiao video identified by its video ID. Use it to look up a known video for content review, archiving, or related media analysis.", "operationId": "getApiToutiaoGetVideoDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token required to access the API.", "required": true, "schema": { "type": "string" } }, { "name": "videoId", "in": "query", "description": "The unique identifier of the Toutiao video.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "27001050", "x-api-version": "v1", "x-search-aliases": [ "Toutiao video details API", "Toutiao video ID lookup", "Toutiao video information", "今日头条视频详情", "头条视频 ID 查询", "头条视频信息" ], "x-highlights": [], "x-endpoint-family": "toutiao_get_video_detail" } }, "/api/toutiao/get-user-detail/v1": { "get": { "tags": [ "Toutiao" ], "summary": "User Profile", "description": "Retrieves a Toutiao user profile identified by user ID. Use it to look up a known account for creator research, profile review, or related article analysis.", "operationId": "getApiToutiaoGetUserDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token required to access the API.", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "The unique identifier of the Toutiao user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "27001100", "x-api-version": "v1", "x-search-aliases": [ "Toutiao user profile API", "Toutiao user ID lookup", "Toutiao creator profile", "今日头条用户资料", "头条用户 ID 查询", "头条创作者信息" ], "x-highlights": [], "x-endpoint-family": "toutiao_get_user_detail" } }, "/api/toutiao/get-user-id/v1": { "get": { "tags": [ "Toutiao" ], "summary": "User ID", "description": "Resolves the user ID associated with a Toutiao profile URL. Use it to convert a known profile link into the identifier required for subsequent user-profile lookups.", "operationId": "getApiToutiaoGetUserIdV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token required to access the API.", "required": true, "schema": { "type": "string" } }, { "name": "userProfileUrl", "in": "query", "description": "The Toutiao user profile URL used to resolve the user ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "27001150", "x-api-version": "v1", "x-search-aliases": [ "Toutiao profile URL resolver", "Toutiao user ID extraction", "Toutiao profile link lookup", "今日头条用户 ID 解析", "头条主页链接转用户 ID", "头条用户链接解析" ], "x-highlights": [], "x-endpoint-family": "toutiao_get_user_id" } }, "/api/toutiao/search/v2": { "get": { "tags": [ "Toutiao" ], "summary": "Web Keyword Search", "description": "Searches Toutiao web articles by keyword. Use it to discover relevant articles for topic research, media monitoring, or source collection.", "operationId": "getApiToutiaoSearchV2", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token required to access the API.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword or query.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "27001300", "x-api-version": "v2", "x-search-aliases": [ "Toutiao web article search", "Toutiao keyword search API", "Toutiao article discovery", "今日头条文章搜索", "头条关键词搜索", "头条网页内容查询" ], "x-highlights": [ { "type": "warning", "kind": "LIMITATION", "content": "This endpoint returns only the first page of search results.", "concept": "multi_page_pagination", "aliases": [ "multi-page results", "pagination", "多页结果", "翻页" ] } ], "x-endpoint-family": "toutiao_search" } }, "/api/zhihu/get-column-article-detail/v1": { "get": { "tags": [ "Zhihu" ], "summary": "Column Article Details", "description": "Retrieve details for a Zhihu column article identified by article ID. Use it to inspect a known article for reading, review, or archiving.", "operationId": "getApiZhihuGetColumnArticleDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Article ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001000", "x-api-version": "v1", "x-search-aliases": [ "Zhihu column article details", "Zhihu article lookup", "Zhihu column post details", "知乎专栏文章详情", "知乎文章查询", "知乎专栏内容详情" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_column_article_detail" } }, "/api/zhihu/get-answer-list/v1": { "get": { "tags": [ "Zhihu" ], "summary": "Answer List", "description": "Retrieve answers for a Zhihu question with sorting and pagination controls. Use it to browse responses to a known question and continue through additional answer pages.", "operationId": "getApiZhihuGetAnswerListV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "questionId", "in": "query", "description": "Question ID", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor from previous result.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "order", "in": "query", "description": "Sorting criteria for answers.\n\nAvailable Values:\n- `_default`: Default sorting.\n- `_updated`: Sorted by updated time.", "required": false, "schema": { "type": "string", "default": "_updated", "description": "Zhihu answer sorting order.", "enum": [ "_default", "_updated" ] } }, { "name": "sessionId", "in": "query", "description": "Session ID from previous result.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001100", "x-api-version": "v1", "x-search-aliases": [ "Zhihu question answers", "Zhihu answer list", "Zhihu question response list", "知乎问题回答", "知乎回答列表", "知乎问题答案列表" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_answer_list" } }, "/api/zhihu/search/v1": { "get": { "tags": [ "Zhihu" ], "summary": "Keyword Search", "description": "Search Zhihu by keyword with optional result-type, sort, time-interval, topic-display, and offset controls. Use it to find relevant answers, articles, or videos.", "operationId": "getApiZhihuSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keywords.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "showAllTopics", "in": "query", "description": "Whether to show all topics.\n\nAvailable Values:\n- `FALSE`: Do not show topics.\n- `TRUE`: Show all topics.", "required": false, "schema": { "type": "string", "default": "FALSE", "description": "Zhihu search topic display switch.", "enum": [ "FALSE", "TRUE" ] } }, { "name": "vertical", "in": "query", "description": "Result type filter.\n\nAvailable Values:\n- `answer`: Answers only.\n- `article`: Articles only.\n- `zvideo`: Videos only.", "required": false, "schema": { "type": "string", "description": "Zhihu search result type.", "enum": [ "answer", "article", "zvideo" ] } }, { "name": "sort", "in": "query", "description": "Sorting criteria.\n\nAvailable Values:\n- `upvoted_count`: Most upvoted.\n- `created_time`: Latest published.", "required": false, "schema": { "type": "string", "description": "Zhihu search sorting criteria.", "enum": [ "upvoted_count", "created_time" ] } }, { "name": "timeInterval", "in": "query", "description": "Publish time interval filter.\n\nAvailable Values:\n- `a_day`: Within one day.\n- `a_week`: Within one week.\n- `a_month`: Within one month.\n- `three_months`: Within three months.\n- `half_a_year`: Within half a year.\n- `a_year`: Within one year.", "required": false, "schema": { "type": "string", "description": "Zhihu search publish time interval.", "enum": [ "a_day", "a_week", "a_month", "three_months", "half_a_year", "a_year" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001200", "x-api-version": "v1", "x-search-aliases": [ "Zhihu keyword search", "Zhihu content search", "Zhihu answer article video search", "知乎关键词搜索", "知乎内容搜索", "知乎回答文章视频搜索" ], "x-highlights": [], "x-endpoint-family": "zhihu_search" } }, "/api/zhihu/get-column-article-list/v1": { "get": { "tags": [ "Zhihu" ], "summary": "Column Article List", "description": "Retrieve articles from a Zhihu column with offset pagination. Use it to browse a known column's publication history and select articles for detail lookup.", "operationId": "getApiZhihuGetColumnArticleListV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "columnId", "in": "query", "description": "Column ID", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001300", "x-api-version": "v1", "x-search-aliases": [ "Zhihu column articles", "Zhihu column article list", "Zhihu column posts", "知乎专栏文章", "知乎专栏文章列表", "知乎专栏内容" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_column_article_list" } }, "/api/zhihu/get-user-info/v1": { "get": { "tags": [ "Zhihu" ], "summary": "User Info", "description": "Retrieve the public profile for a Zhihu user identified by URL token. Use it to inspect an account found through Zhihu content or relationship data.", "operationId": "getApiZhihuGetUserInfoV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "userUrlToken", "in": "query", "description": "Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001400", "x-api-version": "v1", "x-search-aliases": [ "Zhihu user profile", "Zhihu account details", "Zhihu user lookup", "知乎用户资料", "知乎账号详情", "知乎用户查询" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_user_info" } }, "/api/zhihu/get-user-followees/v1": { "get": { "tags": [ "Zhihu" ], "summary": "User Followees", "description": "Retrieve accounts followed by a Zhihu user, with offset pagination. Use it to explore the outgoing connections of a known account.", "operationId": "getApiZhihuGetUserFolloweesV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "userUrlToken", "in": "query", "description": "Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001500", "x-api-version": "v1", "x-search-aliases": [ "Zhihu user followees", "Zhihu followed accounts", "Zhihu following list", "知乎用户关注的人", "知乎关注账号列表", "知乎用户关注列表" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_user_followees" } }, "/api/zhihu/get-user-followers/v1": { "get": { "tags": [ "Zhihu" ], "summary": "User Followers", "description": "Retrieve accounts that follow a Zhihu user, with offset pagination. Use it to explore the audience connections of a known account.", "operationId": "getApiZhihuGetUserFollowersV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "userUrlToken", "in": "query", "description": "Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001600", "x-api-version": "v1", "x-search-aliases": [ "Zhihu user followers", "Zhihu follower list", "Zhihu account followers", "知乎用户粉丝", "知乎粉丝列表", "知乎账号关注者" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_user_followers" } }, "/api/zhihu/get-user-articles/v1": { "get": { "tags": [ "Zhihu" ], "summary": "User Articles", "description": "Retrieve articles published by a Zhihu user with offset pagination and publish-time or upvote sorting. Use it to browse a creator's articles in the selected order.", "operationId": "getApiZhihuGetUserArticlesV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "userUrlToken", "in": "query", "description": "Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sortType", "in": "query", "description": "Sorting criteria for user articles.\n\nAvailable Values:\n- `created`: Sort by publish time.\n- `voteups`: Sort by upvote count.", "required": false, "schema": { "type": "string", "default": "created", "description": "Zhihu user article sorting type.", "enum": [ "created", "voteups" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001700", "x-api-version": "v1", "x-search-aliases": [ "Zhihu user articles", "Zhihu creator article list", "Zhihu published articles", "知乎用户文章", "知乎创作者文章列表", "知乎用户发布文章" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_user_articles" } }, "/api/zhihu/get-user-included-articles/v1": { "get": { "tags": [ "Zhihu" ], "summary": "User Included Articles", "description": "Retrieve the included-article records exposed for a Zhihu user, with offset pagination. Use it to browse that account's included-article list.", "operationId": "getApiZhihuGetUserIncludedArticlesV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "userUrlToken", "in": "query", "description": "Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001800", "x-api-version": "v1", "x-search-aliases": [ "Zhihu user included articles", "Zhihu included article list", "Zhihu account included articles", "知乎用户收录文章", "知乎收录文章列表", "知乎账号收录文章" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_user_included_articles" } }, "/api/zhihu/get-user-follow-columns/v1": { "get": { "tags": [ "Zhihu" ], "summary": "User Follow Columns", "description": "Retrieve Zhihu columns followed by a user, with offset pagination. Use it to browse the columns associated with a known account's follow activity.", "operationId": "getApiZhihuGetUserFollowColumnsV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "userUrlToken", "in": "query", "description": "Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28001900", "x-api-version": "v1", "x-search-aliases": [ "Zhihu followed columns", "Zhihu user column follows", "Zhihu subscribed column list", "知乎关注专栏", "知乎用户关注的专栏", "知乎专栏关注列表" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_user_follow_columns" } }, "/api/zhihu/get-user-follow-collections/v1": { "get": { "tags": [ "Zhihu" ], "summary": "User Follow Collections", "description": "Retrieve Zhihu collections followed by a user, with offset pagination. Use it to browse the collections associated with a known account's follow activity.", "operationId": "getApiZhihuGetUserFollowCollectionsV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "userUrlToken", "in": "query", "description": "Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28002100", "x-api-version": "v1", "x-search-aliases": [ "Zhihu followed collections", "Zhihu user collection follows", "Zhihu subscribed collection list", "知乎关注收藏夹", "知乎用户关注的收藏夹", "知乎收藏夹关注列表" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_user_follow_collections" } }, "/api/zhihu/get-user-follow-topics/v1": { "get": { "tags": [ "Zhihu" ], "summary": "User Follow Topics", "description": "Retrieve Zhihu topics followed by a user, with offset pagination. Use it to browse the topics associated with a known account's follow activity.", "operationId": "getApiZhihuGetUserFollowTopicsV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "userUrlToken", "in": "query", "description": "Zhihu user URL token, such as the value in `zhihu.com/people/{userUrlToken}`.", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset, begins with 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28002200", "x-api-version": "v1", "x-search-aliases": [ "Zhihu followed topics", "Zhihu user topic follows", "Zhihu subscribed topic list", "知乎关注话题", "知乎用户关注的话题", "知乎话题关注列表" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_user_follow_topics" } }, "/api/zhihu/get-answer-comments/v1": { "get": { "tags": [ "Zhihu" ], "summary": "Answer Comments", "description": "Retrieve comments for a Zhihu answer with hottest or latest sorting and offset pagination. Use it to review discussion around a known answer and continue through additional comment pages.", "operationId": "getApiZhihuGetAnswerCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "answerId", "in": "query", "description": "Answer ID", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "Sorting order for comments.\n\nAvailable Values:\n- `score`: Sort by highest score.\n- `ts`: Sort by latest time.", "required": false, "schema": { "type": "string", "default": "score", "description": "Zhihu comment sorting order.", "enum": [ "score", "ts" ] } }, { "name": "offset", "in": "query", "description": "Pagination offset from the previous result.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28002300", "x-api-version": "v1", "x-search-aliases": [ "Zhihu answer comments", "Zhihu answer discussion", "Zhihu comment list", "知乎回答评论", "知乎回答讨论", "知乎评论列表" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_answer_comments" } }, "/api/zhihu/get-comment-replies/v1": { "get": { "tags": [ "Zhihu" ], "summary": "Comment Replies", "description": "Retrieve replies to a Zhihu comment with hottest or latest sorting and offset pagination. Use it to follow discussion under a known comment and continue through additional reply pages.", "operationId": "getApiZhihuGetCommentRepliesV1", "parameters": [ { "name": "token", "in": "query", "description": "TOKEN", "required": true, "schema": { "type": "string" } }, { "name": "commentId", "in": "query", "description": "Comment ID", "required": true, "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "Sorting order for replies.\n\nAvailable Values:\n- `score`: Sort by highest score.\n- `ts`: Sort by latest time.", "required": false, "schema": { "type": "string", "default": "score", "description": "Zhihu comment sorting order.", "enum": [ "score", "ts" ] } }, { "name": "offset", "in": "query", "description": "Pagination offset from the previous result.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "28002400", "x-api-version": "v1", "x-search-aliases": [ "Zhihu comment replies", "Zhihu subcomments", "Zhihu reply list", "知乎评论回复", "知乎子评论", "知乎回复列表" ], "x-highlights": [], "x-endpoint-family": "zhihu_get_comment_replies" } }, "/api/amazon/search-products/v1": { "get": { "tags": [ "Amazon" ], "summary": "Product Search", "description": "Searches Amazon marketplace products by keyword or ASIN with country, sort, condition, Prime-only, deals, and page controls. Use it to discover products for catalog research, price comparison, or competitive assortment analysis.", "operationId": "getApiAmazonSearchProductsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword or ASIN to find Amazon products.", "required": true, "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country code for the Amazon marketplace.\n\nAvailable Values:\n- `US`: United States\n- `AU`: Australia\n- `BR`: Brazil\n- `CA`: Canada\n- `CN`: China\n- `FR`: France\n- `DE`: Germany\n- `IN`: India\n- `IT`: Italy\n- `MX`: Mexico\n- `NL`: Netherlands\n- `SG`: Singapore\n- `ES`: Spain\n- `TR`: Turkey\n- `AE`: United Arab Emirates\n- `GB`: United Kingdom\n- `JP`: Japan\n- `SA`: Saudi Arabia\n- `PL`: Poland\n- `SE`: Sweden\n- `BE`: Belgium\n- `EG`: Egypt\n- `ZA`: South Africa\n- `IE`: Ireland", "required": false, "schema": { "type": "string", "default": "US", "description": "Amazon Country", "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ] } }, { "name": "sortBy", "in": "query", "description": "Sort order for Amazon product search results.\n\nAvailable Values:\n- `RELEVANCE`: Relevance\n- `LOWEST_PRICE`: Lowest Price\n- `HIGHEST_PRICE`: Highest Price\n- `REVIEWS`: Reviews\n- `NEWEST`: Newest\n- `BEST_SELLERS`: Best Sellers", "required": false, "schema": { "type": "string", "default": "RELEVANCE", "description": "Amazon Sort By", "enum": [ "RELEVANCE", "LOWEST_PRICE", "HIGHEST_PRICE", "REVIEWS", "NEWEST", "BEST_SELLERS" ] } }, { "name": "productCondition", "in": "query", "description": "Product condition filter for Amazon search results.\n\nAvailable Values:\n- `ALL`: All product conditions\n- `NEW`: New products\n- `USED`: Used products\n- `RENEWED`: Renewed products\n- `COLLECTIBLE`: Collectible products", "required": false, "schema": { "type": "string", "default": "ALL", "description": "Amazon Product Condition", "enum": [ "ALL", "NEW", "USED", "RENEWED", "COLLECTIBLE" ] } }, { "name": "isPrime", "in": "query", "description": "Whether to return only Prime-eligible products.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "dealsAndDiscounts", "in": "query", "description": "Deals and discounts filter for Amazon search results.\n\nAvailable Values:\n- `NONE`: Do not filter by deals or discounts\n- `ALL_DISCOUNTS`: Return discounted products\n- `TODAYS_DEALS`: Return today's deals", "required": false, "schema": { "type": "string", "default": "NONE", "description": "Amazon Deals And Discounts", "enum": [ "NONE", "ALL_DISCOUNTS", "TODAYS_DEALS" ] } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "29000900", "x-api-version": "v1", "x-search-aliases": [ "Amazon product search API", "Amazon keyword or ASIN search", "Amazon marketplace product finder", "亚马逊商品搜索", "亚马逊关键词找商品", "亚马逊 ASIN 商品查询" ], "x-highlights": [], "x-endpoint-family": "amazon_search_products" } }, "/api/amazon/get-product-detail/v1": { "get": { "tags": [ "Amazon" ], "summary": "Product Details", "description": "Retrieves details for an Amazon product identified by ASIN in a selected country marketplace. Use it to look up a known listing for catalog review, product comparison, or downstream commerce analysis.", "operationId": "getApiAmazonGetProductDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "asin", "in": "query", "description": "ASIN (Amazon Standard Identification Number).", "required": true, "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country code for the Amazon product.\n\nAvailable Values:\n- `US`: United States\n- `AU`: Australia\n- `BR`: Brazil\n- `CA`: Canada\n- `CN`: China\n- `FR`: France\n- `DE`: Germany\n- `IN`: India\n- `IT`: Italy\n- `MX`: Mexico\n- `NL`: Netherlands\n- `SG`: Singapore\n- `ES`: Spain\n- `TR`: Turkey\n- `AE`: United Arab Emirates\n- `GB`: United Kingdom\n- `JP`: Japan\n- `SA`: Saudi Arabia\n- `PL`: Poland\n- `SE`: Sweden\n- `BE`: Belgium\n- `EG`: Egypt\n- `ZA`: South Africa\n- `IE`: Ireland", "required": false, "schema": { "type": "string", "default": "US", "description": "Amazon Country", "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "29001000", "x-api-version": "v1", "x-search-aliases": [ "Amazon product details API", "Amazon ASIN lookup", "Amazon marketplace listing details", "亚马逊商品详情", "亚马逊 ASIN 查询", "亚马逊商品信息" ], "x-highlights": [], "x-endpoint-family": "amazon_get_product_detail" } }, "/api/amazon/get-product-top-reviews/v1": { "get": { "tags": [ "Amazon" ], "summary": "Product Top Reviews", "description": "Retrieves the top reviews for an Amazon product identified by ASIN in a selected country marketplace. Use it to review prominent customer feedback for product research, sentiment analysis, or quality assessment.", "operationId": "getApiAmazonGetProductTopReviewsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "asin", "in": "query", "description": "ASIN (Amazon Standard Identification Number).", "required": true, "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country code for the Amazon product.\n\nAvailable Values:\n- `US`: United States\n- `AU`: Australia\n- `BR`: Brazil\n- `CA`: Canada\n- `CN`: China\n- `FR`: France\n- `DE`: Germany\n- `IN`: India\n- `IT`: Italy\n- `MX`: Mexico\n- `NL`: Netherlands\n- `SG`: Singapore\n- `ES`: Spain\n- `TR`: Turkey\n- `AE`: United Arab Emirates\n- `GB`: United Kingdom\n- `JP`: Japan\n- `SA`: Saudi Arabia\n- `PL`: Poland\n- `SE`: Sweden\n- `BE`: Belgium\n- `EG`: Egypt\n- `ZA`: South Africa\n- `IE`: Ireland", "required": false, "schema": { "type": "string", "default": "US", "description": "Amazon Country", "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "29001100", "x-api-version": "v1", "x-search-aliases": [ "Amazon top product reviews API", "Amazon ASIN review lookup", "Amazon customer review research", "亚马逊商品热门评论", "亚马逊 ASIN 评论查询", "亚马逊买家评价" ], "x-highlights": [], "x-endpoint-family": "amazon_get_product_top_reviews" } }, "/api/amazon/get-best-sellers/v1": { "get": { "tags": [ "Amazon" ], "summary": "Best Sellers", "description": "Retrieves paginated Amazon Best Sellers for a category path in a selected country marketplace. Use it to study category leaders, discover popular products, or compare bestseller pages across marketplaces.", "operationId": "getApiAmazonGetBestSellersV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Best Sellers category path taken from an Amazon Best Sellers URL. It may be a category slug or a nested category path.", "required": true, "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country code for the Amazon product.\n\nAvailable Values:\n- `US`: United States\n- `AU`: Australia\n- `BR`: Brazil\n- `CA`: Canada\n- `CN`: China\n- `FR`: France\n- `DE`: Germany\n- `IN`: India\n- `IT`: Italy\n- `MX`: Mexico\n- `NL`: Netherlands\n- `SG`: Singapore\n- `ES`: Spain\n- `TR`: Turkey\n- `AE`: United Arab Emirates\n- `GB`: United Kingdom\n- `JP`: Japan\n- `SA`: Saudi Arabia\n- `PL`: Poland\n- `SE`: Sweden\n- `BE`: Belgium\n- `EG`: Egypt\n- `ZA`: South Africa\n- `IE`: Ireland", "required": false, "schema": { "type": "string", "default": "US", "description": "Amazon Country", "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ] } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "29001200", "x-api-version": "v1", "x-search-aliases": [ "Amazon Best Sellers API", "Amazon category bestseller list", "Amazon marketplace best sellers", "亚马逊畅销榜", "亚马逊类目热销商品", "亚马逊站点畅销榜" ], "x-highlights": [], "x-endpoint-family": "amazon_get_best_sellers" } }, "/api/amazon/get-category-products/v1": { "get": { "tags": [ "Amazon" ], "summary": "Products By Category", "description": "Retrieves paginated Amazon products for a numeric category node in a selected country marketplace, with configurable result sorting. Use it to browse a category, compare assortments, or collect category-specific product candidates.", "operationId": "getApiAmazonGetCategoryProductsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "query", "description": "Numeric Amazon category node ID taken from the node query parameter of a category URL.", "required": true, "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country code for the Amazon product.\n\nAvailable Values:\n- `US`: United States\n- `AU`: Australia\n- `BR`: Brazil\n- `CA`: Canada\n- `CN`: China\n- `FR`: France\n- `DE`: Germany\n- `IN`: India\n- `IT`: Italy\n- `MX`: Mexico\n- `NL`: Netherlands\n- `SG`: Singapore\n- `ES`: Spain\n- `TR`: Turkey\n- `AE`: United Arab Emirates\n- `GB`: United Kingdom\n- `JP`: Japan\n- `SA`: Saudi Arabia\n- `PL`: Poland\n- `SE`: Sweden\n- `BE`: Belgium\n- `EG`: Egypt\n- `ZA`: South Africa\n- `IE`: Ireland", "required": false, "schema": { "type": "string", "default": "US", "description": "Amazon Country", "enum": [ "US", "AU", "BR", "CA", "CN", "FR", "DE", "IN", "IT", "MX", "NL", "SG", "ES", "TR", "AE", "GB", "JP", "SA", "PL", "SE", "BE", "EG", "ZA", "IE" ] } }, { "name": "sortBy", "in": "query", "description": "Sort by.\n\nAvailable Values:\n- `RELEVANCE`: Relevance\n- `LOWEST_PRICE`: Lowest Price\n- `HIGHEST_PRICE`: Highest Price\n- `REVIEWS`: Reviews\n- `NEWEST`: Newest\n- `BEST_SELLERS`: Best Sellers", "required": false, "schema": { "type": "string", "default": "RELEVANCE", "description": "Amazon Sort By", "enum": [ "RELEVANCE", "LOWEST_PRICE", "HIGHEST_PRICE", "REVIEWS", "NEWEST", "BEST_SELLERS" ] } }, { "name": "page", "in": "query", "description": "Page number for pagination.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "29001300", "x-api-version": "v1", "x-search-aliases": [ "Amazon category products API", "Amazon category node products", "Amazon marketplace category browse", "亚马逊类目商品", "亚马逊类目节点查询", "亚马逊分类商品列表" ], "x-highlights": [], "x-endpoint-family": "amazon_get_category_products" } }, "/api/facebook/search-post/v1": { "get": { "tags": [ "Facebook" ], "summary": "Post Search", "description": "Searches public Facebook posts by keyword with optional inclusive date-range filters and cursor pagination. Use it to find topic-related posts or continue a time-bounded public-content search.", "operationId": "getApiFacebookSearchPostV1", "parameters": [ { "name": "token", "in": "query", "description": "User security token for API access authentication.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Keyword to search for in public posts. Supports basic text matching.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Start date for the search range (inclusive), formatted as yyyy-MM-dd.", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "End date for the search range (inclusive), formatted as yyyy-MM-dd.", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor for fetching the next set of results.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "30001000", "x-api-version": "v1", "x-search-aliases": [ "Facebook public post search", "Facebook keyword post search", "Facebook posts by date range", "Facebook 公开帖子搜索", "Facebook 关键词帖子查询", "Facebook 按日期搜索帖子" ], "x-highlights": [], "x-endpoint-family": "facebook_search_post" } }, "/api/facebook/get-profile-id/v1": { "get": { "tags": [ "Facebook" ], "summary": "Get Profile ID", "description": "Resolves the Facebook profile ID associated with a submitted profile-path value. Use it to obtain the identifier required before retrieving posts for a known public profile.", "operationId": "getApiFacebookGetProfileIdV1", "parameters": [ { "name": "token", "in": "query", "description": "User security token for API access authentication.", "required": true, "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "The path portion of the Facebook profile URL, such as /. Do not include the scheme or host.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "30001010", "x-api-version": "v1", "x-search-aliases": [ "Facebook profile ID resolver", "Facebook profile path lookup", "Facebook user ID from profile path", "Facebook 主页 ID 解析", "Facebook 主页路径查询", "Facebook 用户 ID 获取" ], "x-highlights": [], "x-endpoint-family": "facebook_get_profile_id" } }, "/api/facebook/get-profile-posts/v1": { "get": { "tags": [ "Facebook" ], "summary": "Get Profile Posts", "description": "Retrieves public posts for a Facebook profile ID with cursor pagination. Use it to browse a known profile's public posting history or continue through subsequent post pages.", "operationId": "getApiFacebookGetProfilePostsV1", "parameters": [ { "name": "token", "in": "query", "description": "User security token for API access authentication.", "required": true, "schema": { "type": "string" } }, { "name": "profileId", "in": "query", "description": "The unique Facebook profile ID.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor for fetching the next set of results.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "30001020", "x-api-version": "v1", "x-search-aliases": [ "Facebook profile posts API", "Facebook public user posts", "Facebook posts by profile ID", "Facebook 主页帖子", "Facebook 用户公开帖子", "Facebook 按主页 ID 查询帖子" ], "x-highlights": [], "x-endpoint-family": "facebook_get_profile_posts" } }, "/api/facebook/get-post-comments/v1": { "get": { "tags": [ "Facebook" ], "summary": "Post Comments", "description": "Retrieves comments for a Facebook post ID with cursor pagination. Use it to review discussion associated with a known public post or continue through subsequent comment pages.", "operationId": "getApiFacebookGetPostCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "User security token for API access authentication.", "required": true, "schema": { "type": "string" } }, { "name": "postId", "in": "query", "description": "The unique identifier of the Facebook post.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor for fetching the next set of comments.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "30001030", "x-api-version": "v1", "x-search-aliases": [ "Facebook post comments API", "Facebook public post comments", "Facebook comments by post ID", "Facebook 帖子评论", "Facebook 公开帖子评论", "Facebook 按帖子 ID 查询评论" ], "x-highlights": [], "x-endpoint-family": "facebook_get_post_comments" } }, "/api/facebook/get-comment-replies/v1": { "get": { "tags": [ "Facebook" ], "summary": "Comment Replies", "description": "Retrieves replies to a specific Facebook post comment using the legacy post ID, comment ID, and expansion token. Use it to inspect a known comment's nested discussion.", "operationId": "getApiFacebookGetCommentRepliesV1", "parameters": [ { "name": "token", "in": "query", "description": "User security token for API access authentication.", "required": true, "schema": { "type": "string" } }, { "name": "postId", "in": "query", "description": "The legacy numeric identifier of the Facebook post.", "required": true, "schema": { "type": "string" } }, { "name": "commentId", "in": "query", "description": "The unique identifier of the parent Facebook comment.", "required": true, "schema": { "type": "string" } }, { "name": "expansionToken", "in": "query", "description": "The expansion token associated with the parent Facebook comment.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": "30001040", "x-api-version": "v1", "x-search-aliases": [ "Facebook comment replies API", "Facebook nested comments", "Facebook replies by comment ID", "Facebook 评论回复", "Facebook 二级评论", "Facebook 按评论 ID 查询回复" ], "x-highlights": [], "x-endpoint-family": "facebook_get_comment_replies" } }, "/api/twitter/search/v1": { "get": { "tags": [ "Twitter" ], "summary": "Search Timeline", "description": "Searches X (Twitter) by keyword across top, latest, media, people, or list result modes with cursor pagination. Use it to find public conversations, accounts, media, or lists related to a topic.", "operationId": "getApiTwitterSearchV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token required for API access.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Search keyword.", "required": true, "schema": { "type": "string" } }, { "name": "searchType", "in": "query", "description": "Search result type.\n\nAvailable Values:\n- `TOP`: Top search results\n- `LATEST`: Latest search results\n- `MEDIA`: Media search results\n- `PEOPLE`: People search results\n- `LISTS`: List search results", "required": false, "schema": { "type": "string", "default": "Top", "description": "Twitter search type", "enum": [ "TOP", "LATEST", "MEDIA", "PEOPLE", "LISTS" ] } }, { "name": "cursor", "in": "query", "description": "Pagination cursor returned by the previous response.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 31000900, "x-api-version": "v1", "x-search-aliases": [ "X Twitter search API", "Twitter timeline search", "Twitter keyword search by type", "X 推特搜索接口", "Twitter 时间线搜索", "推特关键词分类搜索" ], "x-highlights": [], "x-endpoint-family": "twitter_search" } }, "/api/twitter/get-user-detail/v1": { "get": { "tags": [ "Twitter" ], "summary": "User Profile", "description": "Retrieves an X (Twitter) user profile identified by its numeric Rest ID. Use it to review a known account before monitoring its posts or conducting creator and account research.", "operationId": "getApiTwitterGetUserDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token required for API access.", "required": true, "schema": { "type": "string" } }, { "name": "restId", "in": "query", "description": "The unique numeric identifier (Rest ID) for the X user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 31001000, "x-api-version": "v1", "x-search-aliases": [ "X Twitter user profile API", "Twitter Rest ID lookup", "Twitter account details", "X 推特用户资料", "Twitter Rest ID 查询", "推特账号信息" ], "x-highlights": [], "x-endpoint-family": "twitter_get_user_detail" } }, "/api/twitter/get-user-posts/v1": { "get": { "tags": [ "Twitter" ], "summary": "User Published Posts", "description": "Retrieves posts published by an X (Twitter) user identified by Rest ID, with cursor pagination. Use it to browse a known account's timeline or continue through its public post history.", "operationId": "getApiTwitterGetUserPostsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token required for API access.", "required": true, "schema": { "type": "string" } }, { "name": "restId", "in": "query", "description": "The unique numeric identifier (Rest ID) for the X user.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor for navigating through long timelines.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 31001100, "x-api-version": "v1", "x-search-aliases": [ "X Twitter user posts API", "Twitter account timeline", "Twitter posts by Rest ID", "X 推特用户帖子", "Twitter 用户时间线", "推特账号发布内容" ], "x-highlights": [], "x-endpoint-family": "twitter_get_user_posts" } }, "/api/twitter/get-post-comments/v1": { "get": { "tags": [ "Twitter" ], "summary": "Post Comments", "description": "Retrieves the latest comments for an X (Twitter) post identified by tweet ID, with cursor pagination. Use it to review recent discussion on a known post and continue through additional comment pages.", "operationId": "getApiTwitterGetPostCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token required for API access.", "required": true, "schema": { "type": "string" } }, { "name": "tweetId", "in": "query", "description": "The unique identifier of the X (Twitter) post.", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Pagination cursor returned by the previous response.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 31001200, "x-api-version": "v1", "x-search-aliases": [ "X Twitter post comments API", "Twitter latest comments by tweet ID", "Twitter comment cursor pagination", "X 推特帖子评论接口", "Twitter 最新评论", "推特评论游标分页" ], "x-highlights": [], "x-endpoint-family": "twitter_get_post_comments" } }, "/api/linkedin/search-user/v1": { "get": { "tags": [ "LinkedIn" ], "summary": "People Search", "description": "This LinkedIn people-search endpoint is deprecated because the capability is no longer available. Existing integrations should stop sending requests.", "operationId": "getApiLinkedinSearchUserV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name or general keyword to search for.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "firstName", "in": "query", "description": "First name filter.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "lastName", "in": "query", "description": "Last name filter.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "title", "in": "query", "description": "Professional title filter.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "company", "in": "query", "description": "Company name filter.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "school", "in": "query", "description": "School name filter.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "Page number, starting from 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "geocodeLocation", "in": "query", "description": "LinkedIn geographic location code.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "currentCompany", "in": "query", "description": "LinkedIn current company ID filter.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "profileLanguage", "in": "query", "description": "Profile language filter.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "industry", "in": "query", "description": "LinkedIn industry ID filter.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "serviceCategory", "in": "query", "description": "LinkedIn service category ID filter.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": 31500900, "x-api-version": "v1", "x-search-aliases": [ "LinkedIn people search API", "LinkedIn professional search", "LinkedIn employee discovery", "领英人员搜索", "LinkedIn 职位搜索人员", "领英公司人员查找" ], "x-highlights": [], "x-endpoint-family": "linkedin_search_user" } }, "/api/linkedin/get-user-detail/v1": { "get": { "tags": [ "LinkedIn" ], "summary": "User Profile", "description": "Retrieves a LinkedIn profile by username, including documented core profile fields such as name and headline. Use it to inspect a person's professional background or before requesting published posts.", "operationId": "getApiLinkedinGetUserDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "LinkedIn username from the profile URL, for example jack from linkedin.com/in/jack.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 31501000, "x-api-version": "v1", "x-search-aliases": [ "LinkedIn user profile API", "LinkedIn name and headline lookup", "LinkedIn profile username lookup", "领英个人资料", "LinkedIn 姓名职位查询", "领英用户名查询" ], "x-highlights": [], "x-endpoint-family": "linkedin_get_user_detail" } }, "/api/linkedin/get-company-employees/v1": { "get": { "tags": [ "LinkedIn" ], "summary": "Company Employees", "description": "This LinkedIn company-employee endpoint is deprecated because the capability is no longer available. Existing integrations should stop sending requests.", "operationId": "getApiLinkedinGetCompanyEmployeesV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "companyId", "in": "query", "description": "LinkedIn company ID.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number, starting from 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": 31501100, "x-api-version": "v1", "x-search-aliases": [ "LinkedIn company employees API", "LinkedIn company people list", "LinkedIn workforce lookup", "领英公司员工列表", "LinkedIn 企业人员查询", "领英公司人员" ], "x-highlights": [], "x-endpoint-family": "linkedin_get_company_employees" } }, "/api/linkedin/get-user-posts/v1": { "get": { "tags": [ "LinkedIn" ], "summary": "User Published Posts", "description": "Retrieves posts published, commented on, or reacted to by a LinkedIn member using a profile URL, activity type, offset, and pagination token. Use it to review public professional activity and continue through additional result pages.", "operationId": "getApiLinkedinGetUserPostsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Full LinkedIn profile URL.", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "User activity type.\n\nAvailable Values:\n- `POSTS`: Posts published by the user\n- `COMMENTS`: Posts commented on by the user\n- `REACTIONS`: Posts reacted to by the user", "required": false, "schema": { "type": "string", "default": "posts", "description": "LinkedIn user activity type", "enum": [ "POSTS", "COMMENTS", "REACTIONS" ] } }, { "name": "start", "in": "query", "description": "Pagination offset starting from 0, normally increasing by 50.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "paginationToken", "in": "query", "description": "Pagination token returned by a previous response.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 31501200, "x-api-version": "v1", "x-search-aliases": [ "LinkedIn user posts API", "LinkedIn profile published content", "LinkedIn professional post history", "LinkedIn user activity posts", "领英用户帖子", "LinkedIn 个人发布内容", "领英个人动态", "领英用户互动内容" ], "x-highlights": [], "x-endpoint-family": "linkedin_get_user_posts" } }, "/api/linkedin/get-post-reactions/v1": { "get": { "tags": [ "LinkedIn" ], "summary": "Post Reactions", "description": "This LinkedIn post-reaction-record endpoint is deprecated because the capability is no longer available. Existing integrations should stop sending requests.", "operationId": "getApiLinkedinGetPostReactionsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "postId", "in": "query", "description": "LinkedIn post ID.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number, starting from 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "type", "in": "query", "description": "Reaction type filter.\n\nAvailable Values:\n- `ALL`: All reaction types\n- `LIKE`: Like reactions\n- `PRAISE`: Praise reactions\n- `EMPATHY`: Empathy reactions\n- `APPRECIATION`: Appreciation reactions\n- `INTEREST`: Interest reactions", "required": false, "schema": { "type": "string", "default": "all", "description": "LinkedIn post reaction type", "enum": [ "ALL", "LIKE", "PRAISE", "EMPATHY", "APPRECIATION", "INTEREST" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": 31501300, "x-api-version": "v1", "x-search-aliases": [ "LinkedIn post reactions API", "LinkedIn post likes", "LinkedIn reaction records", "领英帖子点赞", "LinkedIn 帖子互动用户", "领英帖子反应" ], "x-highlights": [], "x-endpoint-family": "linkedin_get_post_reactions" } }, "/api/linkedin/get-post-comments/v1": { "get": { "tags": [ "LinkedIn" ], "summary": "Post Comments", "description": "Retrieves LinkedIn comments for an activity post with relevance or recent sorting, page-based navigation, a pagination token, and optional share URN. Use it to review public discussion around known professional content.", "operationId": "getApiLinkedinGetPostCommentsV1", "parameters": [ { "name": "token", "in": "query", "description": "Access token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "postId", "in": "query", "description": "LinkedIn post ID.", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number, starting from 1.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "sortOrder", "in": "query", "description": "Comment sort order.\n\nAvailable Values:\n- `RELEVANCE`: Sort comments by relevance\n- `RECENT`: Sort comments from most recent", "required": false, "schema": { "type": "string", "default": "relevance", "description": "LinkedIn post comment sort order", "enum": [ "RELEVANCE", "RECENT" ] } }, { "name": "paginationToken", "in": "query", "description": "Pagination token returned by a previous response.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "shareUrn", "in": "query", "description": "Optional share URN for a shared post.", "required": false, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 31501400, "x-api-version": "v1", "x-search-aliases": [ "LinkedIn post comments API", "LinkedIn comment users and content", "LinkedIn professional discussion", "领英帖子评论", "LinkedIn 评论用户和内容", "领英帖子讨论" ], "x-highlights": [], "x-endpoint-family": "linkedin_get_post_comments" } }, "/api/beike/ershoufang/detail/v1": { "get": { "tags": [ "Beike" ], "summary": "Resale Housing Details", "description": "Retrieves a Beike resale-housing listing by city ID and house code. Use it to inspect a known second-hand property listing in a specific city.", "operationId": "getApiBeikeErshoufangDetailV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "cityId", "in": "query", "description": "The numeric Beike city identifier.", "required": true, "schema": { "type": "string" } }, { "name": "houseCode", "in": "query", "description": "The unique identifier for the property listing.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": "32001000", "x-api-version": "v1", "x-search-aliases": [ "Beike resale housing detail", "Beike second-hand house lookup", "Beike listing by house code", "贝壳二手房详情", "贝壳房源编号查询", "贝壳二手房源信息" ], "x-highlights": [], "x-endpoint-family": "beike_ershoufang_detail" } }, "/api/beike/get-ershoufang-list/v1": { "get": { "tags": [ "Beike" ], "summary": "Resale Housing List", "description": "Retrieves Beike resale-housing listings for a city with optional condition filters and offset pagination. Use it to browse second-hand properties in a selected market.", "operationId": "getApiBeikeGetErshoufangListV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "cityId", "in": "query", "description": "The numeric Beike city identifier.", "required": true, "schema": { "type": "string" } }, { "name": "condition", "in": "query", "description": "Filter conditions (e.g., region, price range, layout).", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "offset", "in": "query", "description": "Pagination offset, starting from 0 (e.g., 0, 20, 40...).", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": "32001100", "x-api-version": "v1", "x-search-aliases": [ "Beike resale housing list", "Beike second-hand homes search", "Beike city property listings", "贝壳二手房列表", "贝壳城市房源搜索", "贝壳二手房条件查询" ], "x-highlights": [], "x-endpoint-family": "beike_get_ershoufang_list" } }, "/api/beike/community/list/v1": { "get": { "tags": [ "Beike" ], "summary": "Community List", "description": "Retrieves Beike residential communities for a city with optional condition filters and offset pagination. Use it to browse housing communities in a selected city.", "operationId": "getApiBeikeCommunityListV1", "parameters": [ { "name": "token", "in": "query", "description": "User authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "cityId", "in": "query", "description": "The numeric Beike city identifier.", "required": true, "schema": { "type": "string" } }, { "name": "condition", "in": "query", "description": "Filter conditions for communities.", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "limitOffset", "in": "query", "description": "Pagination offset, starting from 0 (e.g., 0, 20, 40...).", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": "32001200", "x-api-version": "v1", "x-search-aliases": [ "Beike community list", "Beike residential communities", "Beike city neighborhood search", "贝壳小区列表", "贝壳住宅小区查询", "贝壳城市小区搜索" ], "x-highlights": [], "x-endpoint-family": "beike_community_list" } }, "/api/imdb/title-release-expectation-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Release Expectation", "description": "Retrieves IMDb release-expectation information for a title ID using selected language and country preferences. Use it to monitor a title's release context or support release-planning research.", "operationId": "getApiImdbTitleReleaseExpectationQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001000, "x-api-version": "v1", "x-search-aliases": [ "IMDb release expectation API", "IMDb title release outlook", "IMDb release anticipation", "IMDb 上映预期接口", "IMDb 影片上映期待", "IMDb 影视上映预期" ], "x-highlights": [], "x-endpoint-family": "imdb_title_release_expectation_query" } }, "/api/imdb/title-extended-details-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Extended Details", "description": "Retrieves extended IMDb details for a title ID using selected language and country preferences. Use it to enrich a title catalog or perform deeper research after a basic lookup.", "operationId": "getApiImdbTitleExtendedDetailsQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001100, "x-api-version": "v1", "x-search-aliases": [ "IMDb extended title details", "IMDb detailed title information", "IMDb movie extended metadata", "IMDb 影片扩展详情", "IMDb 电影详细信息", "IMDb 剧集扩展资料" ], "x-highlights": [], "x-endpoint-family": "imdb_title_extended_details_query" } }, "/api/imdb/title-top-cast-and-crew/v1": { "get": { "tags": [ "IMDb" ], "summary": "Top Cast and Crew", "description": "Retrieves IMDb top cast and crew information for a title ID using selected language and country preferences. Use it to research principal talent or enrich title credits.", "operationId": "getApiImdbTitleTopCastAndCrewV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001200, "x-api-version": "v1", "x-search-aliases": [ "IMDb top cast and crew", "IMDb principal cast lookup", "IMDb title credits API", "IMDb 主要演员和主创", "IMDb 演职人员查询", "IMDb 影片主创阵容" ], "x-highlights": [], "x-endpoint-family": "imdb_title_top_cast_and_crew" } }, "/api/imdb/title-base-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Base Info", "description": "Retrieves base IMDb information for a title ID using selected language and country preferences. Use it to perform a lightweight title lookup or populate basic catalog context.", "operationId": "getApiImdbTitleBaseQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001300, "x-api-version": "v1", "x-search-aliases": [ "IMDb title base information", "IMDb basic title lookup", "IMDb movie base data", "IMDb 影片基础信息", "IMDb 电影基本资料", "IMDb 影视条目查询" ], "x-highlights": [], "x-endpoint-family": "imdb_title_base_query" } }, "/api/imdb/title-redux-overview-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Redux Overview", "description": "Retrieves the IMDb Redux overview for a title ID using selected language and country preferences. Use it to obtain a consolidated title overview for catalog review or content research.", "operationId": "getApiImdbTitleReduxOverviewQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001400, "x-api-version": "v1", "x-search-aliases": [ "IMDb title overview API", "IMDb Redux overview", "IMDb consolidated title overview", "IMDb 影片概览接口", "IMDb 影视条目总览", "IMDb 电影剧集概览" ], "x-highlights": [], "x-endpoint-family": "imdb_title_redux_overview_query" } }, "/api/imdb/title-did-you-know-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "'Did You Know' Insights", "description": "Retrieves IMDb 'Did You Know' information for a title ID using selected language and country preferences. Use it to research title trivia and add editorial context.", "operationId": "getApiImdbTitleDidYouKnowQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001500, "x-api-version": "v1", "x-search-aliases": [ "IMDb Did You Know API", "IMDb title trivia", "IMDb movie facts lookup", "IMDb 你知道吗信息", "IMDb 影片趣闻", "IMDb 电影幕后知识" ], "x-highlights": [], "x-endpoint-family": "imdb_title_did_you_know_query" } }, "/api/imdb/title-critics-review-summary-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Critics Review Summary", "description": "Retrieves the IMDb critics-review summary for a title ID using selected language and country preferences. Use it to review critical reception or compare titles during research.", "operationId": "getApiImdbTitleCriticsReviewSummaryQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001600, "x-api-version": "v1", "x-search-aliases": [ "IMDb critics review summary", "IMDb critical reception API", "IMDb critic reviews lookup", "IMDb 影评人评论摘要", "IMDb 专业影评汇总", "IMDb 影评人口碑查询" ], "x-highlights": [], "x-endpoint-family": "imdb_title_critics_review_summary_query" } }, "/api/imdb/title-awards-summary-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Awards Summary", "description": "Retrieves the IMDb awards summary for a title ID using selected language and country preferences. Use it to research a title's awards record or support awards-focused catalog review.", "operationId": "getApiImdbTitleAwardsSummaryQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001700, "x-api-version": "v1", "x-search-aliases": [ "IMDb title awards summary", "IMDb awards information", "IMDb title accolades API", "IMDb 影片获奖摘要", "IMDb 奖项信息查询", "IMDb 电影获奖记录" ], "x-highlights": [], "x-endpoint-family": "imdb_title_awards_summary_query" } }, "/api/imdb/title-user-reviews-summary-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "User Reviews Summary", "description": "Retrieves the IMDb user-reviews summary for a title ID using selected language and country preferences. Use it to review audience reception or support title comparison and research.", "operationId": "getApiImdbTitleUserReviewsSummaryQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001800, "x-api-version": "v1", "x-search-aliases": [ "IMDb user reviews summary", "IMDb audience review overview", "IMDb title user feedback", "IMDb 用户评论摘要", "IMDb 观众评价汇总", "IMDb 影片用户口碑" ], "x-highlights": [], "x-endpoint-family": "imdb_title_user_reviews_summary_query" } }, "/api/imdb/title-plot-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Plot Summary", "description": "Retrieves IMDb plot information for a title ID using selected language and country preferences. Use it to review a movie or series storyline or enrich title descriptions.", "operationId": "getApiImdbTitlePlotQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34001900, "x-api-version": "v1", "x-search-aliases": [ "IMDb title plot API", "IMDb movie storyline", "IMDb plot summary lookup", "IMDb 影片剧情接口", "IMDb 电影故事梗概", "IMDb 剧集剧情简介" ], "x-highlights": [], "x-endpoint-family": "imdb_title_plot_query" } }, "/api/imdb/title-contribution-questions/v1": { "get": { "tags": [ "IMDb" ], "summary": "Contribution Questions", "description": "Retrieves IMDb contribution questions associated with a title ID using selected language and country preferences. Use it to review available prompts for title-data contribution workflows.", "operationId": "getApiImdbTitleContributionQuestionsV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34002000, "x-api-version": "v1", "x-search-aliases": [ "IMDb title contribution questions", "IMDb metadata contribution prompts", "IMDb title data questions", "IMDb 影片贡献问题", "IMDb 条目数据提问", "IMDb 元数据贡献提示" ], "x-highlights": [], "x-endpoint-family": "imdb_title_contribution_questions" } }, "/api/imdb/title-details-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Details", "description": "Retrieves IMDb title details for a title ID using selected language and country preferences. Use it to support detailed title research or enrich a movie and television catalog.", "operationId": "getApiImdbTitleDetailsQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34002100, "x-api-version": "v1", "x-search-aliases": [ "IMDb title details API", "IMDb movie details lookup", "IMDb TV title information", "IMDb 影片详情接口", "IMDb 电影资料查询", "IMDb 剧集详情" ], "x-highlights": [], "x-endpoint-family": "imdb_title_details_query" } }, "/api/imdb/title-box-office-summary/v1": { "get": { "tags": [ "IMDb" ], "summary": "Box Office Summary", "description": "Retrieves the IMDb box-office summary for a title ID using selected language and country preferences. Use it to research reported theatrical performance or compare titles.", "operationId": "getApiImdbTitleBoxOfficeSummaryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34002200, "x-api-version": "v1", "x-search-aliases": [ "IMDb box office summary", "IMDb title box office API", "IMDb theatrical performance lookup", "IMDb 票房摘要", "IMDb 影片票房查询", "IMDb 电影票房信息" ], "x-highlights": [], "x-endpoint-family": "imdb_title_box_office_summary" } }, "/api/imdb/title-more-like-this-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Recommendations", "description": "Retrieves IMDb titles similar to a specified title ID using selected language and country preferences. Use it to support related-title discovery, recommendations, or catalog curation.", "operationId": "getApiImdbTitleMoreLikeThisQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34002300, "x-api-version": "v1", "x-search-aliases": [ "IMDb similar titles", "IMDb more like this API", "IMDb related movie recommendations", "IMDb 相似影片推荐", "IMDb 更多同类作品", "IMDb 相关影视查询" ], "x-highlights": [], "x-endpoint-family": "imdb_title_more_like_this_query" } }, "/api/imdb/streaming-picks-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "Streaming Picks", "description": "Retrieves IMDb streaming picks for Prime Video using selected language and country preferences. Use it to explore streaming titles for discovery, catalog review, or watchlist research.", "operationId": "getApiImdbStreamingPicksQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34002500, "x-api-version": "v1", "x-search-aliases": [ "IMDb streaming picks API", "IMDb Prime Video picks", "IMDb streaming title recommendations", "IMDb 流媒体精选", "IMDb Prime Video 片单", "IMDb 在线影视推荐" ], "x-highlights": [], "x-endpoint-family": "imdb_streaming_picks_query" } }, "/api/imdb/news-by-category-query/v1": { "get": { "tags": [ "IMDb" ], "summary": "News by Category", "description": "Retrieves IMDb news for a selected top, movie, TV, or celebrity category using language and country preferences. Use it to monitor entertainment news or research a specific category.", "operationId": "getApiImdbNewsByCategoryQueryV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "News category to filter by.\n\nAvailable Values:\n- `TOP`: Top News\n- `MOVIE`: Movie News\n- `TV`: TV News\n- `CELEBRITY`: Celebrity News", "required": true, "schema": { "type": "string", "description": "Categories for IMDb news.", "enum": [ "TOP", "MOVIE", "TV", "CELEBRITY" ] } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34002600, "x-api-version": "v1", "x-search-aliases": [ "IMDb news by category", "IMDb movie and TV news API", "IMDb celebrity news lookup", "IMDb 分类新闻接口", "IMDb 电影电视新闻", "IMDb 名人新闻查询" ], "x-highlights": [], "x-endpoint-family": "imdb_news_by_category_query" } }, "/api/imdb/title-chart-rankings/v1": { "get": { "tags": [ "IMDb" ], "summary": "Chart Rankings", "description": "Retrieves the IMDb Top 250 movie or TV chart selected by ranking type using language and country preferences. Use it to monitor chart positions or compare highly ranked titles.", "operationId": "getApiImdbTitleChartRankingsV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "rankingsChartType", "in": "query", "description": "Type of rankings chart to retrieve.\n\nAvailable Values:\n- `TOP_250`: Top 250 Movies\n- `TOP_250_TV`: Top 250 TV Shows", "required": true, "schema": { "type": "string", "description": "Chart types for IMDb rankings.", "enum": [ "TOP_250", "TOP_250_TV" ] } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34002700, "x-api-version": "v1", "x-search-aliases": [ "IMDb Top 250 rankings", "IMDb movie chart API", "IMDb TV chart rankings", "IMDb Top 250 排行榜", "IMDb 电影榜单", "IMDb 电视剧排行榜" ], "x-highlights": [], "x-endpoint-family": "imdb_title_chart_rankings" } }, "/api/imdb/title-countries-of-origin/v1": { "get": { "tags": [ "IMDb" ], "summary": "Countries of Origin", "description": "Retrieves countries of origin associated with an IMDb title ID using selected language and country preferences. Use it to enrich regional catalog metadata or support origin-based analysis.", "operationId": "getApiImdbTitleCountriesOfOriginV1", "parameters": [ { "name": "token", "in": "query", "description": "User's authentication token.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The IMDb title identifier in tt format.", "required": true, "schema": { "type": "string" } }, { "name": "languageCountry", "in": "query", "description": "Language and country preferences.\n\nAvailable Values:\n- `en_US`: English (US)\n- `fr_CA`: French (Canada)\n- `fr_FR`: French (France)\n- `de_DE`: German (Germany)\n- `hi_IN`: Hindi (India)\n- `it_IT`: Italian (Italy)\n- `pt_BR`: Portuguese (Brazil)\n- `es_ES`: Spanish (Spain)\n- `es_US`: Spanish (US)\n- `es_MX`: Spanish (Mexico)", "required": false, "schema": { "type": "string", "default": "en_US", "description": "Language and country options for IMDb data.", "enum": [ "en_US", "fr_CA", "fr_FR", "de_DE", "hi_IN", "it_IT", "pt_BR", "es_ES", "es_US", "es_MX" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "x-order": 34002800, "x-api-version": "v1", "x-search-aliases": [ "IMDb countries of origin", "IMDb title origin country API", "IMDb production country lookup", "IMDb 影片原产国", "IMDb 制作国家查询", "IMDb 影视来源国家" ], "x-highlights": [], "x-endpoint-family": "imdb_title_countries_of_origin" } }, "/api/llm/doubao-answer/v1": { "get": { "tags": [ "LLM" ], "summary": "Doubao Answer", "description": "Requests a Doubao web answer for a submitted keyword or question. Use it to collect a generated answer for research and information-gathering workflows.", "operationId": "getApiLlmDoubaoAnswerV1", "parameters": [ { "name": "token", "in": "query", "description": "Authentication token for this API service.", "required": true, "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "description": "Keyword or question to ask Doubao.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "400": { "description": "Invalid request parameters or body", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "401": { "description": "Invalid or inactive access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "429": { "description": "Request rate or daily quota limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } }, "503": { "description": "Service temporarily unavailable", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "enum": [ 0, 100, 101, 202, 300, 301, 302, 303, 400, 404, 500, 503, 600, 601, 602 ] }, "message": { "type": [ "string", "null" ] }, "data": {}, "recordTime": { "type": [ "string", "null" ] }, "requestId": { "type": "string" } }, "required": [ "code", "data", "message", "recordTime" ] } } } } }, "deprecated": true, "x-order": "36001000", "x-api-version": "v1", "x-search-aliases": [ "Doubao web answer", "Doubao question answering", "Doubao AI response", "豆包网页回答", "豆包问题查询", "豆包 AI 答案" ], "x-highlights": [], "x-endpoint-family": "llm_doubao_answer" } } }, "x-openapi-release-id": "9fd850499401657b" }