{"openapi":"3.1.0","info":{"title":"DataXAPI","version":"v1","description":"Market data over one interface: every capability takes the same parameter names, answers in the same envelope and fails with the same error structure. One call fetches one page and is charged on its own. Reads are GET; a request with a list of IDs or terms is a POST with a JSON body. The catalog (GET /v1/catalog, no key) carries the same contract with prices in force, in English and Chinese."},"x-revision":"720fc3ea8dadb865","x-prices":{"version":"19","effective_at":"2026-11-17T18:04:34.631Z","currency":"USD"},"servers":[{"url":"https://api.dataxapi.com"}],"security":[{"key":[]}],"tags":[{"name":"douyin","description":"Douyin"},{"name":"bilibili","description":"Bilibili"},{"name":"kuaishou","description":"Kuaishou"},{"name":"telegram","description":"Telegram"},{"name":"x","description":"X (Twitter)"},{"name":"facebook","description":"Facebook"},{"name":"google","description":"Google Ads"},{"name":"linkedin","description":"LinkedIn"},{"name":"meta","description":"Meta Ad Library"},{"name":"threads","description":"Threads"},{"name":"instagram","description":"Instagram"},{"name":"tiktok","description":"TikTok"},{"name":"weibo","description":"Weibo"},{"name":"xiaohongshu","description":"Xiaohongshu (RedNote)"},{"name":"youtube","description":"YouTube"},{"name":"wechat_channels","description":"WeChat Channels"},{"name":"wechat","description":"WeChat Search"},{"name":"wechat_mp","description":"WeChat Official Accounts"},{"name":"reddit","description":"Reddit"},{"name":"zhihu","description":"Zhihu"},{"name":"pinterest","description":"Pinterest"},{"name":"catalog","description":"The public catalog, without a key"},{"name":"calls","description":"A call by its request ID, or by the idempotency key it was sent under"},{"name":"account","description":"The account's own figures"},{"name":"runs","description":"Budgets for runs of tasks"}],"paths":{"/v1/douyin/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.comments.replies.list","tags":["douyin"],"summary":"Douyin comment replies","x-capability":{"id":"douyin.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","metrics.comments":"platform"}},"description":"Get a page of the replies under a Douyin comment, by the comment's ID and its video's ID: text, replier, likes, time posted.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA comment that does not exist cannot be told from a comment without replies: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"Comment ID (a top-level comment)","schema":{"type":"string"},"example":"7655660369926603557"},{"name":"post_id","in":"query","required":true,"description":"ID of the video the comment is under","schema":{"type":"string"},"example":"7655283400210664719"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/hashtags/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.hashtags.videos.list","tags":["douyin"],"summary":"Douyin hashtag videos","x-capability":{"id":"douyin.hashtags.videos.list","category":"social","role":"social.topics.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":10,"cursor_ttl_seconds":3600},"unavailable":{"metrics.views":"capability","metrics.reposts":"platform","author.verified":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","author.followers":"capability","is_pinned":"capability"}},"description":"Get a page of Douyin videos under a hashtag, by the hashtag's ID, in the platform's order, most liked first or newest first: caption, author, engagement counts, time posted.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 10 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"Hashtag ID, a string of digits","schema":{"type":"string"},"example":"7495235888088090635"},{"name":"sort","in":"query","description":"Order: the platform's ranking (the default), most liked first, newest first","schema":{"type":"string","enum":["relevance","popular","latest"],"default":"relevance"},"example":"latest"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/bilibili/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"bilibili.comments.replies.list","tags":["bilibili"],"summary":"Bilibili comment replies","x-capability":{"id":"bilibili.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform"}},"description":"Get a page of replies to a Bilibili comment, by the comment's ID and its video's BV number: text, replier, likes, what it answers, time posted.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"Comment ID, a string of digits (the id the comment list returns)","schema":{"type":"string"},"example":"316663705296"},{"name":"post_id","in":"query","required":true,"description":"BV number of the video the comment is under (the post_id the comment list returns)","schema":{"type":"string"},"example":"BV1iWtR6pEFP"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.bilibili"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/bilibili/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"bilibili.trends.list","tags":["bilibili"],"summary":"Bilibili hot searches","x-capability":{"id":"bilibili.trends.list","category":"social","role":"social.trends.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":50,"max":50},"unavailable":{"id":"platform"}},"description":"Get Bilibili's current hot search terms, up to 50, with rank, heat and the words the list shows for each.\n\nPrice: $0.002 per call.\n\n50 items on a usual page, 50 at most. Given whole: there is no next page.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which list: hot searches is the only one","schema":{"type":"string","enum":["hot_search"],"default":"hot_search"},"example":"hot_search"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items.bilibili"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/bilibili/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"bilibili.users.get","tags":["bilibili"],"summary":"Bilibili user profile","x-capability":{"id":"bilibili.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"created_at":"capability"}},"description":"Get a Bilibili user's profile by user number: name, bio, avatar, verification and what it says, follower and following counts, number of videos, likes received in all, account level, live room link.\n\nPrice: $0.002 per call.","parameters":[{"name":"id","in":"query","required":true,"description":"User number (mid), a string of digits: the number after space.bilibili.com/ in a space link","schema":{"type":"string"},"example":"8047632"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.bilibili"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/bilibili/users/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"bilibili.users.videos.list","tags":["bilibili"],"summary":"Bilibili user videos","x-capability":{"id":"bilibili.users.videos.list","category":"social","role":"social.accounts.posts.list","backup":"bilibili.backup.users.videos.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":30,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.username":"platform","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.likes":"capability","metrics.shares":"capability","metrics.favorites":"capability","metrics.reposts":"platform","images":"platform","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"},"when":[{"params":["id"],"values":{},"may_be_absent":["text","metrics.comments","author.id"]}]},"description":"Get a page of the videos a Bilibili user uploaded, newest first: title, description, views, comments, danmaku count, length, time published.\n\nPrice: $0.002 per call.\n\n30 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.\n\nWith id: may lack text, metrics.comments, author.id.\n\nA user that does not exist cannot be told from a user without videos: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"User number (mid), a string of digits","schema":{"type":"string"},"example":"8047632"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.bilibili"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/bilibili/videos/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"bilibili.videos.comments.list","tags":["bilibili"],"summary":"Bilibili video comments","x-capability":{"id":"bilibili.videos.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform"}},"description":"Get a page of comments on a Bilibili video by BV number, top or newest first: text, commenter and their level, likes, reply count, time posted.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"The video's BV number: 12 characters starting with BV1","schema":{"type":"string"},"example":"BV1ECeJ65EZS"},{"name":"sort","in":"query","description":"Top comments first, or by time posted (newest first; fewer a page that way, 7 to 9 recorded)","schema":{"type":"string","enum":["popular","latest"],"default":"popular"},"example":"popular"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.bilibili"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/bilibili/videos/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"bilibili.videos.get","tags":["bilibili"],"summary":"Bilibili video detail","x-capability":{"id":"bilibili.videos.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"lang":"capability","author.username":"capability","metrics.reposts":"platform","images":"platform","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Bilibili video by BV number or link: title, description, uploader, views, likes, coins, saves, danmaku count, length, tags, section, IP location, and the cid that subtitles and danmaku are asked for by.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.bilibili.com/video/BV1ECeJ65EZS).","parameters":[{"name":"id","in":"query","description":"The video's BV number: 12 characters starting with BV1","schema":{"type":"string"},"example":"BV1ECeJ65EZS"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the www.bilibili.com/video/BV… page, the phone site's m.bilibili.com/video/BV…, or the b23.tv short link the app copies. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.bilibili.com/video/BV1ECeJ65EZS"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.bilibili"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/bilibili/videos/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"bilibili.videos.search","tags":["bilibili"],"summary":"Bilibili video search","x-capability":{"id":"bilibili.videos.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.username":"platform","author.verified":"capability","author.followers":"capability","metrics.shares":"capability","metrics.reposts":"platform","images":"platform","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of Bilibili videos for search terms, by relevance, newest or most played: title, uploader, views, likes, saves, comments, length.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"机械键盘"},{"name":"sort","in":"query","description":"By relevance, by time published (newest first) or by views","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"relevance"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.bilibili"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/bilibili/videos/trending":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"bilibili.videos.trending","tags":["bilibili"],"summary":"Bilibili popular videos","x-capability":{"id":"bilibili.videos.trending","category":"social","role":"social.posts.trending","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.username":"platform","author.verified":"capability","author.followers":"capability","metrics.reposts":"platform","images":"platform","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of Bilibili's popular videos: title, description, uploader, views, likes, coins, saves, danmaku count, length, section, IP location, why it is recommended.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.bilibili"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/brands/history":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.brands.history","tags":["douyin"],"summary":"Douyin trend-index brand trends","x-capability":{"id":"douyin.index.brands.history","category":"social","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get a brand's day-by-day search, content and spread indexes on Douyin over a date range, from the platform's own index tool. An index is the platform's score, not a count; days are calendar days in China time (UTC+8).\n\nPrice: $0.002 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"brand","in":"query","required":true,"description":"The brand's name, spelled as the index lists it","schema":{"type":"string"},"example":"泡泡玛特"},{"name":"since","in":"query","required":true,"description":"The first day wanted: the China-time (UTC+8) calendar day this moment falls on","schema":{"type":"string","format":"date-time"},"example":"2026-09-01T00:00:00Z"},{"name":"until","in":"query","required":true,"description":"The last day wanted, read the same way. The platform publishes a day or two late: a day it has no figure for yet has a null index","schema":{"type":"string","format":"date-time"},"example":"2026-09-30T00:00:00Z"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/brand_history.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/brands/metrics":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.brands.metrics","tags":["douyin"],"summary":"Douyin trend-index brand comparison","x-capability":{"id":"douyin.index.brands.metrics","category":"social","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get the daily averages of a brand's search, content and spread indexes on Douyin over a date range, from the platform's own index tool, with the averages of every brand in its industry and of the industry's top 3, 5, 10, 15 and 30 to hold them against. An index is the platform's score, not a count.\n\nPrice: $0.002 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"brand","in":"query","required":true,"description":"The brand's name, spelled as the index lists it","schema":{"type":"string"},"example":"泡泡玛特"},{"name":"since","in":"query","required":true,"description":"The first day counted: the China-time (UTC+8) calendar day this moment falls on","schema":{"type":"string","format":"date-time"},"example":"2026-09-01T00:00:00Z"},{"name":"until","in":"query","required":true,"description":"The last day counted, read the same way; the platform publishes a day or two late","schema":{"type":"string","format":"date-time"},"example":"2026-09-30T00:00:00Z"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/brand_metrics.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/creators/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.creators.videos.list","tags":["douyin"],"summary":"Douyin trend-index creator top videos","x-capability":{"id":"douyin.index.creators.videos.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20},"unavailable":{"type":"capability","title":"capability","lang":"capability","author.username":"capability","author.name":"capability","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.favorites":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get the videos the platform's own index tool lists as a Douyin account's top videos for a span of up to 30 days, by the account's numeric ID: up to twenty, most liked first, each with caption, link, day published, its engagement counts and followers gained. As recorded, the tool picks from what was published on the last day or two of the span, not from all of it: set the end date to the day you want. One page; no view counts.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. Given whole: there is no next page.\n\nAn account that does not exist cannot be told from an account with no videos in the span: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"The account's numeric Douyin ID (uid), a string of digits; not the token starting with MS4w that the profile endpoint takes. Nor is it the Douyin handle (username, often digits too): the uid is ext.uid in what douyin.users.get returns with view=full. Accounts with very few followers have no such data (a few hundred followers failed, over thirty thousand worked when tried), and retrying does not help","schema":{"type":"string"},"example":"66598046050"},{"name":"since","in":"query","required":true,"description":"The first day counted: the China-time (UTC+8) calendar day this moment falls on","schema":{"type":"string","format":"date-time"},"example":"2026-09-01T00:00:00Z"},{"name":"until","in":"query","required":true,"description":"The last day counted, read the same way; no more than 30 days after the first","schema":{"type":"string","format":"date-time"},"example":"2026-09-30T00:00:00Z"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/creators/audience/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.creators.audience.get","tags":["douyin"],"summary":"Douyin trend-index creator follower profile","x-capability":{"id":"douyin.index.creators.audience.get","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"measured_at":"capability","gender.count":"capability","age.count":"capability","province.count":"capability","city.count":"capability","city_tier.count":"capability","device.count":"capability","interest.count":"capability","crowd":"capability","purchase_category":"capability","purchase_amount":"capability"}},"description":"Get who follows a Douyin account from the platform's own index tool, by the account's numeric ID: the share of each segment by gender, age, province, city, city tier, phone brand and interest. Not limited to marketplace creators; shares only, no head counts.\n\nPrice: $0.002 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"The account's numeric Douyin ID (uid), a string of digits; not the token starting with MS4w that the profile endpoint takes. Nor is it the Douyin handle (username, often digits too): the uid is ext.uid in what douyin.users.get returns with view=full. Accounts with very few followers have no such data (a few hundred followers failed, over thirty thousand worked when tried), and retrying does not help","schema":{"type":"string"},"example":"66598046050"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/audience.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/creators/metrics":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.creators.metrics","tags":["douyin"],"summary":"Douyin trend-index creator core metrics","x-capability":{"id":"douyin.index.creators.metrics","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get a Douyin creator's core figures from the platform's own index tool, by the account's numeric ID: new likes, shares and comments a day and the tool's own count of follows a day, on average over the last week and the last month, each as a ratio against the period before. The follows are not the net gain in followers, and come out larger. An account the tool has nothing on (every figure 0) is answered as not found.\n\nPrice: $0.002 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"The account's numeric Douyin ID (uid), a string of digits; not the token starting with MS4w that the profile endpoint takes. Nor is it the Douyin handle (username, often digits too): the uid is ext.uid in what douyin.users.get returns with view=full. Accounts with very few followers have no such data (a few hundred followers failed, over thirty thousand worked when tried), and retrying does not help","schema":{"type":"string"},"example":"66598046050"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/index_creator_metrics.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/keywords/audience/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.keywords.audience.get","tags":["douyin"],"summary":"Douyin trend-index keyword audience","x-capability":{"id":"douyin.index.keywords.audience.get","category":"social","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get who is behind a keyword on Douyin over a date range, from the platform's own keyword tool: the share and TGI of each age group, gender, province, city, city tier and interest.\n\nPrice: $0.002 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"keyword","in":"query","required":true,"description":"One keyword; letter case does not matter","schema":{"type":"string"},"example":"咖啡"},{"name":"since","in":"query","required":true,"description":"The first day counted: the China-time (UTC+8) calendar day this moment falls on","schema":{"type":"string","format":"date-time"},"example":"2026-09-01T00:00:00Z"},{"name":"until","in":"query","required":true,"description":"The last day counted, read the same way; the platform publishes a day or two late","schema":{"type":"string","format":"date-time"},"example":"2026-09-30T00:00:00Z"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/keyword_audience.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/keywords/history":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.keywords.history","tags":["douyin"],"summary":"Douyin trend-index keyword trends","x-capability":{"id":"douyin.index.keywords.history","category":"social","stability":"preview","pricing":{"per":"call","price":"0.006","max_charge":"0.006","charge_when_empty":"0.006"},"page":{"typical":1,"max":5},"unavailable":{"points.notes":"platform","points.impressions":"platform","points.views":"platform","points.engagements":"platform"}},"description":"Get the day-by-day search index and composite index of a keyword, or of one to five keywords at once, on Douyin over a date range, from 巨量算数 (the Douyin index), with the daily averages of the period, of the one before and of a year earlier. An index is the platform's score of volume, not a count of searches; days are calendar days in China time (UTC+8).\n\nPrice: $0.006 per call.\n\nGive exactly one of keywords, keyword.\n\n1 items on a usual page, 5 at most. Given whole: there is no next page.\n\nA keyword the index does not cover is not in the answer; when none of the keywords asked for has figures the result is empty, never a not-found error. Asking only for days the platform has not published yet is an empty result too.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"keyword","in":"query","description":"One keyword, at most 50 characters and without a comma; letter case does not matter","schema":{"type":"string"},"example":"咖啡"},{"name":"since","in":"query","required":true,"description":"The first day wanted: the China-time (UTC+8) calendar day this moment falls on; 2026-09-01 means 1 September","schema":{"type":"string","format":"date-time"},"example":"2026-09-01T00:00:00Z"},{"name":"until","in":"query","required":true,"description":"The last day wanted, read the same way. The platform publishes a day or two late: a day it has no figure for yet has a null index","schema":{"type":"string","format":"date-time"},"example":"2026-09-30T00:00:00Z"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/keyword_history.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"douyin.index.keywords.history.batch","tags":["douyin"],"summary":"Douyin trend-index keyword trends (batch)","x-capability":{"id":"douyin.index.keywords.history","category":"social","stability":"preview","pricing":{"per":"call","price":"0.006","max_charge":"0.006","charge_when_empty":"0.006"},"page":{"typical":1,"max":5},"unavailable":{"points.notes":"platform","points.impressions":"platform","points.views":"platform","points.engagements":"platform"}},"description":"Get the day-by-day search index and composite index of a keyword, or of one to five keywords at once, on Douyin over a date range, from 巨量算数 (the Douyin index), with the daily averages of the period, of the one before and of a year earlier. An index is the platform's score of volume, not a count of searches; days are calendar days in China time (UTC+8).\n\nPrice: $0.006 per call.\n\nGive exactly one of keywords, keyword.\n\n1 items on a usual page, 5 at most. Given whole: there is no next page.\n\nA keyword the index does not cover is not in the answer; when none of the keywords asked for has figures the result is empty, never a not-found error. Asking only for days the platform has not published yet is an empty result too.\n\nPreview: the returned object may change, announced beforehand.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["since","until","keywords"],"properties":{"keywords":{"type":"array","items":{"type":"string"},"minItems":1,"description":"One to five keywords, each at most 50 characters and without a comma; letter case does not matter. One item comes back per keyword that has figures; a keyword the index does not cover is not in the answer"},"since":{"type":"string","format":"date-time","description":"The first day wanted: the China-time (UTC+8) calendar day this moment falls on; 2026-09-01 means 1 September"},"until":{"type":"string","format":"date-time","description":"The last day wanted, read the same way. The platform publishes a day or two late: a day it has no figure for yet has a null index"},"view":{"type":"string","enum":["compact","standard","full"],"default":"standard","description":"How much of each item to return"},"fields":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Return only these fields"}}},"example":{"keywords":["咖啡","CityWalk"]}}}},"responses":{"200":{"$ref":"#/components/responses/keyword_history.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/keywords/related":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.keywords.related","tags":["douyin"],"summary":"Douyin trend-index related keywords","x-capability":{"id":"douyin.index.keywords.related","category":"social","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":170,"max":250}},"description":"Get the keywords related to a keyword on Douyin in one week, from the platform's own keyword tool: those searched together with it and those that appear with it in content, each with its relevance, its place by relevance, its search index and its composite index. An index is the platform's score of volume, not a count of searches.\n\nPrice: $0.002 per call.\n\n170 items on a usual page, 250 at most. Given whole: there is no next page.\n\nA keyword the index does not cover reads like one with no related keywords that week, or a week not published yet: an empty result, never a not-found error.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"keyword","in":"query","required":true,"description":"One keyword; letter case does not matter","schema":{"type":"string"},"example":"露营"},{"name":"until","in":"query","required":true,"description":"Which week: relations are computed by the week (Monday to Sunday, China time), and the week returned is the last whole one ending on or before this day. The latest week is published early in the next; before that the result is empty","schema":{"type":"string","format":"date-time"},"example":"2026-10-04T00:00:00Z"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/keyword_related.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.trends.list","tags":["douyin"],"summary":"Douyin trend-index live hot topics","x-capability":{"id":"douyin.index.trends.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":30,"max":50},"unavailable":{"id":"platform"}},"description":"Get the live topic board or the fastest-rising topic board of Douyin's index tool, about 30 entries each: place, name, topic index, number of related videos, their plays and a category. The topic index is the platform's score of heat, not a count of searches.\n\nPrice: $0.002 per call.\n\n30 items on a usual page, 50 at most. Given whole: there is no next page.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which board: the hottest topics now, the fastest-rising topics","schema":{"type":"string","enum":["topics","rising"],"default":"topics"},"example":"topics"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/index/videos/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.index.videos.search","tags":["douyin"],"summary":"Douyin trend-index keyword hot videos","x-capability":{"id":"douyin.index.videos.search","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20},"unavailable":{"title":"capability","lang":"capability","published_at":"capability","author.id":"capability","author.username":"capability","author.verified":"capability","author.followers":"capability","metrics.comments":"capability","metrics.shares":"capability","metrics.favorites":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get the roughly 20 high-index videos Douyin's index tool puts forward for a keyword: caption, link, author's display name, likes, video index and category. One page only; the author's ID and the publication time are not given, the video endpoint has them.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. Given whole: there is no next page.","parameters":[{"name":"query","in":"query","required":true,"description":"The keyword","schema":{"type":"string"},"example":"露营"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.trends.list","tags":["douyin"],"summary":"Douyin hot search board","x-capability":{"id":"douyin.trends.list","category":"social","role":"social.trends.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":50,"max":51,"cursor_ttl_seconds":3600},"when":[{"params":["board"],"values":{"board":"hot_search"},"unavailable":{"ext.artist":"capability"},"paging":false},{"params":["board"],"values":{"board":"rising"},"unavailable":{"ext.views":"capability","ext.artist":"capability"}},{"params":["board"],"values":{"board":"topics"},"unavailable":{"ext.artist":"capability"}},{"params":["board"],"values":{"board":"searches"},"unavailable":{"id":"capability","rank":"capability","ext.views":"capability","ext.videos":"capability","ext.artist":"capability"}},{"params":["board"],"values":{"board":"music"},"unavailable":{"rank":"capability","ext.views":"capability","ext.videos":"capability"},"paging":false}]},"description":"Get a Douyin hot list: hot searches, rising topics, topic ranking, top search terms or the music chart, with rank and heat.\n\nPrice: $0.002 per call.\n\n50 items on a usual page, 51 at most. A cursor is valid for 3600 seconds.\n\nWith board=hot_search: no next page; without ext.artist.\n\nWith board=rising: without ext.views, ext.artist.\n\nWith board=topics: without ext.artist.\n\nWith board=searches: without id, rank, ext.views, ext.videos, ext.artist.\n\nWith board=music: no next page; without rank, ext.views, ext.videos.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which list: hot searches, rising topics, topic ranking, top search terms, the music chart","schema":{"type":"string","enum":["hot_search","rising","topics","searches","music"],"default":"hot_search"},"example":"hot_search"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.users.get","tags":["douyin"],"summary":"Douyin user profile","x-capability":{"id":"douyin.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"created_at":"platform"}},"description":"Get a Douyin user's profile by account ID or profile link: name, handle, bio, follower, following and post counts, total likes, verification; in the full view also what the badge says, whether it is an organisation's or shop's (blue V), whether the profile has a product showcase, whether the account may sell live, and whether it is live now, with the room's ID.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.douyin.com/user/MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8); share_text (长按复制此条消息，打开抖音搜索，查看TA的更多作品。 https://www.douyin.com/user/MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8).","parameters":[{"name":"id","in":"query","description":"Account ID (the sec_uid, the string that starts with MS4w). With only a profile link or a share text, give it as url","schema":{"type":"string"},"example":"MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8"},{"name":"url","in":"query","description":"Link to the profile, pasted as it is: the https://www.douyin.com/user/… web link, the page a share opens on a phone, the v.douyin.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which account it leads to","schema":{"type":"string"},"example":"https://www.douyin.com/user/MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/users/history":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.users.history","tags":["douyin"],"summary":"Douyin creator engagement and follower trends","x-capability":{"id":"douyin.users.history","category":"social","role":"social.accounts.history","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get how a Douyin account's numbers moved over the last 7 or 30 days, by its numeric ID, from the platform's own index tool: net new followers, new likes, comments, shares and posts, each as a ratio against the period before, and the totals now; up to five accounts in one request. It is one period's sum, not a day-by-day series.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, ids.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","description":"The account's numeric Douyin ID (uid), a string of digits; not the token starting with MS4w that the profile endpoint takes. Nor is it the Douyin handle (username, often digits too): the uid is ext.uid in what douyin.users.get returns with view=full. Accounts with very few followers have no such data (a few hundred followers failed, over thirty thousand worked when tried), and retrying does not help","schema":{"type":"string"},"example":"66598046050"},{"name":"window","in":"query","description":"How many of the most recent days to count: 7 or 30","schema":{"type":"string","enum":["7d","30d"],"default":"7d"},"example":"7d"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account_history.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"douyin.users.history.batch","tags":["douyin"],"summary":"Douyin creator engagement and follower trends (batch)","x-capability":{"id":"douyin.users.history","category":"social","role":"social.accounts.history","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get how a Douyin account's numbers moved over the last 7 or 30 days, by its numeric ID, from the platform's own index tool: net new followers, new likes, comments, shares and posts, each as a ratio against the period before, and the totals now; up to five accounts in one request. It is one period's sum, not a day-by-day series.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, ids.\n\nPreview: the returned object may change, announced beforehand.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":5,"description":"Up to five numeric Douyin account IDs (uid), each a string of digits. If one of them does not exist, the whole batch fails. The uid is ext.uid in what douyin.users.get returns with view=full, not the Douyin handle (username); an account with very few followers counts as failing too, and asking one at a time shows which"},"window":{"type":"string","enum":["7d","30d"],"default":"7d","description":"How many of the most recent days to count: 7 or 30"},"view":{"type":"string","enum":["compact","standard","full"],"default":"standard","description":"How much of each item to return"},"fields":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Return only these fields"}}},"example":{"ids":["66598046050","104255897823"]}}}},"responses":{"200":{"$ref":"#/components/responses/account_history.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/users/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.users.search","tags":["douyin"],"summary":"Douyin user search","x-capability":{"id":"douyin.users.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":30,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"username":"capability","bio":"capability","verified":"capability","created_at":"platform","metrics.following":"capability"}},"description":"Search Douyin accounts by terms, a page at a time: account ID, display name, avatar, follower count, post count, total likes.\n\nPrice: $0.002 per call.\n\n30 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"博物馆"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/users/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.users.videos.list","tags":["douyin"],"summary":"Douyin user videos","x-capability":{"id":"douyin.users.videos.list","category":"social","role":"social.accounts.posts.list","backup":"douyin.backup.users.videos.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"metrics.views":"capability","metrics.reposts":"platform","author.verified":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","author.followers":"capability"}},"description":"Get a page of the videos a Douyin account has posted, newest first: caption, engagement counts, time posted.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.douyin.com/user/MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8); share_text (长按复制此条消息，打开抖音搜索，查看TA的更多作品。 https://www.douyin.com/user/MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8).\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nAn account that does not exist cannot be told from an account without videos: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","description":"Account ID (the sec_uid, the string that starts with MS4w). With only a profile link or a share text, give it as url","schema":{"type":"string"},"example":"MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8"},{"name":"url","in":"query","description":"Link to the profile, pasted as it is: the https://www.douyin.com/user/… web link, the page a share opens on a phone, the v.douyin.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which account it leads to","schema":{"type":"string"},"example":"https://www.douyin.com/user/MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/videos/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.videos.comments.list","tags":["douyin"],"summary":"Douyin video comments","x-capability":{"id":"douyin.videos.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform"}},"description":"Get a page of comments on a Douyin video: text, commenter, likes, reply count, time posted.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.douyin.com/video/7694940173372575014); share_text (7.69 复制打开抖音，看看【示例的作品】 https://www.douyin.com/video/7694940173372575014 复制此链接，打开Dou音搜索，直接观看视频！).\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA video that does not exist cannot be told from a video without comments: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","description":"Video ID, a string of digits. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"7694940173372575014"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the https://www.douyin.com/video/… web link, a web link with modal_id in it, the page a share opens on a phone, the v.douyin.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.douyin.com/video/7694940173372575014"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/videos/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.videos.get","tags":["douyin"],"summary":"Douyin video detail","x-capability":{"id":"douyin.videos.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"metrics.views":"capability","metrics.reposts":"platform","author.verified":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","author.followers":"capability","is_pinned":"capability"}},"description":"Get one Douyin video or image post by ID or link: caption, author, engagement counts, time posted.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.douyin.com/video/7694940173372575014); share_text (7.69 复制打开抖音，看看【示例的作品】 https://www.douyin.com/video/7694940173372575014 复制此链接，打开Dou音搜索，直接观看视频！).","parameters":[{"name":"id","in":"query","description":"Video ID, a string of digits. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"7694940173372575014"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the https://www.douyin.com/video/… web link, a web link with modal_id in it, the page a share opens on a phone, the v.douyin.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.douyin.com/video/7694940173372575014"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/videos/metrics":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.videos.metrics","tags":["douyin"],"summary":"Douyin video play count","x-capability":{"id":"douyin.videos.metrics","category":"social","role":"social.posts.metrics","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"url":"capability","type":"capability","title":"capability","text":"capability","lang":"capability","published_at":"capability","author":"capability","metrics.comments":"capability","metrics.shares":"capability","metrics.favorites":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a Douyin video's counts as of now, by its ID: plays and likes.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.douyin.com/video/7694940173372575014); share_text (7.69 复制打开抖音，看看【示例的作品】 https://www.douyin.com/video/7694940173372575014 复制此链接，打开Dou音搜索，直接观看视频！).","parameters":[{"name":"id","in":"query","description":"Video ID, a string of digits. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"7694940173372575014"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the https://www.douyin.com/video/… web link, a web link with modal_id in it, the page a share opens on a phone, the v.douyin.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.douyin.com/video/7694940173372575014"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/videos/related":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.videos.related","tags":["douyin"],"summary":"Douyin related videos","x-capability":{"id":"douyin.videos.related","category":"social","role":"social.posts.related","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":20},"unavailable":{"metrics.views":"capability","metrics.reposts":"platform","author.verified":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","lang":"capability","author.followers":"capability","is_pinned":"capability"}},"description":"Get the batch of videos Douyin recommends beside a video, by its ID: caption, author, engagement counts. The recommendations may differ from call to call.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 20 at most. Given whole: there is no next page.\n\nThis endpoint does not check that the video exists: an ID of no video is not a 404; it returns a batch of the platform's recommendations all the same (unrelated to that ID), or an empty result.","parameters":[{"name":"id","in":"query","required":true,"description":"Video ID, a string of digits","schema":{"type":"string"},"example":"7694940173372575014"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/videos/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.videos.search","tags":["douyin"],"summary":"Douyin video search","x-capability":{"id":"douyin.videos.search","category":"social","role":"social.posts.search","backup":"douyin.backup.videos.search","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":8,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"metrics.views":"capability","metrics.reposts":"platform","author.verified":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","is_pinned":"capability"},"when":[{"params":["query","sort"],"values":{"sort":"relevance"},"may_be_absent":["author.followers"]},{"params":["query","sort","published_within"],"values":{"sort":"relevance","published_within":"day"},"may_be_absent":["author.followers"]},{"params":["query","sort","published_within"],"values":{"sort":"relevance","published_within":"week"},"may_be_absent":["author.followers"]},{"params":["query","sort","published_within"],"values":{"sort":"relevance","published_within":"half_year"},"may_be_absent":["author.followers"]},{"params":["query","sort"],"values":{"sort":"latest"},"may_be_absent":["author.followers"]},{"params":["query","sort","published_within"],"values":{"sort":"latest","published_within":"day"},"may_be_absent":["author.followers"]},{"params":["query","sort","published_within"],"values":{"sort":"latest","published_within":"week"},"may_be_absent":["author.followers"]},{"params":["query","sort","published_within"],"values":{"sort":"latest","published_within":"half_year"},"may_be_absent":["author.followers"]},{"params":["query","sort"],"values":{"sort":"popular"},"may_be_absent":["author.followers"]},{"params":["query","sort","published_within"],"values":{"sort":"popular","published_within":"day"},"may_be_absent":["author.followers"]},{"params":["query","sort","published_within"],"values":{"sort":"popular","published_within":"week"},"may_be_absent":["author.followers"]},{"params":["query","sort","published_within"],"values":{"sort":"popular","published_within":"half_year"},"may_be_absent":["author.followers"]}]},"description":"Search Douyin videos by terms, a page at a time, sorted by relevance, newest or most liked and filtered by time posted: caption, author with follower count, engagement counts.\n\nPrice: $0.02 per call.\n\n8 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nWith query, sort=relevance: may lack author.followers.\n\nWith query, sort=relevance, published_within=day: may lack author.followers.\n\nWith query, sort=relevance, published_within=week: may lack author.followers.\n\nWith query, sort=relevance, published_within=half_year: may lack author.followers.\n\nWith query, sort=latest: may lack author.followers.\n\nWith query, sort=latest, published_within=day: may lack author.followers.\n\nWith query, sort=latest, published_within=week: may lack author.followers.\n\nWith query, sort=latest, published_within=half_year: may lack author.followers.\n\nWith query, sort=popular: may lack author.followers.\n\nWith query, sort=popular, published_within=day: may lack author.followers.\n\nWith query, sort=popular, published_within=week: may lack author.followers.\n\nWith query, sort=popular, published_within=half_year: may lack author.followers.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"露营"},{"name":"sort","in":"query","description":"Order: the platform's ranking, newest first, most liked first. Douyin does not serve most liked within a day; with that pair, a day's results come with each page in order of likes","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"relevance"},{"name":"published_within","in":"query","description":"Only videos posted within the last day, week or half year; any time when left out","schema":{"type":"string","enum":["day","week","half_year"]},"example":"week"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/videos/trending":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.videos.trending","tags":["douyin"],"summary":"Douyin trending videos","x-capability":{"id":"douyin.videos.trending","category":"social","role":"social.posts.trending","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":9,"max":10,"cursor_ttl_seconds":3600},"unavailable":{"title":"capability","lang":"capability","author.id":"capability","author.username":"capability","author.verified":"capability","metrics.comments":"capability","metrics.shares":"capability","metrics.favorites":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a Douyin video board for the last day: breakouts from small accounts, highest like rate, highest completion rate or highest follow rate, with plays, likes and the author's follower count.\n\nPrice: $0.002 per call.\n\n9 items on a usual page, 10 at most. A cursor is valid for 3600 seconds.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which board: breakouts from small accounts, highest like rate, highest completion rate, highest follow rate","schema":{"type":"string","enum":["low_fan","high_like","high_completion","high_follow"],"default":"low_fan"},"example":"low_fan"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/rates/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.rates.get","tags":["douyin"],"summary":"Douyin Xingtu creator rate card","x-capability":{"id":"douyin.xingtu.creators.rates.get","category":"creator","role":"creator.creators.rates.get","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0"}},"description":"Get what a Douyin creator charges on Xingtu for each kind of sponsored work, and how it is settled.\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Xingtu creator ID","schema":{"type":"string"},"example":"6629656444889202692"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/creator_rates.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/kuaishou/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"kuaishou.comments.replies.list","tags":["kuaishou"],"summary":"Kuaishou comment replies","x-capability":{"id":"kuaishou.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":12,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","author.username":"capability","metrics.comments":"platform","post_id":"capability","parent_id":"capability","root_id":"capability"}},"description":"Get a page of the replies under a Kuaishou comment, by the comment's ID and its video's ID: text, replier, likes, time posted, IP location.\n\nPrice: $0.002 per call.\n\n12 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA comment that does not exist cannot be told from a comment without replies: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"Comment ID (a top-level comment), a string of digits","schema":{"type":"string"},"example":"908850553827"},{"name":"post_id","in":"query","required":true,"description":"ID of the video the comment is under: the part of the video's web link that starts with 3x","schema":{"type":"string"},"example":"3xgarycnydawq3g"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.kuaishou"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/kuaishou/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"kuaishou.trends.list","tags":["kuaishou"],"summary":"Kuaishou hot list","x-capability":{"id":"kuaishou.trends.list","category":"social","role":"social.trends.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":51,"max":60}},"description":"Get Kuaishou's hot list: 50 trending terms and whatever the platform pins above them, with rank and heat.\n\nPrice: $0.002 per call.\n\n51 items on a usual page, 60 at most. Given whole: there is no next page.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/kuaishou/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"kuaishou.users.get","tags":["kuaishou"],"summary":"Kuaishou user profile","x-capability":{"id":"kuaishou.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0"},"unavailable":{"url":"capability","created_at":"platform"}},"description":"Get a Kuaishou user's profile by user ID: name, handle, bio, follower, following and post counts, total likes, verification; in the full view also what the badge says, the IP location, gender, and whether the profile has a Kuaishou store.\n\nPrice: $0.02 per call.","parameters":[{"name":"id","in":"query","required":true,"description":"User ID, a string of digits (not the handle)","schema":{"type":"string"},"example":"917792206"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.kuaishou"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/kuaishou/users/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"kuaishou.users.search","tags":["kuaishou"],"summary":"Kuaishou user search","x-capability":{"id":"kuaishou.users.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"capability","created_at":"platform","metrics.following":"capability","metrics.posts":"capability"}},"description":"Search Kuaishou accounts by terms, a page at a time, with only verified accounts or only those live now, by gender, or ordered by followers: user ID, display name, handle, bio, follower count, verification.\n\nPrice: $0.02 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"人民日报"},{"name":"filter","in":"query","description":"Only one kind of account: verified, the verified ones; live, the ones live now; any when left out","schema":{"type":"string","enum":["verified","live"]},"example":"live"},{"name":"gender","in":"query","description":"Only female or only male users (as they give it on their profiles)","schema":{"type":"string","enum":["female","male"]},"example":"female"},{"name":"sort","in":"query","description":"Order: the platform's own (relevance), or by followers, most or fewest first","schema":{"type":"string","enum":["relevance","most_followers","fewest_followers"],"default":"relevance"},"example":"most_followers"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/kuaishou/users/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"kuaishou.users.videos.list","tags":["kuaishou"],"summary":"Kuaishou user videos","x-capability":{"id":"kuaishou.users.videos.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02","variants":[{"param":"sort","value":"popular","per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"}]},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","author.followers":"capability","metrics.reposts":"capability","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the videos a Kuaishou account has posted, newest or most popular first: caption, play and engagement counts, time posted.\n\nPrice: $0.02 per call. With sort=popular: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA user that does not exist cannot be told from a user without videos: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"User ID, a string of digits (not the handle)","schema":{"type":"string"},"example":"917792206"},{"name":"sort","in":"query","description":"Order: newest first, most popular first","schema":{"type":"string","enum":["latest","popular"],"default":"latest"},"example":"latest"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.kuaishou"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/kuaishou/videos/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"kuaishou.videos.comments.list","tags":["kuaishou"],"summary":"Kuaishou video comments","x-capability":{"id":"kuaishou.videos.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":40,"max":40,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","author.username":"capability","metrics.comments":"capability","post_id":"capability"}},"description":"Get a page of top-level comments on a Kuaishou video: text, commenter, likes, time posted, IP location.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.kuaishou.com/short-video/3x5pf8ia4zc76tc); share_text (【示例】看看这个作品 https://www.kuaishou.com/short-video/3x5pf8ia4zc76tc 点击链接，打开【快手】直接观看！).\n\n40 items on a usual page, 40 at most. A cursor is valid for 3600 seconds.\n\nA video that does not exist cannot be told from a video without comments: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","description":"Video ID: the part of the video's web link that starts with 3x. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"3x5pf8ia4zc76tc"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the https://www.kuaishou.com/short-video/… web link, the v.kuaishou.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.kuaishou.com/short-video/3x5pf8ia4zc76tc"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.kuaishou"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/kuaishou/videos/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"kuaishou.videos.get","tags":["kuaishou"],"summary":"Kuaishou video detail","x-capability":{"id":"kuaishou.videos.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"title":"platform","lang":"capability","author.followers":"capability","metrics.reposts":"capability","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Kuaishou video by ID or link: caption, author, play and engagement counts, time posted.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.kuaishou.com/short-video/3x5pf8ia4zc76tc); share_text (【示例】看看这个作品 https://www.kuaishou.com/short-video/3x5pf8ia4zc76tc 点击链接，打开【快手】直接观看！).","parameters":[{"name":"id","in":"query","description":"Video ID: the part of the video's web link that starts with 3x. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"3x5pf8ia4zc76tc"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the https://www.kuaishou.com/short-video/… web link, the v.kuaishou.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.kuaishou.com/short-video/3x5pf8ia4zc76tc"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.kuaishou"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/kuaishou/videos/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"kuaishou.videos.search","tags":["kuaishou"],"summary":"Kuaishou video search","x-capability":{"id":"kuaishou.videos.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":10,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","author.followers":"capability","metrics.reposts":"capability","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Search Kuaishou posts by terms, a page at a time, sorted newest or most liked first and filtered by time posted and video length: caption, author, play and engagement counts, time posted, whether it is a video or a photo set, and a video's length.\n\nPrice: $0.02 per call.\n\n10 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"露营装备"},{"name":"sort","in":"query","description":"Order: the platform's ranking (the default), newest first, most liked first","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"latest"},{"name":"published_within","in":"query","description":"Only posts from the last day, week or month; any time when left out","schema":{"type":"string","enum":["day","week","month"]},"example":"day"},{"name":"duration","in":"query","description":"Only videos of this length band; any length when left out","schema":{"type":"string","enum":["under_1_min","1_to_5_min","over_5_min"]},"example":"under_1_min"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.kuaishou"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/telegram/channels/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"telegram.channels.get","tags":["telegram"],"summary":"Telegram channel profile","x-capability":{"id":"telegram.channels.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"id":"platform","created_at":"capability","metrics.following":"platform","metrics.posts":"capability"}},"description":"Get a public Telegram channel by its handle: name, description, subscriber count, verification.\n\nPrice: $0.002 per call.","parameters":[{"name":"username","in":"query","required":true,"description":"The channel's handle, without the @","schema":{"type":"string"},"example":"telegram"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/telegram/channels/messages/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"telegram.channels.messages.list","tags":["telegram"],"summary":"Telegram channel messages","x-capability":{"id":"telegram.channels.messages.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","author.id":"capability","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.likes":"platform","metrics.comments":"capability","metrics.shares":"capability","metrics.favorites":"platform","metrics.reposts":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"capability","parent_id":"capability","root_id":"capability"}},"description":"Get a page of a public Telegram channel's messages by its handle, newest first: text, time posted, views, images.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"username","in":"query","required":true,"description":"The channel's handle, without the @","schema":{"type":"string"},"example":"telegram"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.telegram"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/telegram/messages/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"telegram.messages.get","tags":["telegram"],"summary":"Telegram message detail","x-capability":{"id":"telegram.messages.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"title":"platform","lang":"capability","author.id":"capability","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.likes":"platform","metrics.comments":"capability","metrics.shares":"capability","metrics.favorites":"platform","metrics.reposts":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"capability","parent_id":"capability","root_id":"capability"}},"description":"Get one message of a public Telegram channel by channel handle and message number, or by its link: text, time posted, views, images.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://t.me/telegram/401).","parameters":[{"name":"id","in":"query","description":"The channel's handle and the message's number joined by a slash, as in telegram/401","schema":{"type":"string"},"example":"telegram/401"},{"name":"url","in":"query","description":"Link to the message: t.me, then the channel, then the number","schema":{"type":"string"},"example":"https://t.me/telegram/401"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.telegram"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/communities/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.communities.posts.list","tags":["x"],"summary":"X community posts","x-capability":{"id":"x.communities.posts.list","category":"social","role":"social.communities.posts.list","stability":"stable","pricing":{"per":"item","price":"0.0003","minimum":"0.0003","max_charge":"0.006","charge_when_empty":"0.0003","charge_when_not_found":"0.0003"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","metrics.shares":"platform","is_pinned":"capability","root_id":"platform","author.verified":"capability"}},"description":"Get a page of the posts in an X community by the community's ID.\n\nPrice: $0.0003 per item returned, at least $0.0003 and at most $0.006 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA community that does not exist cannot be told from a community without posts: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"Community ID, a string of digits","schema":{"type":"string"},"example":"1539231166569410560"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/lists/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.lists.posts.list","tags":["x"],"summary":"X list posts","x-capability":{"id":"x.lists.posts.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":100,"max":100,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","metrics.shares":"platform","is_pinned":"capability","root_id":"platform","hashtags":"capability","mentions":"capability","post_id":"capability","parent_id":"capability"}},"description":"Get a page of the posts on an X list's timeline by the list's ID, newest first, about 100 a page.\n\nPrice: $0.002 per call.\n\n100 items on a usual page, 100 at most. A cursor is valid for 3600 seconds.\n\nA list that does not exist is not answered with a 404: it is reported as an error that may be retried once and is not charged.","parameters":[{"name":"id","in":"query","required":true,"description":"List ID, a string of digits","schema":{"type":"string"},"example":"84839422"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/posts/article/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.posts.article.get","tags":["x"],"summary":"X article detail","x-capability":{"id":"x.posts.article.get","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"lang":"capability","metrics.shares":"platform","metrics.favorites":"capability","metrics.reposts":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"capability","parent_id":"capability","root_id":"platform"}},"description":"Get the long-form article attached to an X post by the post's ID: title, full text, author, time published, and its like, reply and view counts.\n\nPrice: $0.002 per call.","parameters":[{"name":"id","in":"query","required":true,"description":"ID of the post the article is attached to, a string of digits","schema":{"type":"string"},"example":"1905545699552375179"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/posts/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.posts.get","tags":["x"],"summary":"X post detail","x-capability":{"id":"x.posts.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.0003","max_charge":"0.0003","charge_when_empty":"0","charge_when_not_found":"0.0003"},"unavailable":{"title":"platform","metrics.shares":"platform","is_pinned":"capability","root_id":"platform"}},"description":"Get one X post by ID or link: text, author, time posted, and its like, reply, retweet, quote, bookmark and view counts.\n\nPrice: $0.0003 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://x.com/i/status/2108198226532708497).","parameters":[{"name":"id","in":"query","description":"Post ID, a string of digits","schema":{"type":"string"},"example":"2108198226532708497"},{"name":"url","in":"query","description":"Link to the post: an x.com or twitter.com link with /status/ in it","schema":{"type":"string"},"example":"https://x.com/i/status/2108198226532708497"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/facebook/pages/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"facebook.pages.get","tags":["facebook"],"summary":"Facebook page profile","x-capability":{"id":"facebook.pages.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"verified":"capability","metrics.following":"platform","metrics.posts":"capability"}},"description":"Get a public Facebook page by handle, ID or link: name, intro, follower count, likes, category, website, creation date. It also gives the page's ID in Meta's ad library, what getting its ads takes.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, username, url.\n\nLinks taken by `url`: long (https://www.facebook.com/NASA).","parameters":[{"name":"id","in":"query","description":"Page ID, a string of digits","schema":{"type":"string"},"example":"100044561550831"},{"name":"username","in":"query","description":"Page handle: the segment after facebook.com/ in the page's link","schema":{"type":"string"},"example":"NASA"},{"name":"url","in":"query","description":"Link to the page, written facebook.com/handle","schema":{"type":"string"},"example":"https://www.facebook.com/NASA"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.facebook"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/facebook/pages/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"facebook.pages.posts.list","tags":["facebook"],"summary":"Facebook page posts","x-capability":{"id":"facebook.pages.posts.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":3,"max":3,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","author.username":"capability","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.shares":"capability","metrics.views":"capability","metrics.favorites":"platform","metrics.reposts":"platform","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the posts a Facebook page published, by page ID, handle or link: text, time, reaction count, comment count, images; shares and views come from the post capability. Three posts a page, with older pages behind a cursor.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, username, url.\n\nLinks taken by `url`: long (https://www.facebook.com/NASA).\n\n3 items on a usual page, 3 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","description":"Page ID, a string of digits; faster than the handle","schema":{"type":"string"},"example":"100044561550831"},{"name":"username","in":"query","description":"Page handle: the segment after facebook.com/ in the page's link","schema":{"type":"string"},"example":"NASA"},{"name":"url","in":"query","description":"Link to the page, written facebook.com/handle","schema":{"type":"string"},"example":"https://www.facebook.com/NASA"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/facebook/posts/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"facebook.posts.comments.list","tags":["facebook"],"summary":"Facebook post comments","x-capability":{"id":"facebook.posts.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":10,"cursor_ttl_seconds":3600},"unavailable":{"url":"capability","author.username":"capability","parent_id":"capability","root_id":"capability"}},"description":"Get a page of the comments on a Facebook post or reel by the post's ID: text, commenter, reactions, reply count, time posted.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 10 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"Post ID, a string of digits: the id returned by the page's post list and by the post itself","schema":{"type":"string"},"example":"1650176549811048"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/facebook/posts/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"facebook.posts.get","tags":["facebook"],"summary":"Facebook post detail","x-capability":{"id":"facebook.posts.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"title":"platform","lang":"capability","author.followers":"capability","metrics.favorites":"platform","metrics.reposts":"platform","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Facebook post or reel by its link: text, author, time, reaction count, comment count, shares, views, images.\n\nPrice: $0.002 per call.\n\nLinks taken by `url`: long (https://www.facebook.com/reel/2166091230582141).","parameters":[{"name":"url","in":"query","required":true,"description":"Link to the post or reel, written facebook.com/page/posts/... or facebook.com/reel/...; a link returned by the page's post list can be passed as it is","schema":{"type":"string"},"example":"https://www.facebook.com/reel/2166091230582141"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/google/ads/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"google.ads.get","tags":["google"],"summary":"Google ad detail","x-capability":{"id":"google.ads.get","category":"ads","role":"ads.ads.get","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"advertiser.name":"capability","advertiser.url":"platform","advertiser.avatar_url":"platform"}},"description":"Get one ad of the Google Ads Transparency Center by its ID or link: format, headline, description, landing page, images and videos, when it was first and last shown, the countries or regions it was shown in, and the range of total impressions where the center publishes it.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://adstransparency.google.com/advertiser/AR16735076323512287233/creative/CR13384474926044413953).\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","description":"The ad's ID: the advertiser's ID and the creative's joined by a slash, as in AR…/CR…","schema":{"type":"string"},"example":"AR16735076323512287233/CR13384474926044413953"},{"name":"url","in":"query","description":"The ad's link in the center: adstransparency.google.com/advertiser/AR…/creative/CR…","schema":{"type":"string"},"example":"https://adstransparency.google.com/advertiser/AR16735076323512287233/creative/CR13384474926044413953"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.item.google"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/google/advertisers/ads/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"google.advertisers.ads.list","tags":["google"],"summary":"Google advertiser's ads","x-capability":{"id":"google.advertisers.ads.list","category":"ads","role":"ads.advertisers.ads.list","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":40,"max":40,"cursor_ttl_seconds":3600},"unavailable":{"title":"capability","text":"capability","landing_url":"capability","advertiser.url":"platform","advertiser.avatar_url":"platform","videos":"capability"}},"description":"Get an advertiser's ads from the Google Ads Transparency Center, by the advertiser's ID: format (text, image, video), when each was first and last shown, and a picture of it; can be limited to a country and to one format. 40 ads a page; what an ad says and where it leads come from the Google ad capability.\n\nPrice: $0.002 per call.\n\n40 items on a usual page, 40 at most. A cursor is valid for 3600 seconds.\n\nAn advertiser that does not exist cannot be told from one without ads: both return an empty result, not a 404.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"The advertiser's ID, AR and a string of digits; the Google advertiser search finds it by name","schema":{"type":"string"},"example":"AR16735076323512287233"},{"name":"region","in":"query","description":"Only ads shown in this country or region, by its two-letter code; all of them when left out","schema":{"type":"string"},"example":"US"},{"name":"type","in":"query","description":"Only ads of this format; all of them when left out","schema":{"type":"string","enum":["text","image","video"]},"example":"video"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/google/advertisers/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"google.advertisers.search","tags":["google"],"summary":"Google advertiser search","x-capability":{"id":"google.advertisers.search","category":"ads","role":"ads.advertisers.search","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":10},"unavailable":{"avatar_url":"platform"}},"description":"Find advertisers in the Google Ads Transparency Center by name: ID, name, the country or region they are registered in, and the center's estimate of how many ads they have. The ID is what the advertiser's ads are asked for by.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 10 at most. Given whole: there is no next page.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","required":true,"description":"Name of the advertiser or brand","schema":{"type":"string"},"example":"nike"},{"name":"region","in":"query","description":"The country or region to search in, by its two-letter code; the United States when left out","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/advertiser.items.google"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/linkedin/ads/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"linkedin.ads.get","tags":["linkedin"],"summary":"LinkedIn ad detail","x-capability":{"id":"linkedin.ads.get","category":"ads","role":"ads.ads.get","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get one ad of the LinkedIn Ad Library by its ID or link: advertiser, text, headline, images and videos, landing page, first and last day shown, bracket of impressions, the languages and locations targeted.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.linkedin.com/ad-library/detail/1588761774).\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","description":"The ad's ID, a string of digits: the last part of its link in the library","schema":{"type":"string"},"example":"1588761774"},{"name":"url","in":"query","description":"The ad's link in the library, written linkedin.com/ad-library/detail/ and the ID","schema":{"type":"string"},"example":"https://www.linkedin.com/ad-library/detail/1588761774"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.item.linkedin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/linkedin/ads/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"linkedin.ads.search","tags":["linkedin"],"summary":"LinkedIn Ad Library search","x-capability":{"id":"linkedin.ads.search","category":"ads","role":"ads.ads.search","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":24,"max":24,"cursor_ttl_seconds":3600}},"description":"Search the ads of the LinkedIn Ad Library by keyword or by the company that advertises: advertiser, text, headline, images and videos, landing page, first and last day shown, bracket of impressions, the languages and locations targeted; can be limited to a country.\n\nPrice: $0.002 per call.\n\nGive exactly one of query, advertiser.\n\n24 items on a usual page, 24 at most. A cursor is valid for 3600 seconds.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","description":"Search terms","schema":{"type":"string"},"example":"cloud security"},{"name":"advertiser","in":"query","description":"Only the ads of this company, by its name; not with query. Ads of the company's other pages (its developers' page, say) may be among them","schema":{"type":"string"},"example":"HubSpot"},{"name":"region","in":"query","description":"Only ads delivered in this country or region, by its two-letter code; all of them when left out","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.items.linkedin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/linkedin/companies/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"linkedin.companies.get","tags":["linkedin"],"summary":"LinkedIn company page","x-capability":{"id":"linkedin.companies.get","category":"social","role":"social.accounts.get","role_type":"company","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"verified":"capability","created_at":"capability","metrics":"capability"}},"description":"Get a LinkedIn company page by handle or link: name, description, employee count, industry, size, kind of company, headquarters, website.\n\nPrice: $0.002 per call.\n\nGive exactly one of username, url.\n\nLinks taken by `url`: long (https://www.linkedin.com/company/nasa).","parameters":[{"name":"username","in":"query","description":"Company handle: the segment after /company/ in the page's link","schema":{"type":"string"},"example":"nasa"},{"name":"url","in":"query","description":"Link to the company page, written linkedin.com/company/handle","schema":{"type":"string"},"example":"https://www.linkedin.com/company/nasa"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.linkedin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/linkedin/companies/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"linkedin.companies.posts.list","tags":["linkedin"],"summary":"LinkedIn company posts","x-capability":{"id":"linkedin.companies.posts.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":10},"unavailable":{"type":"capability","title":"capability","lang":"capability","author":"capability","metrics":"capability","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get the latest posts a LinkedIn company page shows publicly (up to 10), by handle or link: ID, link, text, time. No author and no counts, which the post capability gives; this page only, with no older page.\n\nPrice: $0.002 per call.\n\nGive exactly one of username, url.\n\nLinks taken by `url`: long (https://www.linkedin.com/company/unesco).\n\n10 items on a usual page, 10 at most. Given whole: there is no next page.","parameters":[{"name":"username","in":"query","description":"Company handle: the segment after /company/ in the page's link","schema":{"type":"string"},"example":"unesco"},{"name":"url","in":"query","description":"Link to the company page, written linkedin.com/company/handle","schema":{"type":"string"},"example":"https://www.linkedin.com/company/unesco"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/linkedin/posts/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"linkedin.posts.get","tags":["linkedin"],"summary":"LinkedIn post detail","x-capability":{"id":"linkedin.posts.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"type":"capability","title":"capability","lang":"capability","author.id":"capability","author.verified":"capability","metrics.shares":"capability","metrics.favorites":"platform","metrics.views":"capability","metrics.reposts":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one LinkedIn post by its activity ID or link: text, author, time, reaction count, comment count, images.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.linkedin.com/posts/nasa_on-thursday-oct-15-the-members-of-crew-activity-7514400676702195712-09H5).","parameters":[{"name":"id","in":"query","description":"Post ID (its activity number), a string of digits","schema":{"type":"string"},"example":"7514400676702195712"},{"name":"url","in":"query","description":"Link to the post, written linkedin.com/posts/...-activity-ID-... or linkedin.com/feed/update/urn:li:activity:ID","schema":{"type":"string"},"example":"https://www.linkedin.com/posts/nasa_on-thursday-oct-15-the-members-of-crew-activity-7514400676702195712-09H5"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/linkedin/posts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"linkedin.posts.search","tags":["linkedin"],"summary":"LinkedIn post search","x-capability":{"id":"linkedin.posts.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"page":{"typical":10,"max":10,"cursor_ttl_seconds":3600},"unavailable":{"type":"capability","title":"capability","lang":"capability","author.id":"capability","author.verified":"capability","metrics.shares":"capability","metrics.favorites":"platform","metrics.views":"capability","metrics.reposts":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Find public LinkedIn posts by search terms: text, author, time, reaction count, comment count; can be limited to a recent period. Results come from a web search engine's index of LinkedIn, not LinkedIn's own search, and are not complete.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 10 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"ai agents"},{"name":"published_within","in":"query","description":"Only posts published within this recent period (as the search engine dates them)","schema":{"type":"string","enum":["day","week","month","year"]},"example":"week"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/meta/ads/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"meta.ads.get","tags":["meta"],"summary":"Meta ad detail","x-capability":{"id":"meta.ads.get","category":"ads","role":"ads.ads.get","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"}},"description":"Get one ad of the Meta Ad Library by its library ID or link: advertiser, text, headline, images and videos, landing page, first and last day shown, the platforms it is delivered on, and whether it is still running.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.facebook.com/ads/library/?id=1466307095509411).\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","description":"The ad's Library ID, a string of digits","schema":{"type":"string"},"example":"1466307095509411"},{"name":"url","in":"query","description":"The ad's link in the library, written facebook.com/ads/library/?id= and the ID","schema":{"type":"string"},"example":"https://www.facebook.com/ads/library/?id=1466307095509411"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.item.meta"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/meta/ads/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"meta.ads.search","tags":["meta"],"summary":"Meta Ad Library search","x-capability":{"id":"meta.ads.search","category":"ads","role":"ads.ads.search","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":30,"max":30,"cursor_ttl_seconds":3600}},"description":"Search the ads running now in the Meta Ad Library (Facebook, Instagram and Meta's other apps) by keyword: advertiser, text, headline, images and videos, landing page, first and last day shown; can be limited to a country and to image or video ads, sorted by impressions or newest first. 30 ads a page.\n\nPrice: $0.002 per call.\n\n30 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"running shoes"},{"name":"region","in":"query","description":"Only ads delivered in this country or region, by its two-letter code; all of them when left out","schema":{"type":"string"},"example":"US"},{"name":"sort","in":"query","description":"By impressions, highest first, or newest first","schema":{"type":"string","enum":["popular","latest"],"default":"popular"},"example":"popular"},{"name":"type","in":"query","description":"Only image ads or only video ads; all of them when left out","schema":{"type":"string","enum":["image","video"]},"example":"video"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.items.meta"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/meta/ads/transcript/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"meta.ads.transcript.get","tags":["meta"],"summary":"Meta ad video transcript","x-capability":{"id":"meta.ads.transcript.get","category":"social","role":"social.transcripts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"lang":"capability","segments":"capability"}},"description":"Get what is said in the video of a Meta Ad Library ad by its library ID or link, as one text.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.facebook.com/ads/library/?id=974466855339122).","parameters":[{"name":"id","in":"query","description":"The ad's Library ID, a string of digits","schema":{"type":"string"},"example":"974466855339122"},{"name":"url","in":"query","description":"The ad's link in the library, written facebook.com/ads/library/?id= and the ID","schema":{"type":"string"},"example":"https://www.facebook.com/ads/library/?id=974466855339122"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/transcript.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/meta/advertisers/ads/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"meta.advertisers.ads.list","tags":["meta"],"summary":"Meta advertiser's ads","x-capability":{"id":"meta.advertisers.ads.list","category":"ads","role":"ads.advertisers.ads.list","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":30,"max":30,"cursor_ttl_seconds":3600}},"description":"Get the ads an advertiser (a Facebook page) is running now in the Meta Ad Library, by the page's ID: text, headline, images and videos, landing page, first and last day shown; can be limited to a country and to image or video ads, sorted by impressions or newest first. 30 ads a page.\n\nPrice: $0.002 per call.\n\n30 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.\n\nAn advertiser that does not exist cannot be told from one with no ads running: both return an empty result, not a 404.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"The advertiser's ID, the number its page goes by in the ad library, a string of digits; the Meta advertiser search finds it by name, and a Facebook page profile gives it as ext.ad_library_id (the profile's id is another number)","schema":{"type":"string"},"example":"182162001806727"},{"name":"region","in":"query","description":"Only ads delivered in this country or region, by its two-letter code; all of them when left out","schema":{"type":"string"},"example":"US"},{"name":"sort","in":"query","description":"By impressions, highest first, or newest first","schema":{"type":"string","enum":["popular","latest"],"default":"popular"},"example":"popular"},{"name":"type","in":"query","description":"Only image ads or only video ads; all of them when left out","schema":{"type":"string","enum":["image","video"]},"example":"video"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.items.meta"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/meta/advertisers/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"meta.advertisers.search","tags":["meta"],"summary":"Meta advertiser search","x-capability":{"id":"meta.advertisers.search","category":"ads","role":"ads.advertisers.search","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":15,"max":15},"unavailable":{"region":"capability"}},"description":"Find advertisers (Facebook pages) in the Meta Ad Library by name: ID, name, picture, category, page likes, the linked Instagram account. The ID is what the advertiser's ads are asked for by.\n\nPrice: $0.002 per call.\n\n15 items on a usual page, 15 at most. Given whole: there is no next page.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","required":true,"description":"Name of the advertiser or brand","schema":{"type":"string"},"example":"puma"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/advertiser.items.meta"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/threads/posts/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"threads.posts.get","tags":["threads"],"summary":"Threads post detail","x-capability":{"id":"threads.posts.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"title":"platform","author.followers":"capability","metrics.favorites":"platform","mentions":"capability","post_id":"capability","parent_id":"capability","root_id":"capability"}},"description":"Get one Threads post by its code or link: text, author, time, likes, replies, reposts, images.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.threads.com/t/Dc3vb5DES3i).","parameters":[{"name":"id","in":"query","description":"Post code: the last segment of the post's link","schema":{"type":"string"},"example":"Dc3vb5DES3i"},{"name":"url","in":"query","description":"Link to the post, written threads.com/@handle/post/code or threads.com/t/code","schema":{"type":"string"},"example":"https://www.threads.com/t/Dc3vb5DES3i"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.threads"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/threads/posts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"threads.posts.search","tags":["threads"],"summary":"Threads post search","x-capability":{"id":"threads.posts.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20},"unavailable":{"title":"platform","lang":"capability","author.followers":"capability","metrics.favorites":"platform","metrics.views":"capability","mentions":"capability","post_id":"capability","parent_id":"capability","root_id":"capability"}},"description":"Find Threads posts by search terms: text, author, time, likes, replies, reposts; can be limited by publication date. One page of results.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. Given whole: there is no next page.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"nasa"},{"name":"since","in":"query","description":"Published on or after this day (filtered by UTC date; the time of day is ignored)","schema":{"type":"string","format":"date-time"},"example":"2026-10-01T00:00:00Z"},{"name":"until","in":"query","description":"Published on or before this day (filtered by UTC date; the time of day is ignored)","schema":{"type":"string","format":"date-time"},"example":"2026-10-10T00:00:00Z"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.threads"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/threads/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"threads.users.get","tags":["threads"],"summary":"Threads user profile","x-capability":{"id":"threads.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"created_at":"capability","metrics.following":"capability","metrics.posts":"capability"}},"description":"Get a Threads user's profile by handle: name, bio, follower count, verification, avatar.\n\nPrice: $0.002 per call.","parameters":[{"name":"username","in":"query","required":true,"description":"Threads handle, without the @","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/threads/users/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"threads.users.posts.list","tags":["threads"],"summary":"Threads user posts","x-capability":{"id":"threads.users.posts.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":15,"max":30},"unavailable":{"title":"platform","lang":"capability","author.name":"capability","author.followers":"capability","metrics.favorites":"platform","metrics.views":"capability","mentions":"capability","post_id":"capability","parent_id":"capability","root_id":"capability"}},"description":"Get a Threads user's latest posts by handle: text, time, likes, replies, reposts, images. The most recent page only; there is no older page.\n\nPrice: $0.002 per call.\n\n15 items on a usual page, 30 at most. Given whole: there is no next page.","parameters":[{"name":"username","in":"query","required":true,"description":"Threads handle, without the @","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.threads"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/instagram/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"instagram.comments.replies.list","tags":["instagram"],"summary":"Instagram comment replies","x-capability":{"id":"instagram.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":15,"max":15,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","author.name":"capability","metrics":"capability","post_id":"capability","parent_id":"capability"}},"description":"Get a page of the replies to an Instagram comment, by the comment's ID and its post's shortcode: text, replier, time posted.\n\nPrice: $0.002 per call.\n\n15 items on a usual page, 15 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"Comment ID, a string of digits","schema":{"type":"string"},"example":"17968670751170878"},{"name":"post_id","in":"query","required":true,"description":"Shortcode of the post the comment is under","schema":{"type":"string"},"example":"DeCPVhERA8e"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/instagram/hashtags/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"instagram.hashtags.posts.list","tags":["instagram"],"summary":"Instagram hashtag posts","x-capability":{"id":"instagram.hashtags.posts.list","category":"social","role":"social.topics.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":33,"max":35,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","author.followers":"capability","metrics.shares":"capability","metrics.favorites":"capability","metrics.reposts":"capability","hashtags":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","author.username":"capability","author.name":"capability","author.avatar_url":"capability","author.verified":"capability","metrics.views":"capability","is_pinned":"capability"}},"description":"Get a page of the newest Instagram posts under a hashtag, by its name, about 33 a page: caption, author's ID, like and comment counts, time posted, image.\n\nPrice: $0.002 per call.\n\n33 items on a usual page, 35 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"Name of the hashtag, without the #","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.instagram"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/instagram/posts/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"instagram.posts.comments.list","tags":["instagram"],"summary":"Instagram post comments","x-capability":{"id":"instagram.posts.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":15,"max":15,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","author.name":"capability","metrics.comments":"capability","post_id":"capability"}},"description":"Get a page of comments on an Instagram post or reel by shortcode or link, about 15 a page, newest first: text, commenter, likes, time posted.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.instagram.com/p/DeCPVhERA8e/).\n\n15 items on a usual page, 15 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","description":"The post's shortcode: the part of its link after /p/ or /reel/","schema":{"type":"string"},"example":"DeCPVhERA8e"},{"name":"url","in":"query","description":"Web link to the post or reel","schema":{"type":"string"},"example":"https://www.instagram.com/p/DeCPVhERA8e/"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/instagram/posts/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"instagram.posts.get","tags":["instagram"],"summary":"Instagram post detail","x-capability":{"id":"instagram.posts.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"title":"platform","lang":"capability","author.followers":"capability","metrics.shares":"capability","metrics.favorites":"capability","metrics.reposts":"capability","hashtags":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","is_pinned":"capability"}},"description":"Get one Instagram post or reel by shortcode or link: caption, author, like, comment and play counts, image and video addresses, and the other authors of a collab post.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.instagram.com/p/DeCPVhERA8e/).","parameters":[{"name":"id","in":"query","description":"The post's shortcode: the part of its link after /p/ or /reel/","schema":{"type":"string"},"example":"DeCPVhERA8e"},{"name":"url","in":"query","description":"Web link to the post or reel","schema":{"type":"string"},"example":"https://www.instagram.com/p/DeCPVhERA8e/"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.instagram"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/instagram/posts/transcript/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"instagram.posts.transcript.get","tags":["instagram"],"summary":"Instagram video transcript","x-capability":{"id":"instagram.posts.transcript.get","category":"social","role":"social.transcripts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"lang":"capability","segments":"capability"}},"description":"Get what is said in an Instagram reel or video post by shortcode or link, as one text; videos up to two minutes long.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.instagram.com/p/DeCPVhERA8e/).","parameters":[{"name":"id","in":"query","description":"The post's shortcode: the part of its link after /p/ or /reel/","schema":{"type":"string"},"example":"DeCPVhERA8e"},{"name":"url","in":"query","description":"Web link to the post or reel","schema":{"type":"string"},"example":"https://www.instagram.com/p/DeCPVhERA8e/"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/transcript.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/instagram/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"instagram.users.get","tags":["instagram"],"summary":"Instagram user profile","x-capability":{"id":"instagram.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"created_at":"platform","metrics.posts":"capability"}},"description":"Get an Instagram user's profile by handle: name, bio, follower and following counts, verification, whether it is private, and the website and links the profile gives.\n\nPrice: $0.002 per call.","parameters":[{"name":"username","in":"query","required":true,"description":"Instagram handle, without the @","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.instagram"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/instagram/users/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"instagram.users.posts.list","tags":["instagram"],"summary":"Instagram user posts","x-capability":{"id":"instagram.users.posts.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":12,"max":12,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","author.followers":"capability","metrics.shares":"capability","metrics.favorites":"capability","metrics.reposts":"capability","hashtags":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","is_pinned":"capability"}},"description":"Get a page of what an Instagram user posted, by handle, 12 a page, or its reels only: caption, like, comment and play counts, time posted, image and video addresses, and the other authors of a collab post.\n\nPrice: $0.002 per call.\n\n12 items on a usual page, 12 at most. A cursor is valid for 3600 seconds.\n\nAn account that does not exist is not answered with a 404. Asked for every post, it returns an empty result, which cannot be told from an account that has posted nothing; asked for reels only, it returns an error and is not charged.","parameters":[{"name":"username","in":"query","required":true,"description":"Instagram handle, without the @","schema":{"type":"string"},"example":"nasa"},{"name":"type","in":"query","description":"Every post, or reels only","schema":{"type":"string","enum":["all","reel"],"default":"all"},"example":"all"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.instagram"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/instagram/users/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"instagram.users.search","tags":["instagram"],"summary":"Instagram user search","x-capability":{"id":"instagram.users.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0.004"},"page":{"typical":50,"max":50},"unavailable":{"bio":"capability","created_at":"platform","metrics":"capability"}},"description":"Search Instagram accounts by keyword, about 50 in one answer and no further pages: handle, name, avatar, verification, whether it is private.\n\nPrice: $0.004 per call.\n\n50 items on a usual page, 50 at most. Given whole: there is no next page.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"nike"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.instagram"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/ads/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.ads.search","tags":["tiktok"],"summary":"TikTok Ads Library search","x-capability":{"id":"tiktok.ads.search","category":"ads","role":"ads.ads.search","role_type":"library","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":12,"max":12,"cursor_ttl_seconds":3600},"unavailable":{"text":"capability","landing_url":"capability","advertiser.url":"platform","advertiser.avatar_url":"platform"}},"description":"Search TikTok's public Ads Library (ads shown in Europe) by keyword or by the advertiser's name: advertiser, headline, videos and images, when each was first and last shown, and a bracket of people reached; newest first, 12 ads a page. This is the transparency record of ads, a different set from the Creative Center's Top Ads.\n\nPrice: $0.002 per call.\n\nGive exactly one of query, advertiser.\n\n12 items on a usual page, 12 at most. A cursor is valid for 3600 seconds.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","description":"Search terms","schema":{"type":"string"},"example":"running shoes"},{"name":"advertiser","in":"query","description":"Only this advertiser's ads, by the name the library knows it by (a company's registered name, say); not with query","schema":{"type":"string"},"example":"Samsung Electronics"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/ads/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.ads.get","tags":["tiktok"],"summary":"TikTok Ads Library ad detail","x-capability":{"id":"tiktok.ads.get","category":"ads","role":"ads.ads.get","role_type":"library","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"text":"capability","advertiser.url":"platform","advertiser.avatar_url":"platform"}},"description":"Get one ad of TikTok's public Ads Library by its ID or link: advertiser, headline, videos and images, landing page, when it was first and last shown, the countries it was shown in and the campaign's objective.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://library.tiktok.com/ads/detail/?ad_id=1871655924410641).\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","description":"The ad's ID, a string of digits","schema":{"type":"string"},"example":"1871655924410641"},{"name":"url","in":"query","description":"The ad's link in the library, written library.tiktok.com/ads/detail/?ad_id= and the ID","schema":{"type":"string"},"example":"https://library.tiktok.com/ads/detail/?ad_id=1871655924410641"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.item.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.comments.replies.list","tags":["tiktok"],"summary":"TikTok comment replies","x-capability":{"id":"tiktok.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","metrics.comments":"platform"}},"description":"Get a page of the replies to a TikTok comment, by the comment's ID and its video's ID, 20 a page: text, replier, likes, time posted, which reply it answers.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA comment that does not exist cannot be told from a comment without replies: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"Comment ID, a string of digits","schema":{"type":"string"},"example":"7666131725864813319"},{"name":"post_id","in":"query","required":true,"description":"ID of the video the comment is under","schema":{"type":"string"},"example":"7665840565958872333"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/creative_center/ads/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.creative_center.ads.get","tags":["tiktok"],"summary":"TikTok Creative Center Top Ad detail","x-capability":{"id":"tiktok.creative_center.ads.get","category":"ads","role":"ads.ads.get","role_type":"top_ads","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"title":"platform","advertiser.id":"platform","advertiser.url":"platform","advertiser.avatar_url":"platform","images":"platform","first_shown_at":"platform","last_shown_at":"platform"}},"description":"Get one Top Ad of TikTok's Creative Center by its ID: the ad's video, caption, brand name, landing page, likes, comments, shares, length, campaign objective, industry code and the countries it ran in.\n\nPrice: $0.002 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"The Top Ad's ID, a string of digits; the Top Ads search finds it","schema":{"type":"string"},"example":"7686210433094729735"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.item.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/creative_center/ads/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.creative_center.ads.search","tags":["tiktok"],"summary":"TikTok Creative Center Top Ads search","x-capability":{"id":"tiktok.creative_center.ads.search","category":"ads","role":"ads.ads.search","role_type":"top_ads","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","advertiser.id":"platform","advertiser.url":"platform","advertiser.avatar_url":"platform","images":"platform","first_shown_at":"platform","last_shown_at":"platform","landing_url":"capability"}},"description":"Search the Top Ads of TikTok's Creative Center by keyword: the ad's video, caption, brand name, likes, length and campaign objective; one country at a time, over a chosen period, in the Creative Center's own order or by likes. 20 ads a page. This is a showcase of ads that did well, not an ad library: it has no dates.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"sneakers"},{"name":"region","in":"query","description":"Which country's or region's Top Ads, by its two-letter code; the United States when left out","schema":{"type":"string"},"example":"US"},{"name":"window","in":"query","description":"Performance over this recent period","schema":{"type":"string","enum":["7d","30d","180d"],"default":"180d"},"example":"30d"},{"name":"sort","in":"query","description":"In the Creative Center's own recommended order, or by likes, highest first","schema":{"type":"string","enum":["relevance","popular"],"default":"relevance"},"example":"popular"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/ad.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/hashtags/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.hashtags.videos.list","tags":["tiktok"],"summary":"TikTok hashtag videos","x-capability":{"id":"tiktok.hashtags.videos.list","category":"social","role":"social.topics.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","images":"capability","author.verified":"capability","metrics.reposts":"capability","mentions.username":"capability","mentions.name":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","author.followers":"capability","is_pinned":"capability"}},"description":"Get a page of the TikTok videos under a hashtag, by its name, about 20 a page: caption, author, engagement counts, cover and play address.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"Name of the hashtag, without the #","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.users.get","tags":["tiktok"],"summary":"TikTok user profile","x-capability":{"id":"tiktok.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get a TikTok user's profile by handle or ID: name, bio, follower, following and video counts, likes received, verification.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, username.","parameters":[{"name":"id","in":"query","description":"TikTok user ID, a string of digits","schema":{"type":"string"},"example":"6767146744805213190"},{"name":"username","in":"query","description":"TikTok handle, without the @","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/users/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.users.search","tags":["tiktok"],"summary":"TikTok user search","x-capability":{"id":"tiktok.users.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":30,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"bio":"capability","verified":"capability","created_at":"capability"}},"description":"Search TikTok accounts by keyword, 30 a page: handle, name, follower, following and video counts, likes received.\n\nPrice: $0.002 per call.\n\n30 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"nike"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/users/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.users.videos.list","tags":["tiktok"],"summary":"TikTok user videos","x-capability":{"id":"tiktok.users.videos.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":10,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","images":"capability","author.verified":"capability","metrics.reposts":"capability","mentions.username":"capability","mentions.name":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the videos a TikTok user posted, by handle, 10 a page: caption, engagement counts, time posted, cover and play address; newest or most popular first.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 10 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"username","in":"query","required":true,"description":"TikTok handle, without the @","schema":{"type":"string"},"example":"nasa"},{"name":"sort","in":"query","description":"Newest first, or most popular first","schema":{"type":"string","enum":["latest","popular"],"default":"latest"},"example":"latest"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/videos/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.videos.comments.list","tags":["tiktok"],"summary":"TikTok video comments","x-capability":{"id":"tiktok.videos.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":50,"max":50,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform"}},"description":"Get a page of comments on a TikTok video by ID or link, 50 a page: text, commenter, likes, reply count, time posted. Each comment also says the commenter account's country or region.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.tiktok.com/@nasa/video/7665840565958872333).\n\n50 items on a usual page, 50 at most. A cursor is valid for 3600 seconds.\n\nA video that does not exist cannot be told from a video without comments: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","description":"Video ID, a string of digits","schema":{"type":"string"},"example":"7665840565958872333"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the https://www.tiktok.com/@handle/video/… web link, the www.tiktok.com/t/… or vm.tiktok.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.tiktok.com/@nasa/video/7665840565958872333"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/videos/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.videos.get","tags":["tiktok"],"summary":"TikTok video detail","x-capability":{"id":"tiktok.videos.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"title":"platform","images":"capability","author.verified":"capability","metrics.reposts":"capability","mentions.username":"capability","mentions.name":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","is_pinned":"capability"}},"description":"Get one TikTok video by ID or link: caption, author, like, comment, share, favorite and play counts, cover and play address.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.tiktok.com/@nasa/video/7665840565958872333).","parameters":[{"name":"id","in":"query","description":"Video ID, a string of digits","schema":{"type":"string"},"example":"7665840565958872333"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the https://www.tiktok.com/@handle/video/… web link, the www.tiktok.com/t/… or vm.tiktok.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.tiktok.com/@nasa/video/7665840565958872333"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/videos/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.videos.search","tags":["tiktok"],"summary":"TikTok video search","x-capability":{"id":"tiktok.videos.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":30,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","images":"capability","author.verified":"capability","metrics.reposts":"capability","mentions.username":"capability","mentions.name":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","is_pinned":"capability"}},"description":"Search TikTok videos by keyword, 30 a page; sort by relevance, likes or time posted, and limit how recently they were posted.\n\nPrice: $0.002 per call.\n\n30 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"space station"},{"name":"sort","in":"query","description":"By relevance, by likes, or newest first","schema":{"type":"string","enum":["relevance","popular","latest"],"default":"relevance"},"example":"relevance"},{"name":"published_within","in":"query","description":"Only videos posted within this period","schema":{"type":"string","enum":["day","week","month","half_year"]},"example":"week"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/videos/transcript/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.videos.transcript.get","tags":["tiktok"],"summary":"TikTok video transcript","x-capability":{"id":"tiktok.videos.transcript.get","category":"social","role":"social.transcripts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"lang":"capability"}},"description":"Get what is said in a TikTok video by ID or link: the whole text and timed segments. lang chooses the language of the captions.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.tiktok.com/@nasa/video/7665840565958872333).","parameters":[{"name":"id","in":"query","description":"Video ID, a string of digits","schema":{"type":"string"},"example":"7665840565958872333"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the https://www.tiktok.com/@handle/video/… web link, the www.tiktok.com/t/… or vm.tiktok.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.tiktok.com/@nasa/video/7665840565958872333"},{"name":"lang","in":"query","description":"Which language of captions to get, as a two-letter language code (en, es, ja, say); left out, the platform's default. A video without captions in that language is answered as one without captions","schema":{"type":"string"},"example":"en"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/transcript.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.comments.replies.list","tags":["weibo"],"summary":"Weibo comment replies","x-capability":{"id":"weibo.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","author.username":"platform","metrics.comments":"platform"}},"description":"Get a page of replies to a Weibo comment by comment ID: text, replier, likes, what it answers, time posted, IP location.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"Comment ID, a string of digits (the id the comment list returns)","schema":{"type":"string"},"example":"5352434353571174"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/posts/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.posts.comments.list","tags":["weibo"],"summary":"Weibo post comments","x-capability":{"id":"weibo.posts.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","author.username":"platform"}},"description":"Get a page of comments on a Weibo post by post ID: text, commenter, likes, reply count, time posted, IP location.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://m.weibo.cn/detail/5352434046339577); share_text (看看这条微博 https://m.weibo.cn/detail/5352434046339577 来自微博).\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","description":"Post ID, a string of digits. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"5352434046339577"},{"name":"url","in":"query","description":"Link to the post, pasted as it is: the site's https://weibo.com/<user>/… (digits or letters after it), the phone site's https://m.weibo.cn/detail/… or /status/…, or a whole share text with one of these in it","schema":{"type":"string"},"example":"https://m.weibo.cn/detail/5352434046339577"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/posts/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.posts.get","tags":["weibo"],"summary":"Weibo post detail","x-capability":{"id":"weibo.posts.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"title":"platform","lang":"capability","author.username":"platform","author.followers":"capability","metrics.shares":"platform","metrics.favorites":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Weibo post by ID: the whole text (of a long post too), author, likes, comments, reposts, reads (plays on a video post), pictures, topics, IP location.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://m.weibo.cn/detail/5352571897120856); share_text (看看这条微博 https://m.weibo.cn/detail/5352571897120856 来自微博).","parameters":[{"name":"id","in":"query","description":"Post ID, a string of digits. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"5352571897120856"},{"name":"url","in":"query","description":"Link to the post, pasted as it is: the site's https://weibo.com/<user>/… (digits or letters after it), the phone site's https://m.weibo.cn/detail/… or /status/…, or a whole share text with one of these in it","schema":{"type":"string"},"example":"https://m.weibo.cn/detail/5352571897120856"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/posts/likers/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.posts.likers.list","tags":["weibo"],"summary":"Weibo post likers","x-capability":{"id":"weibo.posts.likers.list","category":"social","role":"social.posts.likers.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":50,"max":100},"unavailable":{"username":"platform"}},"description":"Get the accounts that most recently liked a Weibo post by post ID, about 50 at a time: name, bio, avatar, verification and its kind, follower and following counts, number of posts, the gender and region their profiles give.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://m.weibo.cn/detail/5352434046339577); share_text (看看这条微博 https://m.weibo.cn/detail/5352434046339577 来自微博).\n\n50 items on a usual page, 100 at most. Given whole: there is no next page.","parameters":[{"name":"id","in":"query","description":"Post ID, a string of digits. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"5352434046339577"},{"name":"url","in":"query","description":"Link to the post, pasted as it is: the site's https://weibo.com/<user>/… (digits or letters after it), the phone site's https://m.weibo.cn/detail/… or /status/…, or a whole share text with one of these in it","schema":{"type":"string"},"example":"https://m.weibo.cn/detail/5352434046339577"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/posts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.posts.search","tags":["weibo"],"summary":"Weibo realtime search","x-capability":{"id":"weibo.posts.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","author.username":"platform","metrics.shares":"platform","metrics.favorites":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of Weibo posts for search terms, newest first: text (a long post is cut short here), author and follower count, likes, comments, reposts, video plays, pictures, topics.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"新能源汽车"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.trends.list","tags":["weibo"],"summary":"Weibo hot search board","x-capability":{"id":"weibo.trends.list","category":"social","role":"social.trends.list","backup":"weibo.backup.trends.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":50,"max":51},"unavailable":{"id":"platform"}},"description":"Get Weibo's current hot search list, 50 terms, with rank, heat and label (new, hot and the like).\n\nPrice: $0.002 per call.\n\n50 items on a usual page, 51 at most. Given whole: there is no next page.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which list: hot searches is the only one","schema":{"type":"string","enum":["hot_search"],"default":"hot_search"},"example":"hot_search"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/users/followers/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.users.followers.list","tags":["weibo"],"summary":"Weibo user followers","x-capability":{"id":"weibo.users.followers.list","category":"social","role":"social.accounts.followers.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"username":"platform"}},"description":"Get a page of the accounts following a Weibo user, 20 a page: name, bio, avatar, verification and its kind, follower and following counts, number of posts, when the account was opened, the gender and region their profiles give.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"User ID (uid), a string of digits: the number after weibo.com/u/ in a profile link","schema":{"type":"string"},"example":"2803301701"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.users.get","tags":["weibo"],"summary":"Weibo user profile","x-capability":{"id":"weibo.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"username":"platform","created_at":"capability"}},"description":"Get a Weibo user's profile by user ID: name, bio, avatar, verification, follower and following counts, number of posts. It also gives what the verification says, the profile's totals of reposts, comments and likes, gender and region.\n\nPrice: $0.002 per call.","parameters":[{"name":"id","in":"query","required":true,"description":"User ID (uid), a string of digits: the number after weibo.com/u/ in a profile link","schema":{"type":"string"},"example":"2803301701"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/users/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.users.posts.list","tags":["weibo"],"summary":"Weibo user posts","x-capability":{"id":"weibo.users.posts.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":25,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","author.username":"platform","author.followers":"capability","metrics.shares":"platform","metrics.favorites":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the posts on a Weibo user's profile (their own and their reposts) by user ID, newest first: text (a long post is cut short here), likes, comments, reposts, video plays, pictures, topics, IP location, whether pinned.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 25 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"User ID (uid), a string of digits","schema":{"type":"string"},"example":"2803301701"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/users/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.users.search","tags":["weibo"],"summary":"Weibo user search","x-capability":{"id":"weibo.users.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"username":"platform","bio":"capability","verified":"capability","created_at":"capability","metrics":"capability"}},"description":"Get a page of Weibo users for search terms: ID, name, avatar, profile link.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"小米"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/posts/quotes/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.posts.quotes.list","tags":["x"],"summary":"X post quotes","x-capability":{"id":"x.posts.quotes.list","category":"social","stability":"stable","pricing":{"per":"item","price":"0.0003","minimum":"0.0003","max_charge":"0.006","charge_when_empty":"0.0003","charge_when_not_found":"0.0003","variants":[{"param":"sort","value":"popular","per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"}]},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","metrics.shares":"platform","is_pinned":"capability","root_id":"platform"}},"description":"Get a page of the X posts that quote a post, newest first or most popular first.\n\nPrice: $0.0003 per item returned, at least $0.0003 and at most $0.006 per call. With sort=popular: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA post that does not exist cannot be told from a post nobody quoted: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"ID of the quoted post","schema":{"type":"string"},"example":"2108662426606395572"},{"name":"sort","in":"query","description":"Newest first, or most popular first (priced separately)","schema":{"type":"string","enum":["latest","popular"],"default":"latest"},"example":"latest"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/posts/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.posts.replies.list","tags":["x"],"summary":"X post replies","x-capability":{"id":"x.posts.replies.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":35,"max":60,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","metrics.shares":"platform","is_pinned":"capability","root_id":"platform","author.followers":"capability","images":"capability","parent_id":"capability"}},"description":"Get a page of the replies under an X post by its ID, in the platform's order of relevance; a reply on X is itself a post and is returned as one.\n\nPrice: $0.002 per call.\n\n35 items on a usual page, 60 at most. A cursor is valid for 3600 seconds.\n\nA post that does not exist is not answered with a 404: it is reported as an error that may be retried once and is not charged.","parameters":[{"name":"id","in":"query","required":true,"description":"Post ID, a string of digits","schema":{"type":"string"},"example":"2108198226532708497"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/posts/retweeters/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.posts.retweeters.list","tags":["x"],"summary":"X post retweeters","x-capability":{"id":"x.posts.retweeters.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":100,"max":100,"cursor_ttl_seconds":3600},"unavailable":{"avatar_url":"capability","verified":"capability","created_at":"capability"}},"description":"Get a page of the accounts that retweeted an X post, by the post's ID: handle, name, bio, follower count.\n\nPrice: $0.002 per call.\n\n100 items on a usual page, 100 at most. A cursor is valid for 3600 seconds.\n\nA post that does not exist cannot be told from a post nobody retweeted: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"Post ID, a string of digits","schema":{"type":"string"},"example":"2108198226532708497"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/posts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.posts.search","tags":["x"],"summary":"X post search","x-capability":{"id":"x.posts.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","metrics.shares":"platform","is_pinned":"capability","root_id":"platform"}},"description":"Find X posts by search terms, most popular or newest first; the terms may use X's own search operators, such as from:handle.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"weather forecast"},{"name":"sort","in":"query","description":"Most popular first, or newest first","schema":{"type":"string","enum":["popular","latest"],"default":"popular"},"example":"popular"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/threads/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.threads.posts.list","tags":["x"],"summary":"X thread context","x-capability":{"id":"x.threads.posts.list","category":"social","stability":"stable","pricing":{"per":"item","price":"0.0003","minimum":"0.0003","max_charge":"0.015","charge_when_empty":"0.0003","charge_when_not_found":"0.0003"},"page":{"typical":20,"max":50,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","metrics.shares":"platform","is_pinned":"capability","root_id":"platform"}},"description":"Get the posts of an X thread by the ID of any post in it: the root post, the author's follow-ups and the replies among them.\n\nPrice: $0.0003 per item returned, at least $0.0003 and at most $0.015 per call.\n\n20 items on a usual page, 50 at most. A cursor is valid for 3600 seconds.\n\nA post that does not exist cannot be told from a post with no thread: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"ID of any post in the thread","schema":{"type":"string"},"example":"2108198226532708497"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.trends.list","tags":["x"],"summary":"X trends","x-capability":{"id":"x.trends.list","category":"social","role":"social.trends.list","stability":"stable","pricing":{"per":"call","price":"0.009","max_charge":"0.009","charge_when_empty":"0"},"page":{"typical":30,"max":30},"unavailable":{"id":"platform","heat":"capability"}},"description":"Get the top 30 of what is trending on X now, with rank: worldwide, or in one country.\n\nPrice: $0.009 per call.\n\n30 items on a usual page, 30 at most. Given whole: there is no next page.\n\nServed from a shared snapshot for up to 300 seconds.","parameters":[{"name":"board","in":"query","description":"Which list: trends is the only one","schema":{"type":"string","enum":["trends"],"default":"trends"},"example":"trends"},{"name":"region","in":"query","description":"Which country's trends, by its two-letter code: US, GB, CA, AU, IN, JP, DE, FR, BR or MX; worldwide when left out","schema":{"type":"string"},"example":"US"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/users/followers/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.users.followers.list","tags":["x"],"summary":"X user followers","x-capability":{"id":"x.users.followers.list","category":"social","role":"social.accounts.followers.list","stability":"stable","pricing":{"per":"item","price":"0.0001","minimum":"0.0004","max_charge":"0.02","charge_when_empty":"0.0004","charge_when_not_found":"0.0004"},"page":{"typical":200,"max":200,"cursor_ttl_seconds":3600},"unavailable":{"verified":"capability"}},"description":"Get a page of the accounts following an X user, up to 200 a page, newest followers first.\n\nPrice: $0.0001 per item returned, at least $0.0004 and at most $0.02 per call.\n\n200 items on a usual page, 200 at most. A cursor is valid for 3600 seconds.\n\nAn account that does not exist cannot be told from an account nobody follows: both return an empty result, not a 404.","parameters":[{"name":"username","in":"query","required":true,"description":"X handle, without the @","schema":{"type":"string"},"example":"NASA"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/users/following/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.users.following.list","tags":["x"],"summary":"X user following","x-capability":{"id":"x.users.following.list","category":"social","role":"social.accounts.following.list","stability":"stable","pricing":{"per":"item","price":"0.0001","minimum":"0.0004","max_charge":"0.02","charge_when_empty":"0.0004","charge_when_not_found":"0.0004"},"page":{"typical":200,"max":200,"cursor_ttl_seconds":3600},"unavailable":{"verified":"capability"}},"description":"Get a page of the accounts an X user follows, up to 200 a page.\n\nPrice: $0.0001 per item returned, at least $0.0004 and at most $0.02 per call.\n\n200 items on a usual page, 200 at most. A cursor is valid for 3600 seconds.\n\nAn account that does not exist cannot be told from an account that follows nobody: both return an empty result, not a 404.","parameters":[{"name":"username","in":"query","required":true,"description":"X handle, without the @","schema":{"type":"string"},"example":"WHO"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.users.get","tags":["x"],"summary":"X user profile","x-capability":{"id":"x.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"item","price":"0.0004","minimum":"0.0004","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.0004"}},"description":"Get an X user's profile by handle or ID: name, bio, follower and following counts, whether it has a badge and which (a business's gold, a government's grey), the location it gives, its website; up to 100 IDs in one request.\n\nPrice: $0.0004 per item returned, at least $0.0004 and at most $0.04 per call.\n\nGive exactly one of id, username, ids.","parameters":[{"name":"id","in":"query","description":"X user ID, a string of digits","schema":{"type":"string"},"example":"11348282"},{"name":"username","in":"query","description":"X handle, without the @","schema":{"type":"string"},"example":"NASA"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"x.users.get.batch","tags":["x"],"summary":"X user profile (batch)","x-capability":{"id":"x.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"item","price":"0.0004","minimum":"0.0004","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.0004"}},"description":"Get an X user's profile by handle or ID: name, bio, follower and following counts, whether it has a badge and which (a business's gold, a government's grey), the location it gives, its website; up to 100 IDs in one request.\n\nPrice: $0.0004 per item returned, at least $0.0004 and at most $0.04 per call.\n\nGive exactly one of id, username, ids.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":100,"description":"Several X user IDs, each a string of digits"},"view":{"type":"string","enum":["compact","standard","full"],"default":"standard","description":"How much of each item to return"},"fields":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Return only these fields"}}},"example":{"ids":["11348282","415859364"]}}}},"responses":{"200":{"$ref":"#/components/responses/account.items.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/users/mentions/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.users.mentions.list","tags":["x"],"summary":"X user mentions","x-capability":{"id":"x.users.mentions.list","category":"social","stability":"stable","pricing":{"per":"item","price":"0.0003","minimum":"0.0003","max_charge":"0.006","charge_when_empty":"0.0003","charge_when_not_found":"0.0003"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","metrics.shares":"platform","is_pinned":"capability","root_id":"platform"}},"description":"Get a page of the posts that mention an X user, newest first.\n\nPrice: $0.0003 per item returned, at least $0.0003 and at most $0.006 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nAn account that does not exist cannot be told from an account nobody mentions: both return an empty result, not a 404.","parameters":[{"name":"username","in":"query","required":true,"description":"X handle, without the @","schema":{"type":"string"},"example":"NASA"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/users/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.users.posts.list","tags":["x"],"summary":"X user posts","x-capability":{"id":"x.users.posts.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":60,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","metrics.shares":"platform","is_pinned":"capability","root_id":"platform"},"when":[{"params":["username","tab"],"values":{"tab":"media"},"unavailable":{"hashtags":"capability","mentions":"capability"}}]},"description":"Get a page of the posts on an X user's profile by handle, newest first; tab chooses the posts, replies or media tab. The posts tab holds the account's retweets: ext.is_retweet marks them, with the original post's ID and its author's ID.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 60 at most. A cursor is valid for 3600 seconds.\n\nWith username, tab=media: without hashtags, mentions.\n\nAn account that does not exist is not answered with a 404: it is reported as an error that may be retried once and is not charged.","parameters":[{"name":"username","in":"query","required":true,"description":"X handle, without the @","schema":{"type":"string"},"example":"NASA"},{"name":"tab","in":"query","description":"Which tab of the profile: posts (retweets among them), replies (the account's own only: the posts of others it replies to are left out, and parent_id names them), or media","schema":{"type":"string","enum":["posts","replies","media"],"default":"posts"},"example":"posts"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/users/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.users.search","tags":["x"],"summary":"X user search","x-capability":{"id":"x.users.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"item","price":"0.0004","minimum":"0.0004","max_charge":"0.008","charge_when_empty":"0.0004","charge_when_not_found":"0.0004"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600}},"description":"Find X accounts by search terms, about 20 a page: handle, name, bio, follower count, verification.\n\nPrice: $0.0004 per item returned, at least $0.0004 and at most $0.008 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"Smithsonian"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/images/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.images.search","tags":["xiaohongshu"],"summary":"Xiaohongshu image search","x-capability":{"id":"xiaohongshu.images.search","category":"social","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"capability","lang":"capability","published_at":"capability","metrics.views":"platform","metrics.reposts":"platform","metrics.shares":"capability","author.verified":"capability","author.followers":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Search Xiaohongshu pictures by terms, a page at a time; each result is one picture with the note it belongs to: the picture's address, the note's title, text, author, likes, comments, saves and shares. Shares are not given here (they always read 0, so they are left out); xiaohongshu.notes.get gives a note's shares.\n\nPrice: $0.02 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"壁纸"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/notes/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.notes.get","tags":["xiaohongshu"],"summary":"Xiaohongshu note detail","x-capability":{"id":"xiaohongshu.notes.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0","charge_when_not_found":"0.02"},"unavailable":{"metrics.views":"platform","metrics.reposts":"platform","author.verified":"capability","author.followers":"capability","mentions.username":"platform","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Xiaohongshu note by ID or link: title, text, author, engagement counts, images. It also says whether it is a brand partnership note on record.\n\nPrice: $0.02 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.xiaohongshu.com/explore/6ac76250000000000a021233?xsec_token=ABx1y2z3); share_text (周末咖啡探店合集 https://www.xiaohongshu.com/discovery/item/6ac76250000000000a021233?xsec_token=ABx1y2z3 复制这段文字，打开小红书查看).","parameters":[{"name":"id","in":"query","description":"Note ID, 24 hexadecimal characters. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"6ac76250000000000a021233"},{"name":"url","in":"query","description":"Link to the note, pasted as it is: the https://www.xiaohongshu.com/explore/… address from the browser, the https://www.xiaohongshu.com/discovery/item/… link the website shares (query parameters such as xsec_token are fine), a whole share text with such a link in it, or the xhslink.com short link the app copies (alone or in its share text). A short link is opened once to see which note it leads to; where it cannot be, paste the note's full link or its ID","schema":{"type":"string"},"example":"https://www.xiaohongshu.com/explore/6ac76250000000000a021233?xsec_token=ABx1y2z3"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.comments.replies.list","tags":["xiaohongshu"],"summary":"Xiaohongshu comment replies","x-capability":{"id":"xiaohongshu.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":5,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","metrics.comments":"platform"}},"description":"Get a page of replies to a Xiaohongshu comment, by the comment's ID and its note's ID: text, replier, likes, time posted, which comment it answers.\n\nPrice: $0.02 per call.\n\n5 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA comment that does not exist cannot be told from a comment without replies: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"ID of the top-level comment","schema":{"type":"string"},"example":"6a9c5c160000000015022a5c"},{"name":"post_id","in":"query","required":true,"description":"ID of the note the comment is under: the comment's post_id","schema":{"type":"string"},"example":"6a9c5884000000002b002d95"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/notes/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.notes.comments.list","tags":["xiaohongshu"],"summary":"Xiaohongshu note comments","x-capability":{"id":"xiaohongshu.notes.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":10,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform"},"when":[{"params":["id","sort"],"values":{"sort":"latest"},"may_be_absent":["ext.ip_location"]},{"params":["id","sort"],"values":{"sort":"popular"},"may_be_absent":["ext.ip_location"]},{"params":["url","sort"],"values":{"sort":"latest"},"may_be_absent":["ext.ip_location"]},{"params":["url","sort"],"values":{"sort":"popular"},"may_be_absent":["ext.ip_location"]}]},"description":"Get a page of top-level comments on a Xiaohongshu note by ID or link, newest first or hottest first: text, commenter, likes, reply count, time posted.\n\nPrice: $0.02 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.xiaohongshu.com/explore/6a9c5884000000002b002d95?xsec_token=ABx1y2z3); share_text (周末咖啡探店合集 https://www.xiaohongshu.com/discovery/item/6a9c5884000000002b002d95?xsec_token=ABx1y2z3 复制这段文字，打开小红书查看).\n\n10 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nWith id, sort=latest: may lack ext.ip_location.\n\nWith id, sort=popular: may lack ext.ip_location.\n\nWith url, sort=latest: may lack ext.ip_location.\n\nWith url, sort=popular: may lack ext.ip_location.","parameters":[{"name":"id","in":"query","description":"Note ID, 24 hexadecimal characters. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"6a9c5884000000002b002d95"},{"name":"url","in":"query","description":"Link to the note, pasted as it is: the https://www.xiaohongshu.com/explore/… address from the browser, the https://www.xiaohongshu.com/discovery/item/… link the website shares (query parameters such as xsec_token are fine), a whole share text with such a link in it, or the xhslink.com short link the app copies (alone or in its share text). A short link is opened once to see which note it leads to; where it cannot be, paste the note's full link or its ID","schema":{"type":"string"},"example":"https://www.xiaohongshu.com/explore/6a9c5884000000002b002d95?xsec_token=ABx1y2z3"},{"name":"sort","in":"query","description":"Newest first (the default), or hottest first (most liked first)","schema":{"type":"string","enum":["latest","popular"],"default":"latest"},"example":"latest"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/notes/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.notes.search","tags":["xiaohongshu"],"summary":"Xiaohongshu note search","x-capability":{"id":"xiaohongshu.notes.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","metrics.views":"platform","metrics.reposts":"platform","author.verified":"capability","author.followers":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Search Xiaohongshu notes by terms: title, text, author, engagement counts, images, and a link that opens. Each says whether it is a brand partnership note on record. By relevance, newest, most liked, most commented or most saved; video or image notes only; published in the last day, week or half year.\n\nPrice: $0.02 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"咖啡"},{"name":"sort","in":"query","description":"Sort order: relevance, newest, most liked, most commented, most saved","schema":{"type":"string","enum":["relevance","latest","popular","most_comments","most_favorites"],"default":"relevance"},"example":"relevance"},{"name":"type","in":"query","description":"Video notes only (video) or image notes only (image); both when left out","schema":{"type":"string","enum":["video","image"]},"example":"video"},{"name":"published_within","in":"query","description":"Only those published in the last day, week or half year","schema":{"type":"string","enum":["day","week","half_year"]},"example":"week"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/keywords/history":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.keywords.history","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY keyword search index","x-capability":{"id":"xiaohongshu.pgy.keywords.history","category":"social","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.04"},"unavailable":{"points.composite_index":"platform"}},"description":"Get a keyword's day-by-day search index on Xiaohongshu over about the last three months, from the platform's creator marketplace, with each day's notes about the keyword and how often they were shown, read and engaged with. The platform sets the period; it cannot be chosen. The search index is the platform's index, not a count of searches; days are calendar days in China time (UTC+8).\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"keyword","in":"query","required":true,"description":"One keyword","schema":{"type":"string"},"example":"面膜"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/keyword_history.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/keywords/related":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.keywords.related","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY related keywords","x-capability":{"id":"xiaohongshu.pgy.keywords.related","category":"social","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0.04","charge_when_not_found":"0.04"},"page":{"typical":98,"max":120},"unavailable":{"relevance":"platform","composite_index":"platform"}},"description":"Get what people search on Xiaohongshu before and after a keyword, from the platform's creator marketplace, each with its place by relevance, its search index, the notes about it and their reads: for expanding a seed keyword. The search index is the platform's index, not a count of searches; for a word the platform gives no figures for, these are null.\n\nPrice: $0.04 per call.\n\n98 items on a usual page, 120 at most. Given whole: there is no next page.\n\nA keyword the platform has no data for reads like one with no related keywords: an empty result, never a not-found error.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"keyword","in":"query","required":true,"description":"One keyword","schema":{"type":"string"},"example":"面膜"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/keyword_related.items.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/topics/notes/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.topics.notes.list","tags":["xiaohongshu"],"summary":"Xiaohongshu topic notes","x-capability":{"id":"xiaohongshu.topics.notes.list","category":"social","role":"social.topics.posts.list","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":10,"max":10},"unavailable":{"lang":"capability","author.username":"capability","author.verified":"capability","author.followers":"capability","metrics.views":"platform","metrics.reposts":"platform","mentions.username":"platform","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get the trending notes under a Xiaohongshu topic by its page ID: title, text, author, engagement counts, images, hashtags.\n\nPrice: $0.02 per call.\n\n10 items on a usual page, 10 at most. Given whole: there is no next page.\n\nA topic that does not exist cannot be told from a topic without notes: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"Topic page ID, 24 hexadecimal characters","schema":{"type":"string"},"example":"5eb2e2ffbd997100014327bc"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/topics/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.topics.get","tags":["xiaohongshu"],"summary":"Xiaohongshu topic detail","x-capability":{"id":"xiaohongshu.topics.get","category":"social","role":"social.topics.get","stability":"preview","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0","charge_when_not_found":"0.02"},"unavailable":{"metrics.posts":"platform"}},"description":"Get one Xiaohongshu topic by its page ID: name, description, views, the discussion count the page shows, share link.\n\nPrice: $0.02 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Topic page ID, 24 hexadecimal characters","schema":{"type":"string"},"example":"5eb2e2ffbd997100014327bc"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/topic.item.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.trends.list","tags":["xiaohongshu"],"summary":"Xiaohongshu trends","x-capability":{"id":"xiaohongshu.trends.list","category":"social","role":"social.trends.list","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"rank":"capability"}},"description":"Get the hot topics Xiaohongshu suggests to creators: name and the platform's heat score.\n\nPrice: $0.02 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which list: hot topics of the creator inspiration feed","schema":{"type":"string","enum":["inspiration"],"default":"inspiration"},"example":"inspiration"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.users.get","tags":["xiaohongshu"],"summary":"Xiaohongshu user profile","x-capability":{"id":"xiaohongshu.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0"},"unavailable":{"created_at":"capability"}},"description":"Get a Xiaohongshu account by user ID or profile link: name, handle, bio, follower, following and note counts, verification, and the gender and region its profile shows.\n\nPrice: $0.02 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.xiaohongshu.com/user/profile/63bed214000000002702b862?xsec_token=ABx1y2z3); share_text (周末咖啡探店合集 https://www.xiaohongshu.com/user/profile/63bed214000000002702b862?xsec_token=ABx1y2z3 复制这段文字，打开小红书查看).","parameters":[{"name":"id","in":"query","description":"User ID, 24 hexadecimal characters. With only a profile link, give it as url","schema":{"type":"string"},"example":"63bed214000000002702b862"},{"name":"url","in":"query","description":"Link to the profile, pasted as it is: https://www.xiaohongshu.com/user/profile/… (query parameters such as xsec_token are fine), a whole share text with such a link in it, or the xhslink.com short link the app copies. A short link is opened once to see which profile it leads to; where it cannot be, paste the profile's full link or the user ID","schema":{"type":"string"},"example":"https://www.xiaohongshu.com/user/profile/63bed214000000002702b862?xsec_token=ABx1y2z3"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/users/notes/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.users.notes.list","tags":["xiaohongshu"],"summary":"Xiaohongshu user notes","x-capability":{"id":"xiaohongshu.users.notes.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":20,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"url":"capability","lang":"capability","author.username":"capability","author.verified":"capability","author.followers":"capability","metrics.views":"platform","metrics.reposts":"platform","hashtags":"capability","mentions.username":"platform","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the notes a Xiaohongshu account posted, by user ID or profile link: title, text, engagement counts, images, whether pinned.\n\nPrice: $0.02 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.xiaohongshu.com/user/profile/63bed214000000002702b862?xsec_token=ABx1y2z3); share_text (周末咖啡探店合集 https://www.xiaohongshu.com/user/profile/63bed214000000002702b862?xsec_token=ABx1y2z3 复制这段文字，打开小红书查看).\n\n20 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","description":"User ID, 24 hexadecimal characters. With only a profile link, give it as url","schema":{"type":"string"},"example":"63bed214000000002702b862"},{"name":"url","in":"query","description":"Link to the profile, pasted as it is: https://www.xiaohongshu.com/user/profile/… (query parameters such as xsec_token are fine), a whole share text with such a link in it, or the xhslink.com short link the app copies. A short link is opened once to see which profile it leads to; where it cannot be, paste the profile's full link or the user ID","schema":{"type":"string"},"example":"https://www.xiaohongshu.com/user/profile/63bed214000000002702b862?xsec_token=ABx1y2z3"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/users/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.users.search","tags":["xiaohongshu"],"summary":"Xiaohongshu user search","x-capability":{"id":"xiaohongshu.users.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"bio":"capability","created_at":"capability","metrics":"capability"}},"description":"Search Xiaohongshu accounts by terms: user ID, handle, name, avatar, verification.\n\nPrice: $0.02 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"Nike"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/channels/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.channels.get","tags":["youtube"],"summary":"YouTube channel profile","x-capability":{"id":"youtube.channels.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"metrics.following":"platform"}},"description":"Get a YouTube channel by ID or handle: name, description, subscriber count, video count, total views, verification, the day it was created, the links its About section lists (its website, its other social accounts) and its keywords.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, username.","parameters":[{"name":"id","in":"query","description":"Channel ID, starting with UC","schema":{"type":"string"},"example":"UC_x5XG1OV2P6uZZ5FSM9Ttw"},{"name":"username","in":"query","description":"The channel's handle, without the @","schema":{"type":"string"},"example":"NASA"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.youtube"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/channels/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.channels.search","tags":["youtube"],"summary":"YouTube channel search","x-capability":{"id":"youtube.channels.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":40,"cursor_ttl_seconds":3600},"unavailable":{"created_at":"capability","metrics.following":"platform","metrics.posts":"capability"}},"description":"Find YouTube channels by search terms: name, handle, description, subscriber count, verification.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 40 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/channels/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.channels.videos.list","tags":["youtube"],"summary":"YouTube channel videos","x-capability":{"id":"youtube.channels.videos.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":30,"max":60,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.verified":"capability","author.followers":"capability","metrics.shares":"platform","metrics.favorites":"platform","metrics.reposts":"platform","hashtags":"capability","mentions":"capability","is_pinned":"platform","post_id":"platform","parent_id":"platform","root_id":"platform"},"when":[{"params":["id","type","sort"],"values":{"type":"video","sort":"latest"},"unavailable":{"metrics.comments":"capability"}},{"params":["id","type","sort"],"values":{"type":"video","sort":"popular"},"unavailable":{"metrics.comments":"capability"}},{"params":["id","type","sort"],"values":{"type":"short","sort":"latest"},"unavailable":{"author":"capability"},"paging":false},{"params":["id","type","sort"],"values":{"type":"short","sort":"popular"},"unavailable":{"author":"capability"},"paging":false},{"params":["username","type","sort"],"values":{"type":"video","sort":"latest"},"unavailable":{"metrics.comments":"capability"}},{"params":["username","type","sort"],"values":{"type":"video","sort":"popular"},"unavailable":{"metrics.comments":"capability"}},{"params":["username","type","sort"],"values":{"type":"short","sort":"latest"},"unavailable":{"author":"capability"},"paging":false},{"params":["username","type","sort"],"values":{"type":"short","sort":"popular"},"unavailable":{"author":"capability"},"paging":false}]},"description":"Get a page of a YouTube channel's videos or Shorts by channel ID or handle, newest or most viewed first: title, description, time published, views, likes, length.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, username.\n\n30 items on a usual page, 60 at most. A cursor is valid for 3600 seconds.\n\nWith id, type=video, sort=latest: without metrics.comments.\n\nWith id, type=video, sort=popular: without metrics.comments.\n\nWith id, type=short, sort=latest: no next page; without author.\n\nWith id, type=short, sort=popular: no next page; without author.\n\nWith username, type=video, sort=latest: without metrics.comments.\n\nWith username, type=video, sort=popular: without metrics.comments.\n\nWith username, type=short, sort=latest: no next page; without author.\n\nWith username, type=short, sort=popular: no next page; without author.\n\nA channel that does not exist cannot be told from a channel without such videos: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","description":"Channel ID, starting with UC","schema":{"type":"string"},"example":"UC_x5XG1OV2P6uZZ5FSM9Ttw"},{"name":"username","in":"query","description":"The channel's handle, without the @","schema":{"type":"string"},"example":"NASA"},{"name":"type","in":"query","description":"Regular videos, or Shorts","schema":{"type":"string","enum":["video","short"],"default":"video"},"example":"video"},{"name":"sort","in":"query","description":"Newest first, or most viewed first","schema":{"type":"string","enum":["latest","popular"],"default":"latest"},"example":"latest"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.youtube"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.comments.replies.list","tags":["youtube"],"summary":"YouTube comment replies","x-capability":{"id":"youtube.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":50,"cursor_ttl_seconds":3600},"unavailable":{"url":"capability","published_at":"capability","post_id":"capability","parent_id":"capability","metrics.comments":"platform"}},"description":"Get a page of the replies to a YouTube comment, by the replies token the comment list gives: text, replier, likes.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 50 at most. A cursor is valid for 3600 seconds.\n\nA replies token that leads nowhere never returns a 404: one that is not shaped like a token is refused when the request is validated; one that is and finds no replies returns an empty result, or an error that is not charged.","parameters":[{"name":"id","in":"query","required":true,"description":"The comment's replies token: ext.replies_token as the video comments endpoint returns it (full view only), not the comment's ID","schema":{"type":"string"},"example":"Eg0SC2RRdzR3OVdnWGNRGAYygwEaUBIaVWd6Z2UzNDBkQmdCNzVoV0JtNTRBYUFCQWciAggAKhhVQ3VBWEZrZ3N3MUw3eGFDZm5kNUpKT3cyC2RRdzR3OVdnWGNRQABICoIBAggBQi9jb21tZW50LXJlcGxpZXMtaXRlbS1VZ3pnZTM0MGRCZ0I3NWhXQm01NEFhQUJBZw%3D%3D"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/videos/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.videos.comments.list","tags":["youtube"],"summary":"YouTube video comments","x-capability":{"id":"youtube.videos.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"capability","published_at":"capability","post_id":"capability"}},"description":"Get a page of comments on a YouTube video by ID or link, top or newest first: text, commenter, likes, reply count, and the token that gets a comment's replies.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.youtube.com/watch?v=dQw4w9WgXcQ); short (https://youtu.be/dQw4w9WgXcQ).\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","description":"Video ID","schema":{"type":"string"},"example":"dQw4w9WgXcQ"},{"name":"url","in":"query","description":"Link to the video: a watch, shorts, embed, live or youtu.be link","schema":{"type":"string"},"example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"},{"name":"sort","in":"query","description":"Top comments first, or newest first","schema":{"type":"string","enum":["popular","latest"],"default":"popular"},"example":"popular"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.youtube"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/videos/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.videos.get","tags":["youtube"],"summary":"YouTube video detail","x-capability":{"id":"youtube.videos.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"lang":"capability","author.verified":"capability","author.followers":"capability","metrics.shares":"platform","metrics.favorites":"platform","metrics.reposts":"platform","hashtags":"capability","mentions":"capability","is_pinned":"platform","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one YouTube video by ID or link: title, description, channel, time published, view, like and comment counts, length, and the tags its author set, its category and chapters.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.youtube.com/watch?v=dQw4w9WgXcQ); short (https://youtu.be/dQw4w9WgXcQ).","parameters":[{"name":"id","in":"query","description":"Video ID","schema":{"type":"string"},"example":"dQw4w9WgXcQ"},{"name":"url","in":"query","description":"Link to the video: a watch, shorts, embed, live or youtu.be link","schema":{"type":"string"},"example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.youtube"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/videos/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.videos.search","tags":["youtube"],"summary":"YouTube video search","x-capability":{"id":"youtube.videos.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":100,"cursor_ttl_seconds":3600},"unavailable":{"text":"capability","lang":"capability","published_at":"capability","author.verified":"capability","author.followers":"capability","metrics.likes":"capability","metrics.comments":"capability","metrics.shares":"platform","metrics.favorites":"platform","metrics.reposts":"platform","hashtags":"capability","mentions":"capability","is_pinned":"platform","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Find YouTube videos by search terms, by relevance or by views, within a time window: title, channel, views, length.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 100 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"meteor shower"},{"name":"sort","in":"query","description":"By relevance, or most viewed first","schema":{"type":"string","enum":["relevance","popular"],"default":"relevance"},"example":"relevance"},{"name":"published_within","in":"query","description":"Published within the last period","schema":{"type":"string","enum":["day","week","month","year"]},"example":"week"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.youtube"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/videos/transcript/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.videos.transcript.get","tags":["youtube"],"summary":"YouTube video transcript","x-capability":{"id":"youtube.videos.transcript.get","category":"social","role":"social.transcripts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"}},"description":"Get the transcript of a YouTube video by ID or link: the whole text and timed segments. lang chooses the language of the captions.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.youtube.com/watch?v=dQw4w9WgXcQ); short (https://youtu.be/dQw4w9WgXcQ).","parameters":[{"name":"id","in":"query","description":"Video ID","schema":{"type":"string"},"example":"dQw4w9WgXcQ"},{"name":"url","in":"query","description":"Link to the video: a watch, shorts, embed, live or youtu.be link","schema":{"type":"string"},"example":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"},{"name":"lang","in":"query","description":"Which language of captions to get, as a language code (en, es, ja, zh-Hans, say); left out, the captions of the video's own language come first. A video without captions in that language is answered as one without captions","schema":{"type":"string"},"example":"en"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/transcript.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.users.get","tags":["wechat_channels"],"summary":"WeChat Channels account profile","x-capability":{"id":"wechat_channels.users.get","category":"social","role":"social.accounts.get","backup":"wechat_channels.backup.users.get","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0"},"unavailable":{"username":"platform","url":"platform","verified":"capability","created_at":"capability","metrics.followers":"capability","metrics.following":"platform"}},"description":"Get a WeChat Channels account by its ID: name, signature, avatar, IP location, number of videos.\n\nPrice: $0.02 per call.","parameters":[{"name":"id","in":"query","required":true,"description":"The Channels account's ID, starting with v2_ and ending in @finder. Find it by name with wechat_channels.users.search, or look up one of its videos with wechat_channels.videos.get (by share link or a search result's export_id): the author.id returned is it. The sph… ID the app shows is not it","schema":{"type":"string"},"example":"v2_060000231003b20faec8c5e5811dc3ddce02ec30b0772029a703e1b9f446ba147658bbcfab81@finder"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/videos/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.videos.get","tags":["wechat_channels"],"summary":"WeChat Channels video detail","x-capability":{"id":"wechat_channels.videos.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0","charge_when_not_found":"0.02"},"unavailable":{"url":"platform","title":"platform","lang":"capability","author.username":"platform","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one WeChat Channels video by its ID, a search result's export/ ID or its share link: description, author, time published, likes, comments, forwards, saves, and the video file's address with the key that decrypts it.\n\nPrice: $0.02 per call.\n\nGive exactly one of id, url, export_id.\n\nLinks taken by `url`: short (https://weixin.qq.com/sph/ABgJVPnSSu), cannot be checked against the result.","parameters":[{"name":"id","in":"query","description":"The video's ID, a string of digits: the id a video list gives","schema":{"type":"string"},"example":"14559898883113486609"},{"name":"url","in":"query","description":"The video's share link, starting with weixin.qq.com/sph/","schema":{"type":"string"},"example":"https://weixin.qq.com/sph/ABgJVPnSSu"},{"name":"export_id","in":"query","description":"The id of a wechat_channels.videos.search result, starting with export/. It expires: use it soon after the search. The id returned is the video's numeric ID","schema":{"type":"string"},"example":"export/UzFfBgAAxJeLPEsjEjWuk8zT4DCKThrNP5lzaPLJoEvz7FZtxw"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/videos/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.videos.comments.list","tags":["wechat_channels"],"summary":"WeChat Channels video comments","x-capability":{"id":"wechat_channels.videos.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02","charge_when_not_found":"0.02"},"page":{"typical":24,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","author.username":"platform","metrics.comments":"capability"}},"description":"Get a page of top-level comments on a WeChat Channels video by its ID: text, commenter, likes, time posted, IP location.\n\nPrice: $0.02 per call.\n\n24 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"The video's ID, a string of digits: the id a video list or a video gives","schema":{"type":"string"},"example":"14559898883113486609"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/videos/share_link/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.videos.share_link.get","tags":["wechat_channels"],"summary":"WeChat Channels video share link","x-capability":{"id":"wechat_channels.videos.share_link.get","category":"social","stability":"preview","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0","charge_when_not_found":"0.02"}},"description":"Make a link that opens a WeChat Channels video in WeChat, by the video's ID (it starts with weixin.qq.com/sph/). Each call makes a different link for the same video, and an older one still leads to it; a link cannot be built from the ID.\n\nPrice: $0.02 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"The video's ID, a string of digits: the id a video list or a video gives. A search result's export/ ID is first turned into it with wechat_channels.videos.get","schema":{"type":"string"},"example":"14940144898316503592"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/channels_share_link.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/users/collections/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.users.collections.list","tags":["wechat_channels"],"summary":"WeChat Channels account collections","x-capability":{"id":"wechat_channels.users.collections.list","category":"social","stability":"preview","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02","charge_when_not_found":"0.02"},"page":{"typical":7,"max":100}},"description":"Get every public collection of a WeChat Channels account by the account's ID: name, description, cover, number of videos, when it was last updated. A collection's ID is what the endpoint that lists its videos takes.\n\nPrice: $0.02 per call.\n\n7 items on a usual page, 100 at most. Given whole: there is no next page.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"The Channels account's ID, starting with v2_ and ending in @finder. Find it by name with wechat_channels.users.search, or look up one of its videos with wechat_channels.videos.get (by share link or a search result's export_id): the author.id returned is it. The sph… ID the app shows is not it","schema":{"type":"string"},"example":"v2_060000231003b20faec8c5e5811dc3ddce02ec30b0772029a703e1b9f446ba147658bbcfab81@finder"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/channels_collection.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/collections/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.collections.videos.list","tags":["wechat_channels"],"summary":"WeChat Channels collection videos","x-capability":{"id":"wechat_channels.collections.videos.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02","charge_when_not_found":"0.02"},"page":{"typical":20,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","title":"platform","lang":"capability","author.username":"platform","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the videos in a WeChat Channels collection by the collection's ID, in the collection's own order (oldest first), 20 a page: description, author, time published, likes, comments, forwards, saves.\n\nPrice: $0.02 per call.\n\n20 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"The collection's ID, a string of digits: the id an account's collection list gives","schema":{"type":"string"},"example":"14939347649320519707"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/users/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.users.videos.list","tags":["wechat_channels"],"summary":"WeChat Channels account videos","x-capability":{"id":"wechat_channels.users.videos.list","category":"social","role":"social.accounts.posts.list","backup":"wechat_channels.backup.users.videos.list","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02","charge_when_not_found":"0.02"},"page":{"typical":15,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","title":"platform","lang":"capability","author.username":"platform","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the videos a WeChat Channels account published, newest first, by the account's ID: description, time published, likes, comments, forwards, saves, length.\n\nPrice: $0.02 per call.\n\n15 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"The Channels account's ID, starting with v2_ and ending in @finder. Find it by name with wechat_channels.users.search, or look up one of its videos with wechat_channels.videos.get (by share link or a search result's export_id): the author.id returned is it. The sph… ID the app shows is not it","schema":{"type":"string"},"example":"v2_060000231003b20faec8c5e5811dc3ddce02ec30b0772029a703e1b9f446ba147658bbcfab81@finder"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/videos/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.videos.search","tags":["wechat_channels"],"summary":"WeChat Channels video search","x-capability":{"id":"wechat_channels.videos.search","category":"social","role":"social.posts.search","backup":"wechat_channels.backup.videos.search","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":10,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","title":"platform","lang":"capability","author.id":"capability","author.username":"platform","author.verified":"capability","author.followers":"capability","metrics.comments":"capability","metrics.shares":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of WeChat Channels videos for search terms through WeChat Search, by relevance, newest or hottest, filtered by time posted: description, the account's name and avatar, time published, likes and saves, length, cover. WeChat Search gives no account ID, and a video's ID is an encrypted one starting with export/: given as export_id to wechat_channels.videos.get it yields the numeric ID, the video file's address and the key that decrypts it; it expires, so use it soon.\n\nPrice: $0.02 per call.\n\n10 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"露营装备推荐"},{"name":"sort","in":"query","description":"By relevance, by time published (newest first) or by how hot","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"latest"},{"name":"published_within","in":"query","description":"Only those published in the last day, week or half year","schema":{"type":"string","enum":["day","week","half_year"]},"example":"week"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat/posts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat.posts.search","tags":["wechat"],"summary":"WeChat Search articles and videos","x-capability":{"id":"wechat.posts.search","category":"social","role":"social.posts.search","backup":"wechat.backup.posts.search","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":20,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.id":"capability","author.username":"capability","author.verified":"capability","author.followers":"capability","metrics.comments":"capability","metrics.shares":"capability","metrics.views":"capability","metrics.reposts":"capability","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of WeChat Search results for search terms: Official Account articles and Channels videos mixed, each saying in type whether it is an article or a video; by relevance, newest or hottest, filtered by time posted, or articles only or videos only: title or description, the source account's name, time published, an article's link (with a band of reads on some), a video's likes and saves. WeChat Search gives no account ID.\n\nPrice: $0.02 per call.\n\n20 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"咖啡店开业"},{"name":"sort","in":"query","description":"By relevance, by time published (newest first) or by how hot","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"relevance"},{"name":"published_within","in":"query","description":"Only those published in the last day, week or half year","schema":{"type":"string","enum":["day","week","half_year"]},"example":"week"},{"name":"type","in":"query","description":"Official Account articles only (article) or Channels videos only (video); both mixed when left out","schema":{"type":"string","enum":["article","video"]},"example":"article"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.wechat"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_mp/accounts/articles/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_mp.accounts.articles.list","tags":["wechat_mp"],"summary":"WeChat Official Account articles","x-capability":{"id":"wechat_mp.accounts.articles.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":10,"max":20,"cursor_ttl_seconds":3600,"note":{"zh":"也有更多的时候：一页是若干次推送里的全部文章，实测有过一页 63 条。","en":"Some pages hold more: a page is every article of a few pushes, and one has held 63."}},"unavailable":{"lang":"capability","author.username":"capability","author.name":"capability","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics":"capability","images":"capability","hashtags":"platform","mentions":"platform","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the articles a WeChat Official Account published, newest first: title, digest, link, time published. Each also says whether it was the lead article or one below, its format and cover. The page's articles tab by default; its videos or pictures tab when asked.\n\nPrice: $0.02 per call.\n\n10 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"The account's original ID, mostly starting with gh_ but not always, not the account's name; knowing only the name, find it with wechat.accounts.search and take id","schema":{"type":"string"},"example":"gh_13c97ab93ce8"},{"name":"tab","in":"query","description":"Which tab of the account's page: articles (the default), videos or pictures","schema":{"type":"string","enum":["articles","videos","images"],"default":"articles"},"example":"articles"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.wechat_mp"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_mp/accounts/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_mp.accounts.get","tags":["wechat_mp"],"summary":"WeChat Official Account profile","x-capability":{"id":"wechat_mp.accounts.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0"},"unavailable":{"username":"capability","url":"platform","bio":"capability","avatar_url":"capability","verified":"capability","created_at":"capability","metrics":"capability"}},"description":"Get a WeChat Official Account by its original ID: name, IP location, number of original articles, the linked Channels account, whether it is banned.\n\nPrice: $0.02 per call.","parameters":[{"name":"id","in":"query","required":true,"description":"The account's original ID, mostly starting with gh_ but not always, not the account's name; knowing only the name, find it with wechat.accounts.search and take id; an article's author.id is one too","schema":{"type":"string"},"example":"gh_13c97ab93ce8"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.wechat_mp"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_mp/articles/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_mp.articles.comments.list","tags":["wechat_mp"],"summary":"WeChat Official Account article comments","x-capability":{"id":"wechat_mp.articles.comments.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02","charge_when_not_found":"0.02"},"page":{"typical":20,"max":100,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","author.username":"platform","post_id":"capability"},"when":[{"params":["url"],"values":{},"may_be_absent":["author.id"]}]},"description":"Get a page of the featured comments on a WeChat Official Account article by its link: text, commenter, likes, reply count, time posted, IP location, whether it is pinned.\n\nPrice: $0.02 per call.\n\nLinks taken by `url`: long (https://mp.weixin.qq.com/s?__biz=MjM5MjAxNDM4MA==&mid=2667038683&idx=1&sn=0422127e651acd7f6cf6ef7e1cff04bc); short (https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw), cannot be checked against the result.\n\n20 items on a usual page, 100 at most. A cursor is valid for 3600 seconds.\n\nWith url: may lack author.id.","parameters":[{"name":"url","in":"query","required":true,"description":"Link to the article, pasted as it is: the long link with __biz, mid, idx and sn, the short /s/ link, or a share text with one of them in it","schema":{"type":"string"},"example":"https://mp.weixin.qq.com/s?__biz=MjM5MjAxNDM4MA==&mid=2667038683&idx=1&sn=0422127e651acd7f6cf6ef7e1cff04bc"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.wechat_mp"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_mp/articles/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_mp.articles.get","tags":["wechat_mp"],"summary":"WeChat Official Account article detail","x-capability":{"id":"wechat_mp.articles.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0","charge_when_not_found":"0.02"},"unavailable":{"lang":"capability","author.verified":"capability","author.followers":"capability","metrics":"capability","images":"capability","hashtags":"platform","mentions":"platform","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one WeChat Official Account article by its link: title, text, time published, the account's name and IDs. It also says whether it was the lead article or one below, its format, cover, digest, byline, \"read the original\" link and the IP location it was posted from.\n\nPrice: $0.02 per call.\n\nLinks taken by `url`: long (https://mp.weixin.qq.com/s?__biz=MjM5MjAxNDM4MA==&mid=2667038683&idx=1&sn=0422127e651acd7f6cf6ef7e1cff04bc); short (https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw), cannot be checked against the result.","parameters":[{"name":"url","in":"query","required":true,"description":"Link to the article, pasted as it is: the long link with __biz, mid, idx and sn, the short /s/ link, or a share text with one of them in it","schema":{"type":"string"},"example":"https://mp.weixin.qq.com/s?__biz=MjM5MjAxNDM4MA==&mid=2667038683&idx=1&sn=0422127e651acd7f6cf6ef7e1cff04bc"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.wechat_mp"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_mp/articles/metrics":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_mp.articles.metrics","tags":["wechat_mp"],"summary":"WeChat Official Account article stats","x-capability":{"id":"wechat_mp.articles.metrics","category":"social","role":"social.posts.metrics","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0","charge_when_not_found":"0.02"},"unavailable":{"url":"capability","type":"capability","title":"capability","text":"capability","lang":"capability","published_at":"capability","author":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get the current counts of a WeChat Official Account article by its long link: reads, likes, recommends, shares, saves, comments.\n\nPrice: $0.02 per call.\n\nLinks taken by `url`: long (https://mp.weixin.qq.com/s?__biz=MjM5MjAxNDM4MA==&mid=2667038683&idx=1&sn=0422127e651acd7f6cf6ef7e1cff04bc).","parameters":[{"name":"url","in":"query","required":true,"description":"The article's long link, with __biz, mid, idx and sn","schema":{"type":"string"},"example":"https://mp.weixin.qq.com/s?__biz=MjM5MjAxNDM4MA==&mid=2667038683&idx=1&sn=0422127e651acd7f6cf6ef7e1cff04bc"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.wechat_mp"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_mp/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_mp.comments.replies.list","tags":["wechat_mp"],"summary":"WeChat Official Account comment replies","x-capability":{"id":"wechat_mp.comments.replies.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02","charge_when_not_found":"0.02"},"page":{"typical":3,"max":20},"unavailable":{"url":"platform","author.username":"platform","metrics.comments":"platform","post_id":"capability"}},"description":"Get the replies under one comment on a WeChat Official Account article, by the comment's ID and the article's link: text, replier, likes, time posted, IP location, which reply each answers. The first batch only; no further pages.\n\nPrice: $0.02 per call.\n\n3 items on a usual page, 20 at most. Given whole: there is no next page.\n\nA comment that does not exist is usually a 404; it may also read like a comment without replies, an empty result rather than a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"The comment's ID, a string of digits: the id a comment list gives","schema":{"type":"string"},"example":"4898789068743115328"},{"name":"post_id","in":"query","required":true,"description":"Link to the article the comment is on (a WeChat Official Account article is named only by its link): the long link with __biz, mid, idx and sn, or the short /s/ link","schema":{"type":"string"},"example":"https://mp.weixin.qq.com/s?__biz=MjM5MjAxNDM4MA==&mid=2667039128&idx=1&sn=d0caf3b8df75fe7376f7c379eda6128f"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.wechat_mp"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/backup/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.backup.users.get","tags":["wechat_channels"],"summary":"WeChat Channels account profile (backup)","x-capability":{"id":"wechat_channels.backup.users.get","category":"social","role":"social.accounts.get","role_type":"backup","backup_of":"wechat_channels.users.get","stability":"stable","pricing":{"per":"call","price":"0.03","max_charge":"0.03","charge_when_empty":"0","charge_when_not_found":"0.03"},"unavailable":{"username":"platform","url":"platform","verified":"capability","created_at":"capability","metrics":"capability"}},"description":"The backup of wechat_channels.users.get: the same parameters and result, priced on its own. No number of videos.\n\nPrice: $0.03 per call.","parameters":[{"name":"id","in":"query","required":true,"description":"The Channels account's ID, starting with v2_ and ending in @finder. Find it by name with wechat_channels.users.search, or look up one of its videos with wechat_channels.videos.get (by share link or a search result's export_id): the author.id returned is it. The sph… ID the app shows is not it","schema":{"type":"string"},"example":"v2_060000231003b20faec8c5e5811dc3ddce02ec30b0772029a703e1b9f446ba147658bbcfab81@finder"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/backup/users/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.backup.users.videos.list","tags":["wechat_channels"],"summary":"WeChat Channels account videos (backup)","x-capability":{"id":"wechat_channels.backup.users.videos.list","category":"social","role":"social.accounts.posts.list","role_type":"backup","backup_of":"wechat_channels.users.videos.list","stability":"stable","pricing":{"per":"call","price":"0.06","max_charge":"0.06","charge_when_empty":"0.06","charge_when_not_found":"0.06"},"page":{"typical":15,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","title":"platform","lang":"capability","author.username":"platform","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"The backup of wechat_channels.users.videos.list: the same parameters and result, priced on its own.\n\nPrice: $0.06 per call.\n\n15 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"The Channels account's ID, starting with v2_ and ending in @finder. Find it by name with wechat_channels.users.search, or look up one of its videos with wechat_channels.videos.get (by share link or a search result's export_id): the author.id returned is it. The sph… ID the app shows is not it","schema":{"type":"string"},"example":"v2_060000231003b20faec8c5e5811dc3ddce02ec30b0772029a703e1b9f446ba147658bbcfab81@finder"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat/backup/posts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat.backup.posts.search","tags":["wechat"],"summary":"WeChat Search articles and videos (backup)","x-capability":{"id":"wechat.backup.posts.search","category":"social","role":"social.posts.search","role_type":"backup","backup_of":"wechat.posts.search","stability":"stable","pricing":{"per":"call","price":"0.1","max_charge":"0.1","charge_when_empty":"0.1"},"page":{"typical":20,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.id":"capability","author.username":"capability","author.verified":"capability","author.followers":"capability","metrics.comments":"capability","metrics.shares":"capability","metrics.views":"capability","metrics.reposts":"capability","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","metrics.favorites":"capability"}},"description":"The backup of wechat.posts.search: the same parameters and result, priced on its own. Videos come without saves.\n\nPrice: $0.1 per call.\n\n20 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"咖啡店开业"},{"name":"sort","in":"query","description":"By relevance, by time published (newest first) or by how hot","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"relevance"},{"name":"published_within","in":"query","description":"Only those published in the last day, week or half year","schema":{"type":"string","enum":["day","week","half_year"]},"example":"week"},{"name":"type","in":"query","description":"Official Account articles only (article) or Channels videos only (video); both mixed when left out","schema":{"type":"string","enum":["article","video"]},"example":"article"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.wechat"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat/accounts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat.accounts.search","tags":["wechat"],"summary":"WeChat Official Account live search","x-capability":{"id":"wechat.accounts.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":8,"max":14,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","created_at":"capability","metrics":"capability"}},"description":"Find WeChat Official Accounts and service accounts for search terms through WeChat Search, closest first, possibly followed by less related ones: original ID, WeChat ID, name, bio, avatar, whether verified, owner, number of original articles. Charged per call; no followers or reads, for estimates of those use wechat_mp.accounts.search.\n\nPrice: $0.02 per call.\n\n8 items on a usual page, 14 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"The account's name, or a keyword","schema":{"type":"string"},"example":"36氪"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.wechat"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/backup/videos/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.backup.videos.search","tags":["wechat_channels"],"summary":"WeChat Channels video search (backup)","x-capability":{"id":"wechat_channels.backup.videos.search","category":"social","role":"social.posts.search","role_type":"backup","backup_of":"wechat_channels.videos.search","stability":"stable","pricing":{"per":"call","price":"0.1","max_charge":"0.1","charge_when_empty":"0.1"},"page":{"typical":10,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","title":"platform","lang":"capability","author.id":"capability","author.username":"platform","author.verified":"capability","author.followers":"capability","metrics.comments":"capability","metrics.shares":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","metrics.favorites":"capability"}},"description":"The backup of wechat_channels.videos.search: the same parameters and result, priced on its own. No saves.\n\nPrice: $0.1 per call.\n\n10 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"露营装备推荐"},{"name":"sort","in":"query","description":"By relevance, by time published (newest first) or by how hot","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"latest"},{"name":"published_within","in":"query","description":"Only those published in the last day, week or half year","schema":{"type":"string","enum":["day","week","half_year"]},"example":"week"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_mp/accounts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_mp.accounts.search","tags":["wechat_mp"],"summary":"WeChat Official Account name search","x-capability":{"id":"wechat_mp.accounts.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"item","price":"0.05635","minimum":"0.06","max_charge":"0.84525","charge_when_empty":"0"},"page":{"typical":5,"max":15,"limit":true},"unavailable":{"url":"platform","bio":"capability","verified":"capability","created_at":"capability","metrics":"platform"}},"description":"Find WeChat Official Accounts by name or keyword, closest first: original ID, WeChat ID, name, avatar, owner, and a third-party database's estimates of active followers, lead-article reads and likes, and articles a week (not official, possibly months old). Charged per account; limit sets how many (5 by default, at most 15). Needing the ID and not the estimates, wechat.accounts.search, charged per call, costs less.\n\nPrice: $0.05635 per item returned, at least $0.06 and at most $0.84525 per call.\n\n5 items on a usual page, 15 at most. Given whole: there is no next page.","parameters":[{"name":"query","in":"query","required":true,"description":"The account's name, or a keyword","schema":{"type":"string"},"example":"咖啡"},{"name":"limit","in":"query","description":"Items per page","schema":{"type":"integer","minimum":1,"maximum":15}},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.wechat_mp"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_mp/accounts/owner/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_mp.accounts.owner.get","tags":["wechat_mp"],"summary":"WeChat Official Account owner","x-capability":{"id":"wechat_mp.accounts.owner.get","category":"social","stability":"preview","pricing":{"per":"call","price":"0.1","max_charge":"0.1","charge_when_empty":"0","charge_when_not_found":"0.1"}},"description":"Get who a WeChat Official Account is registered to, by its original ID: the owner's name, type, registration number, country, verification status, kind and date, and the account's registration date and authorised third-party services.\n\nPrice: $0.1 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"The account's original ID, starting with gh_; not knowing it, search the name with wechat_mp.accounts.search and take id","schema":{"type":"string"},"example":"gh_3707d9541c3f"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account_owner.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat/index/keywords/history":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat.index.keywords.history","tags":["wechat"],"summary":"WeChat Index","x-capability":{"id":"wechat.index.keywords.history","category":"social","stability":"preview","pricing":{"per":"call","price":"0.1","max_charge":"0.1","charge_when_empty":"0.1"},"page":{"typical":1,"max":1},"unavailable":{"points.search_index":"platform","points.notes":"platform","points.impressions":"platform","points.views":"platform","points.engagements":"platform"}},"description":"Get a keyword's WeChat Index over the last 30 days, one figure a day. The WeChat Index is WeChat's score of attention across its search, articles, Moments and more, not a count of searches, and is not comparable with Douyin's or Xiaohongshu's; days are calendar days in China time (UTC+8).\n\nPrice: $0.1 per call.\n\n1 items on a usual page, 1 at most. Given whole: there is no next page.\n\nA keyword the WeChat Index does not cover returns an empty result, never a not-found error.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"keyword","in":"query","required":true,"description":"One keyword","schema":{"type":"string"},"example":"咖啡"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/keyword_history.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat/keywords/related":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat.keywords.related","tags":["wechat"],"summary":"WeChat Search suggestions","x-capability":{"id":"wechat.keywords.related","category":"social","stability":"preview","pricing":{"per":"call","price":"0.1","max_charge":"0.1","charge_when_empty":"0.1"},"page":{"typical":9,"max":20},"unavailable":{"relevance":"platform","search_index":"platform","composite_index":"platform"}},"description":"Get the suggestions WeChat Search lists in its search box for a keyword, in the order it lists them, about 10 at a time. The words and their places only, with no index.\n\nPrice: $0.1 per call.\n\n9 items on a usual page, 20 at most. Given whole: there is no next page.\n\nA keyword WeChat Search has no suggestions for returns an empty result, never a not-found error.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"keyword","in":"query","required":true,"description":"One keyword","schema":{"type":"string"},"example":"咖啡"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/keyword_related.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat/miniprograms/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat.miniprograms.search","tags":["wechat"],"summary":"WeChat mini program search","x-capability":{"id":"wechat.miniprograms.search","category":"social","stability":"preview","pricing":{"per":"call","price":"0.1","max_charge":"0.1","charge_when_empty":"0.1"},"page":{"typical":25,"max":40}},"description":"Find WeChat mini programs for search terms through WeChat Search, the first page (about 25): name, description, icon, original ID and AppID, the owner's name and whether it is verified, how many used it lately as the platform shows it, and whether it is a mini game.\n\nPrice: $0.1 per call.\n\n25 items on a usual page, 40 at most. Given whole: there is no next page.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"外卖"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/miniprogram.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/users/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.users.search","tags":["wechat_channels"],"summary":"WeChat Channels account search","x-capability":{"id":"wechat_channels.users.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.06","max_charge":"0.06","charge_when_empty":"0"},"page":{"typical":1,"max":20},"unavailable":{"username":"platform","url":"platform","created_at":"capability","metrics":"capability"}},"description":"Find WeChat Channels accounts by name: the name has to match exactly, and every account of that name is returned, with its ID, name, signature, avatar, whether it is verified and what the verification says. The ID can be passed to the Channels profile, video list, live replay and other endpoints.\n\nPrice: $0.06 per call.\n\n1 items on a usual page, 20 at most. Given whole: there is no next page.","parameters":[{"name":"query","in":"query","required":true,"description":"The Channels account's name, exactly","schema":{"type":"string"},"example":"央视新闻"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/videos/metrics":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.videos.metrics","tags":["wechat_channels"],"summary":"WeChat Channels video stats","x-capability":{"id":"wechat_channels.videos.metrics","category":"social","role":"social.posts.metrics","stability":"stable","pricing":{"per":"call","price":"0.015","max_charge":"0.015","charge_when_empty":"0","charge_when_not_found":"0.015"},"unavailable":{"url":"platform","title":"platform","lang":"capability","published_at":"capability","author.username":"platform","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get the latest counts of a WeChat Channels video by its ID: likes, comments, shares, saves, with its description and account. They are not read at the moment of the call and may be a few hours old; the answer says when they were taken. Cheaper than the whole video.\n\nPrice: $0.015 per call.","parameters":[{"name":"id","in":"query","required":true,"description":"The video's ID, a string of digits: the id a video list or a video gives","schema":{"type":"string"},"example":"14940144898316503592"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.comments.replies.list","tags":["wechat_channels"],"summary":"WeChat Channels comment replies","x-capability":{"id":"wechat_channels.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.015","max_charge":"0.015","charge_when_empty":"0.015","charge_when_not_found":"0.015"},"page":{"typical":10,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","author.username":"platform","metrics.comments":"capability"}},"description":"Get a page of the replies under a comment on a WeChat Channels video, by the comment's and the video's IDs: text, replier, likes, time posted, IP location, which reply each answers. About 10 a page, with further pages.\n\nPrice: $0.015 per call.\n\n10 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA comment that does not exist cannot be told from one with no replies: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"The comment's ID, a string of digits: the id a Channels video's comments give","schema":{"type":"string"},"example":"14462557903411284138"},{"name":"post_id","in":"query","required":true,"description":"ID of the video the comment is on, a string of digits","schema":{"type":"string"},"example":"14462543356698040491"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/wechat_channels/users/live_replays/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"wechat_channels.users.live_replays.list","tags":["wechat_channels"],"summary":"WeChat Channels live replays","x-capability":{"id":"wechat_channels.users.live_replays.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02","charge_when_not_found":"0.02"},"page":{"typical":10,"max":50},"unavailable":{"url":"platform","title":"platform","lang":"capability","author.username":"platform","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get the replays of a WeChat Channels account's live streams by the account's ID, newest first, the first page only (up to 48 seen on one): title, time, length, cover, and the replay video's likes, comments, forwards and saves (the counts of the replay as a video, not the stream's viewers or the likes in its room).\n\nPrice: $0.02 per call.\n\n10 items on a usual page, 50 at most. Given whole: there is no next page.\n\nAn account that does not exist cannot be told from one with no live replays: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"The Channels account's ID, starting with v2_ and ending in @finder; not knowing it, look the name up with wechat_channels.users.search. The sph… ID the app shows is not it","schema":{"type":"string"},"example":"v2_060000231003b20faec8c5e5811dc3ddce02ec30b0772029a703e1b9f446ba147658bbcfab81@finder"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.wechat_channels"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/posts/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.posts.comments.list","tags":["reddit"],"summary":"Reddit post comments","x-capability":{"id":"reddit.posts.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":8,"max":200,"cursor_ttl_seconds":3600},"unavailable":{"metrics.likes":"platform","author.name":"platform"}},"description":"Get a page of comments on a Reddit post by ID or link: text, commenter, score, reply count, time posted, with the first levels of replies.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.reddit.com/r/nasa/comments/1nnrvkr/); share_text (Look at this https://www.reddit.com/r/nasa/comments/1nnrvkr/ via the app).\n\n8 items on a usual page, 200 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","description":"Post ID, with its t3_ prefix","schema":{"type":"string"},"example":"t3_1nnrvkr"},{"name":"url","in":"query","description":"Link to the post, pasted as it is: the https://www.reddit.com/r/<community>/comments/… web link (phone or old site too), a redd.it short link, or the /r/<community>/s/… link the app shares. A share link is opened once to see which post it leads to","schema":{"type":"string"},"example":"https://www.reddit.com/r/nasa/comments/1nnrvkr/"},{"name":"sort","in":"query","description":"Reddit's default order (best), newest first, or top score first","schema":{"type":"string","enum":["best","latest","popular"],"default":"best"},"example":"best"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.reddit"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/posts/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.posts.get","tags":["reddit"],"summary":"Reddit post detail","x-capability":{"id":"reddit.posts.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"metrics.likes":"platform","metrics.favorites":"platform","metrics.views":"capability","metrics.reposts":"platform","author.name":"platform","author.verified":"capability","author.followers":"capability","hashtags":"platform","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Reddit post by ID or link: title, text, author, community, score, comment count.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.reddit.com/r/nasa/comments/1nnrvkr/); share_text (Look at this https://www.reddit.com/r/nasa/comments/1nnrvkr/ via the app).","parameters":[{"name":"id","in":"query","description":"Post ID, with its t3_ prefix","schema":{"type":"string"},"example":"t3_1nnrvkr"},{"name":"url","in":"query","description":"Link to the post, pasted as it is: the https://www.reddit.com/r/<community>/comments/… web link (phone or old site too), a redd.it short link, or the /r/<community>/s/… link the app shares. A share link is opened once to see which post it leads to","schema":{"type":"string"},"example":"https://www.reddit.com/r/nasa/comments/1nnrvkr/"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.reddit"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/posts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.posts.search","tags":["reddit"],"summary":"Reddit post search","x-capability":{"id":"reddit.posts.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":7,"max":25,"cursor_ttl_seconds":3600},"unavailable":{"metrics.likes":"platform","metrics.favorites":"platform","metrics.views":"capability","metrics.reposts":"platform","author.name":"platform","author.verified":"capability","author.followers":"capability","hashtags":"platform","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","metrics.shares":"capability"}},"description":"Get a page of Reddit posts matching a search, by relevance, newest or top score, optionally within a period.\n\nPrice: $0.002 per call.\n\n7 items on a usual page, 25 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"saturn rings"},{"name":"sort","in":"query","description":"By relevance, newest first, or top score first","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"relevance"},{"name":"published_within","in":"query","description":"Published within the last period","schema":{"type":"string","enum":["day","week","month","year"]},"example":"month"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.reddit"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/posts/trending":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.posts.trending","tags":["reddit"],"summary":"Reddit popular posts","x-capability":{"id":"reddit.posts.trending","category":"social","role":"social.posts.trending","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":7,"max":25,"cursor_ttl_seconds":3600},"unavailable":{"metrics.likes":"platform","metrics.favorites":"platform","metrics.views":"capability","metrics.reposts":"platform","author.name":"platform","author.verified":"capability","author.followers":"capability","hashtags":"platform","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the posts on Reddit's Popular feed: title, text, author, community, score, comment count.\n\nPrice: $0.002 per call.\n\n7 items on a usual page, 25 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"board","in":"query","description":"Which feed: Popular","schema":{"type":"string","enum":["popular"],"default":"popular"},"example":"popular"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.reddit"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/subreddits/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.subreddits.posts.list","tags":["reddit"],"summary":"Reddit community posts","x-capability":{"id":"reddit.subreddits.posts.list","category":"social","role":"social.communities.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":25,"max":25,"cursor_ttl_seconds":3600},"unavailable":{"metrics.likes":"platform","metrics.favorites":"platform","metrics.views":"capability","metrics.reposts":"platform","author.name":"platform","author.verified":"capability","author.followers":"capability","hashtags":"platform","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","type":"capability","lang":"capability","author.avatar_url":"capability","metrics.shares":"capability","images":"capability","is_pinned":"capability"}},"description":"Get a page of the posts of a Reddit community by its name, hot, newest or top score first. Top score is of the last day unless window asks for the last week, month or year, or all time.\n\nPrice: $0.002 per call.\n\nNot taken together: sort=hot and window.\n\nNot taken together: sort=latest and window.\n\n25 items on a usual page, 25 at most. A cursor is valid for 3600 seconds.\n\nA community that does not exist cannot be told from a community without posts: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"Community name, without the r/","schema":{"type":"string"},"example":"nasa"},{"name":"sort","in":"query","description":"Hot, newest first, or top score first; top score ranks the posts of the last day unless window asks for another period","schema":{"type":"string","enum":["hot","latest","popular"],"default":"hot"},"example":"hot"},{"name":"window","in":"query","description":"Which period top score first (sort=popular) ranks the posts of: the last 24 hours, 7, 30 or 365 days, or all time; the last 24 hours when left out. Only with sort=popular","schema":{"type":"string","enum":["24h","7d","30d","365d","all"]},"example":"all"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.reddit"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.trends.list","tags":["reddit"],"summary":"Reddit trending searches","x-capability":{"id":"reddit.trends.list","category":"social","role":"social.trends.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":6,"max":20},"unavailable":{"id":"platform","heat":"platform"}},"description":"Get the searches trending on Reddit today, ranked in the order the platform lists them.\n\nPrice: $0.002 per call.\n\n6 items on a usual page, 20 at most. Given whole: there is no next page.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which list: trending searches","schema":{"type":"string","enum":["searches"],"default":"searches"},"example":"searches"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.users.get","tags":["reddit"],"summary":"Reddit user profile","x-capability":{"id":"reddit.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"metrics.followers":"capability","metrics.following":"platform"}},"description":"Get a Reddit user's public profile by username: display name, bio, when it was created, karma, post and comment counts.\n\nPrice: $0.002 per call.","parameters":[{"name":"username","in":"query","required":true,"description":"Reddit username, without the u/","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.reddit"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/users/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.users.posts.list","tags":["reddit"],"summary":"Reddit user posts","x-capability":{"id":"reddit.users.posts.list","category":"social","role":"social.accounts.posts.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":25,"max":25,"cursor_ttl_seconds":3600},"unavailable":{"metrics.likes":"platform","metrics.favorites":"platform","metrics.views":"capability","metrics.reposts":"platform","author.name":"platform","author.verified":"capability","author.followers":"capability","hashtags":"platform","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the posts a Reddit user has made, newest first.\n\nPrice: $0.002 per call.\n\n25 items on a usual page, 25 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"username","in":"query","required":true,"description":"Reddit username, without the u/","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.reddit"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/answers/comments/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.answers.comments.list","tags":["zhihu"],"summary":"Zhihu answer comments","x-capability":{"id":"zhihu.answers.comments.list","category":"social","role":"social.posts.comments.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":10,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","post_id":"capability"}},"description":"Get a page of comments on a Zhihu answer: text, commenter, likes, reply count, time posted, IP location.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nAn answer that does not exist cannot be told from an answer without comments: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"Answer ID, a string of digits","schema":{"type":"string"},"example":"2509154330"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.zhihu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/answers/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.answers.get","tags":["zhihu"],"summary":"Zhihu answer detail","x-capability":{"id":"zhihu.answers.get","category":"social","role":"social.posts.get","role_type":"answer","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"lang":"capability","author.verified":"capability","metrics.shares":"platform","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"platform","mentions":"capability","is_pinned":"capability","root_id":"platform","author.followers":"capability","metrics":"capability"}},"description":"Get one Zhihu answer by ID or link: its question, text, author, time posted.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.zhihu.com/answer/2430879961).","parameters":[{"name":"id","in":"query","description":"Answer ID, a string of digits","schema":{"type":"string"},"example":"2430879961"},{"name":"url","in":"query","description":"Web link to the answer","schema":{"type":"string"},"example":"https://www.zhihu.com/answer/2430879961"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/articles/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.articles.get","tags":["zhihu"],"summary":"Zhihu article detail","x-capability":{"id":"zhihu.articles.get","category":"social","role":"social.posts.get","role_type":"article","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"lang":"capability","author.verified":"capability","author.followers":"capability","metrics.shares":"platform","metrics.views":"capability","metrics.reposts":"platform","images":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Zhihu column article by ID or link: title, text, author, upvotes, comment count, topics.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://zhuanlan.zhihu.com/p/431119887).","parameters":[{"name":"id","in":"query","description":"Article ID, a string of digits","schema":{"type":"string"},"example":"521711978"},{"name":"url","in":"query","description":"Web link to the article","schema":{"type":"string"},"example":"https://zhuanlan.zhihu.com/p/431119887"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/columns/articles/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.columns.articles.list","tags":["zhihu"],"summary":"Zhihu column articles","x-capability":{"id":"zhihu.columns.articles.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.verified":"capability","author.followers":"capability","metrics.shares":"platform","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","metrics.favorites":"capability"}},"description":"Get a page of the articles in a Zhihu column by the column's ID: title, text, author, time published, upvotes, comment count.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"Column ID: the last part of the column's address, the word after zhuanlan.zhihu.com/ or the one that starts with c_","schema":{"type":"string"},"example":"intelligentunit"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/comments/replies/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.comments.replies.list","tags":["zhihu"],"summary":"Zhihu comment replies","x-capability":{"id":"zhihu.comments.replies.list","category":"social","role":"social.comments.replies.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"platform","post_id":"capability"}},"description":"Get a page of the replies under a top-level Zhihu comment: text, replier, likes, which comment each answers. Each reply also gives its IP location.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"id","in":"query","required":true,"description":"ID of the top-level comment, a string of digits","schema":{"type":"string"},"example":"10114474814"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/comment.items.zhihu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/pins/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.pins.get","tags":["zhihu"],"summary":"Zhihu pin detail","x-capability":{"id":"zhihu.pins.get","category":"social","role":"social.posts.get","role_type":"pin","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"title":"platform","lang":"capability","author.verified":"capability","author.followers":"capability","metrics.shares":"platform","metrics.views":"capability","hashtags":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Zhihu pin (short post) by ID or link: text, pictures, author, time posted, likes, comments, saves, reposts.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.zhihu.com/pin/2042267446984402904).","parameters":[{"name":"id","in":"query","description":"Pin ID, a string of digits","schema":{"type":"string"},"example":"2042267446984402904"},{"name":"url","in":"query","description":"Web link to the pin","schema":{"type":"string"},"example":"https://www.zhihu.com/pin/2042267446984402904"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/posts/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.posts.search","tags":["zhihu"],"summary":"Zhihu content search","x-capability":{"id":"zhihu.posts.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":18,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.verified":"capability","metrics.shares":"platform","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","root_id":"platform"}},"description":"Get a page of Zhihu answers and articles matching a search; either kind alone, by relevance, newest or most upvoted.\n\nPrice: $0.002 per call.\n\n18 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"咖啡机推荐"},{"name":"type","in":"query","description":"Answers only, or articles only; both when left out","schema":{"type":"string","enum":["answer","article"]},"example":"answer"},{"name":"sort","in":"query","description":"By relevance, newest first, or most upvoted first","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"relevance"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/questions/answers/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.questions.answers.list","tags":["zhihu"],"summary":"Zhihu question answers","x-capability":{"id":"zhihu.questions.answers.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20},"unavailable":{"lang":"capability","author.verified":"capability","metrics.shares":"platform","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"platform","mentions":"capability","is_pinned":"capability","root_id":"platform"}},"description":"Get the first 20 answers to a Zhihu question by ID or link, in Zhihu's own order: text, author, upvotes, comment and save counts. One page only.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://zhihu.com/question/55043447).\n\n20 items on a usual page, 20 at most. Given whole: there is no next page.","parameters":[{"name":"id","in":"query","description":"Question ID, a string of digits","schema":{"type":"string"},"example":"55043447"},{"name":"url","in":"query","description":"Web link to the question","schema":{"type":"string"},"example":"https://zhihu.com/question/55043447"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/questions/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.questions.get","tags":["zhihu"],"summary":"Zhihu question detail","x-capability":{"id":"zhihu.questions.get","category":"social","role":"social.posts.get","role_type":"question","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"lang":"capability","author":"platform","metrics.likes":"platform","metrics.shares":"platform","metrics.favorites":"platform","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"platform","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Zhihu question by ID or link: title, details, when it was asked, answer, follower and view counts.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://zhihu.com/question/55043447).","parameters":[{"name":"id","in":"query","description":"Question ID, a string of digits","schema":{"type":"string"},"example":"55043447"},{"name":"url","in":"query","description":"Web link to the question","schema":{"type":"string"},"example":"https://zhihu.com/question/55043447"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.zhihu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.trends.list","tags":["zhihu"],"summary":"Zhihu hot list","x-capability":{"id":"zhihu.trends.list","category":"social","role":"social.trends.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":30,"max":50}},"description":"Get Zhihu's hot list: the questions on it, their rank, heat (approximate), answer and follower counts, when each was asked, its summary and picture; an entry's ID is its question's.\n\nPrice: $0.002 per call.\n\n30 items on a usual page, 50 at most. Given whole: there is no next page.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which list: the hot list","schema":{"type":"string","enum":["hot"],"default":"hot"},"example":"hot"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items.zhihu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/users/answers/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.users.answers.list","tags":["zhihu"],"summary":"Zhihu user answers","x-capability":{"id":"zhihu.users.answers.list","category":"social","role":"social.accounts.posts.list","role_type":"answer","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":40,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.verified":"capability","metrics.shares":"platform","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"platform","mentions":"capability","is_pinned":"capability","root_id":"platform","author.followers":"capability","metrics.favorites":"capability"}},"description":"Get a page of the answers a Zhihu user has written, newest first.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 40 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"username","in":"query","required":true,"description":"The handle in the profile's address (url_token)","schema":{"type":"string"},"example":"zhihuadmin"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/users/articles/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.users.articles.list","tags":["zhihu"],"summary":"Zhihu user articles","x-capability":{"id":"zhihu.users.articles.list","category":"social","role":"social.accounts.posts.list","role_type":"article","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.verified":"capability","author.followers":"capability","metrics.shares":"platform","metrics.views":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","metrics.favorites":"capability"}},"description":"Get a page of the column articles a Zhihu user has written, newest first.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"username","in":"query","required":true,"description":"The handle in the profile's address (url_token)","schema":{"type":"string"},"example":"zhihuadmin"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/users/followers/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.users.followers.list","tags":["zhihu"],"summary":"Zhihu user followers","x-capability":{"id":"zhihu.users.followers.list","category":"social","role":"social.accounts.followers.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"verified":"capability","created_at":"platform","metrics.following":"capability","metrics.posts":"capability"}},"description":"Get a page of the accounts following a Zhihu user, 20 a page: name, headline, avatar, whether an organisation, follower count, answer and article counts.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"username","in":"query","required":true,"description":"The handle in the profile's address (url_token)","schema":{"type":"string"},"example":"zhihuadmin"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.zhihu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/users/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.users.get","tags":["zhihu"],"summary":"Zhihu user profile","x-capability":{"id":"zhihu.users.get","category":"social","role":"social.accounts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"created_at":"platform","metrics.following":"capability","metrics.posts":"capability"}},"description":"Get a Zhihu user's profile by the handle in its address: name, headline, follower count, answer and article counts. It also says whether the user is verified or an organisation, and the IP location.\n\nPrice: $0.002 per call.","parameters":[{"name":"username","in":"query","required":true,"description":"The handle in the profile's address (url_token), such as zhihuadmin","schema":{"type":"string"},"example":"zhihuadmin"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.item.zhihu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/users/pins/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.users.pins.list","tags":["zhihu"],"summary":"Zhihu user pins","x-capability":{"id":"zhihu.users.pins.list","category":"social","role":"social.accounts.posts.list","role_type":"pin","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","author.verified":"capability","author.followers":"capability","metrics.shares":"platform","metrics.views":"capability","hashtags":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the pins (short posts) a Zhihu user has posted, newest first: text, pictures, time posted, likes, comments, saves, reposts.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"username","in":"query","required":true,"description":"The handle in the profile's address (url_token)","schema":{"type":"string"},"example":"zhihuadmin"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/zhihu/users/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"zhihu.users.search","tags":["zhihu"],"summary":"Zhihu user search","x-capability":{"id":"zhihu.users.search","category":"social","role":"social.accounts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"bio":"capability","created_at":"platform","metrics.following":"capability","metrics.posts":"capability"}},"description":"Get a page of Zhihu users matching a search: name, follower count, answer and article counts. Each also says whether verified, whether an organisation, upvotes received and when they last posted. The headline is in the profile.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"人民日报"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.zhihu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/subreddits/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.subreddits.get","tags":["reddit"],"summary":"Reddit community profile","x-capability":{"id":"reddit.subreddits.get","category":"social","role":"social.communities.get","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get a Reddit community by its name: description, members, users active and contributions made in the last week, when it was created.\n\nPrice: $0.002 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Community name, without the r/","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/community.item.reddit"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/users/subreddits/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.users.subreddits.list","tags":["reddit"],"summary":"Reddit user active communities","x-capability":{"id":"reddit.users.subreddits.list","category":"social","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002","charge_when_not_found":"0.002"},"page":{"typical":40,"max":500},"unavailable":{"description":"capability","created_at":"capability"}},"description":"Get the communities a Reddit user is active in by username: each one's name, members and icon, all in one page (215 of them were recorded for one account).\n\nPrice: $0.002 per call.\n\n40 items on a usual page, 500 at most. Given whole: there is no next page.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"username","in":"query","required":true,"description":"Reddit username, without the u/","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/community.items.reddit"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/communities/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.communities.get","tags":["x"],"summary":"X community profile","x-capability":{"id":"x.communities.get","category":"social","role":"social.communities.get","stability":"preview","pricing":{"per":"call","price":"0.0004","max_charge":"0.0004","charge_when_empty":"0"},"unavailable":{"avatar_url":"platform"}},"description":"Get an X community by its ID: name, description, members, moderators, how people join, when it was created.\n\nPrice: $0.0004 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Community ID, a string of digits","schema":{"type":"string"},"example":"1493446837214187523"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/community.item.x"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/shop/products/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.shop.products.get","tags":["tiktok"],"summary":"TikTok Shop product detail","x-capability":{"id":"tiktok.shop.products.get","category":"commerce","role":"commerce.products.get","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"},"unavailable":{"price":"capability","original_price":"capability"}},"description":"Get a TikTok Shop product in the United States by its ID: title, description, pictures, rating, reviews, units sold, the shop with its rating, followers and products on sale, and the price and shipping fee its page shows. The page's price runs about a shipping fee above the price in the shop's list and the search, which the product search gives.\n\nPrice: $0.002 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Product ID, a string of digits (the last segment of the product's link)","schema":{"type":"string"},"example":"1732488007561286228"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/product.item.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/shop/products/reviews/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.shop.products.reviews.list","tags":["tiktok"],"summary":"TikTok Shop product reviews","x-capability":{"id":"tiktok.shop.products.reviews.list","category":"commerce","role":"commerce.products.reviews.list","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":10}},"description":"Get the first 10 buyers' reviews of a TikTok Shop product in the United States by the product's ID: text, rating, time, variant bought, pictures.\n\nPrice: $0.002 per call.\n\n10 items on a usual page, 10 at most. Given whole: there is no next page.\n\nA product that does not exist cannot be told from a product without reviews: both return an empty result, not a 404.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Product ID, a string of digits (the last segment of the product's link)","schema":{"type":"string"},"example":"1732488007561286228"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/review.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/shop/products/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.shop.products.search","tags":["tiktok"],"summary":"TikTok Shop product search","x-capability":{"id":"tiktok.shop.products.search","category":"commerce","role":"commerce.products.search","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":48,"max":60},"unavailable":{"description":"capability","metrics.reviews":"capability"}},"description":"Search the products of TikTok Shop in the United States by terms: title, current and original price, rating, units sold, shop.\n\nPrice: $0.002 per call.\n\n48 items on a usual page, 60 at most. Given whole: there is no next page.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"yoga mat"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/product.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/shop/sellers/products/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.shop.sellers.products.list","tags":["tiktok"],"summary":"TikTok Shop seller products","x-capability":{"id":"tiktok.shop.sellers.products.list","category":"commerce","role":"commerce.shops.products.list","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"description":"capability"}},"description":"Get a page of the products a TikTok Shop seller in the United States has on sale by the seller's ID: title, current and original price, rating, reviews, units sold.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Seller ID, a string of digits (the last segment of the shop's link)","schema":{"type":"string"},"example":"8651645720603103776"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/product.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/shop/products/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.shop.products.get","tags":["xiaohongshu"],"summary":"Xiaohongshu product detail","x-capability":{"id":"xiaohongshu.shop.products.get","category":"commerce","role":"commerce.products.get","stability":"preview","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0","charge_when_not_found":"0.02"},"unavailable":{"url":"capability"}},"description":"Get a product of Xiaohongshu's shop by its ID: title, current and original price in yuan, pictures, rating, reviews, shop. What is seen is the product's page in the app's version for a region abroad (the region may differ from one call to the next): promotions and whether it can be bought may not be what a user in China sees.\n\nPrice: $0.02 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Product ID, 24 hexadecimal characters","schema":{"type":"string"},"example":"67bc0378a2e72600153d3ed1"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/product.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/shop/products/reviews/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.shop.products.reviews.list","tags":["xiaohongshu"],"summary":"Xiaohongshu product reviews","x-capability":{"id":"xiaohongshu.shop.products.reviews.list","category":"commerce","role":"commerce.products.reviews.list","stability":"preview","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":12,"max":20},"unavailable":{"product_id":"capability","published_at":"capability"}},"description":"Get the first page of buyers' reviews of a product of Xiaohongshu's shop by the product's ID: text, rating, variant bought, pictures, likes.\n\nPrice: $0.02 per call.\n\n12 items on a usual page, 20 at most. Given whole: there is no next page.\n\nA product that does not exist cannot be told from a product without reviews: both return an empty result, not a 404.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Product ID, 24 hexadecimal characters","schema":{"type":"string"},"example":"67bc0378a2e72600153d3ed1"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/review.items.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/shop/products/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.shop.products.search","tags":["xiaohongshu"],"summary":"Xiaohongshu product search","x-capability":{"id":"xiaohongshu.shop.products.search","category":"commerce","role":"commerce.products.search","stability":"preview","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"url":"capability","description":"capability","rating":"capability","metrics.reviews":"capability"}},"description":"Search the products of Xiaohongshu's shop by terms: title, current and original price in yuan, units sold, picture, shop. What is seen is the shop of the app's version for a region abroad (the region may differ from one call to the next): promotions and whether an item can be bought may not be what a user in China sees.\n\nPrice: $0.02 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"防晒霜"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/product.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/communities/members/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.communities.members.list","tags":["x"],"summary":"X community members","x-capability":{"id":"x.communities.members.list","category":"social","stability":"stable","pricing":{"per":"item","price":"0.0004","minimum":"0.0004","max_charge":"0.008","charge_when_empty":"0.0004","charge_when_not_found":"0.0004"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600}},"description":"Get a page of the accounts that have joined an X community, by the community's ID, about 20 a page: handle, name, bio, follower count, verification.\n\nPrice: $0.0004 per item returned, at least $0.0004 and at most $0.008 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA community that does not exist cannot be told from a community without members: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"Community ID, a string of digits","schema":{"type":"string"},"example":"1539231166569410560"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/lists/followers/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.lists.followers.list","tags":["x"],"summary":"X list followers","x-capability":{"id":"x.lists.followers.list","category":"social","stability":"stable","pricing":{"per":"item","price":"0.0004","minimum":"0.0004","max_charge":"0.008","charge_when_empty":"0.0004","charge_when_not_found":"0.0004"},"page":{"typical":20,"max":20}},"description":"Get accounts that follow an X list, by the list's ID, up to 20: handle, name, bio, follower count, verification. This page only, with no further page.\n\nPrice: $0.0004 per item returned, at least $0.0004 and at most $0.008 per call.\n\n20 items on a usual page, 20 at most. Given whole: there is no next page.\n\nA list that does not exist cannot be told from a list nobody follows: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"List ID, a string of digits","schema":{"type":"string"},"example":"84839422"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/lists/members/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.lists.members.list","tags":["x"],"summary":"X list members","x-capability":{"id":"x.lists.members.list","category":"social","stability":"stable","pricing":{"per":"item","price":"0.0004","minimum":"0.0004","max_charge":"0.008","charge_when_empty":"0.0004","charge_when_not_found":"0.0004"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600}},"description":"Get a page of the accounts an X list is made of, by the list's ID, 20 a page: handle, name, bio, follower count, verification.\n\nPrice: $0.0004 per item returned, at least $0.0004 and at most $0.008 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA list that does not exist cannot be told from a list without members: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"List ID, a string of digits","schema":{"type":"string"},"example":"84839422"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/linkedin/posts/transcript/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"linkedin.posts.transcript.get","tags":["linkedin"],"summary":"LinkedIn video transcript","x-capability":{"id":"linkedin.posts.transcript.get","category":"social","role":"social.transcripts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"lang":"capability","segments":"capability"}},"description":"Get what is said in the video of a LinkedIn post by its activity ID or link, as one text. Only where LinkedIn itself publishes a transcript with the video; most videos have none.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.linkedin.com/feed/update/urn:li:activity:7514958241034817537).","parameters":[{"name":"id","in":"query","description":"Post ID (its activity number), a string of digits","schema":{"type":"string"},"example":"7514958241034817537"},{"name":"url","in":"query","description":"Link to the post, written linkedin.com/posts/...-activity-ID-... or linkedin.com/feed/update/urn:li:activity:ID","schema":{"type":"string"},"example":"https://www.linkedin.com/feed/update/urn:li:activity:7514958241034817537"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/transcript.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/reddit/posts/transcript/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"reddit.posts.transcript.get","tags":["reddit"],"summary":"Reddit video transcript","x-capability":{"id":"reddit.posts.transcript.get","category":"social","role":"social.transcripts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"}},"description":"Get what is said in the video of a Reddit post by ID or link: the captions Reddit makes for a video it hosts, as the whole text and timed segments.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.reddit.com/comments/1gea6yx/); share_text (Look at this https://www.reddit.com/comments/1gea6yx/ via the app).","parameters":[{"name":"id","in":"query","description":"Post ID, with its t3_ prefix","schema":{"type":"string"},"example":"t3_1gea6yx"},{"name":"url","in":"query","description":"Link to the post, pasted as it is: the https://www.reddit.com/r/<community>/comments/… web link (phone or old site too), a redd.it short link, or the /r/<community>/s/… link the app shares. A share link is opened once to see which post it leads to","schema":{"type":"string"},"example":"https://www.reddit.com/comments/1gea6yx/"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/transcript.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/x/posts/transcript/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"x.posts.transcript.get","tags":["x"],"summary":"X video transcript","x-capability":{"id":"x.posts.transcript.get","category":"social","role":"social.transcripts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"lang":"capability","segments":"capability"}},"description":"Get what is said in the video of an X post by ID or link, as one text; videos up to two minutes long.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://x.com/i/status/2109760407824961716).","parameters":[{"name":"id","in":"query","description":"Post ID, a string of digits","schema":{"type":"string"},"example":"2109760407824961716"},{"name":"url","in":"query","description":"Link to the post: an x.com or twitter.com link with /status/ in it","schema":{"type":"string"},"example":"https://x.com/i/status/2109760407824961716"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/transcript.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/tiktok/users/followers/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"tiktok.users.followers.list","tags":["tiktok"],"summary":"TikTok user followers","x-capability":{"id":"tiktok.users.followers.list","category":"social","role":"social.accounts.followers.list","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":50,"max":50,"cursor_ttl_seconds":3600},"unavailable":{"verified":"capability"}},"description":"Get a page of the accounts following a TikTok user, by handle, 50 a page, newest followers first: handle, name, bio, follower, following and video counts, likes received, and each account's country or region and language, for where the followers are.\n\nPrice: $0.002 per call.\n\n50 items on a usual page, 50 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"username","in":"query","required":true,"description":"TikTok handle, without the @","schema":{"type":"string"},"example":"nasa"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/account.items.tiktok"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/channels/posts/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.channels.posts.list","tags":["youtube"],"summary":"YouTube channel posts","x-capability":{"id":"youtube.channels.posts.list","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":10,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"title":"platform","lang":"capability","published_at":"capability","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.comments":"capability","metrics.shares":"platform","metrics.favorites":"platform","metrics.views":"platform","metrics.reposts":"platform","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get a page of the posts on a YouTube channel's Posts tab (once Community) by channel ID or handle, newest first: text, pictures, likes, the video a post carries.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, username.\n\n10 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nAsked by channel ID, a channel that does not exist cannot be told from a channel without posts: both return an empty result, not a 404. Asked by handle, a handle nobody has returns a 404 and is not charged.","parameters":[{"name":"id","in":"query","description":"Channel ID, starting with UC","schema":{"type":"string"},"example":"UC_x5XG1OV2P6uZZ5FSM9Ttw"},{"name":"username","in":"query","description":"The channel's handle, without the @","schema":{"type":"string"},"example":"NASA"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.youtube"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/youtube/posts/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"youtube.posts.get","tags":["youtube"],"summary":"YouTube post detail","x-capability":{"id":"youtube.posts.get","category":"social","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"title":"platform","lang":"capability","published_at":"capability","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.comments":"capability","metrics.shares":"platform","metrics.favorites":"platform","metrics.views":"platform","metrics.reposts":"platform","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one YouTube channel post (once a Community post) by ID or link: text, channel, pictures, likes, the video it carries.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.youtube.com/post/UgkxYEgmAc4YqqFhbP9FnxTlU0LxEi2TRKNT).","parameters":[{"name":"id","in":"query","description":"Post ID, starting with Ug","schema":{"type":"string"},"example":"UgkxYEgmAc4YqqFhbP9FnxTlU0LxEi2TRKNT"},{"name":"url","in":"query","description":"Link to the post, written youtube.com/post/ID","schema":{"type":"string"},"example":"https://www.youtube.com/post/UgkxYEgmAc4YqqFhbP9FnxTlU0LxEi2TRKNT"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.youtube"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/pinterest/pins/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"pinterest.pins.get","tags":["pinterest"],"summary":"Pinterest pin detail","x-capability":{"id":"pinterest.pins.get","category":"social","role":"social.posts.get","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0"},"unavailable":{"lang":"capability","metrics.views":"capability","metrics.reposts":"platform","hashtags":"capability","mentions":"capability","is_pinned":"platform","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Pinterest pin by ID or link: title, description, picture, who pinned it and when, reaction, comment and save counts, the page it points to.\n\nPrice: $0.002 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.pinterest.com/pin/4601834496922433600/).","parameters":[{"name":"id","in":"query","description":"Pin ID, a string of digits","schema":{"type":"string"},"example":"4601834496922433600"},{"name":"url","in":"query","description":"Link to the pin, written pinterest.com/pin/ID; pin.it short links are not taken","schema":{"type":"string"},"example":"https://www.pinterest.com/pin/4601834496922433600/"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.pinterest"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/pinterest/pins/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"pinterest.pins.search","tags":["pinterest"],"summary":"Pinterest pin search","x-capability":{"id":"pinterest.pins.search","category":"social","role":"social.posts.search","stability":"stable","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0.002"},"page":{"typical":20,"max":50,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","metrics":"capability","hashtags":"capability","mentions":"capability","is_pinned":"platform","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Find Pinterest pins by search terms: title, description, picture, who pinned it and when, the page it points to. No counts, which the pin capability gives.\n\nPrice: $0.002 per call.\n\n20 items on a usual page, 50 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"mid century living room"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.pinterest"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.search","tags":["douyin"],"summary":"Douyin Xingtu creator search","x-capability":{"id":"douyin.xingtu.creators.search","category":"creator","role":"creator.creators.search","stability":"preview","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0.004"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"account_id":"capability","username":"capability"}},"description":"Search Douyin creators on Xingtu by words in their name, filtered by followers, expected CPM (in yuan) and gender, or ordered by expected CPM, lowest first:Xingtu creator ID, name, location, content categories, followers; in the full view also what an integrated and a custom video cost, expected CPMs (in yuan), expected views, the last 30 days' interaction and completion ratios and median views, the e-commerce level, gender and content labels. The creator ID the other Xingtu endpoints take comes from here.\n\nPrice: $0.004 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms, matched against creators' names","schema":{"type":"string"},"example":"美食"},{"name":"followers_min","in":"query","description":"At least this many followers","schema":{"type":"integer","minimum":1},"example":100000},{"name":"followers_max","in":"query","description":"At most this many followers","schema":{"type":"integer","minimum":1},"example":1000000},{"name":"cpm_min","in":"query","description":"Expected cost per thousand views of an integrated video (ext.cpm_integrated) at least this, in yuan","schema":{"type":"integer","minimum":1},"example":10},{"name":"cpm_max","in":"query","description":"Expected cost per thousand views of an integrated video (ext.cpm_integrated) at most this, in yuan: 50 is no more than 50 yuan a thousand views","schema":{"type":"integer","minimum":1},"example":50},{"name":"gender","in":"query","description":"Only female or only male creators","schema":{"type":"string","enum":["female","male"]},"example":"female"},{"name":"sort","in":"query","description":"Order: relevance, the platform's own ranking (the default); lowest_cpm, by expected CPM, lowest first. The platform orders by the figure in ext.cpm_promoted, so the order may differ from that of ext.cpm_integrated","schema":{"type":"string","enum":["relevance","lowest_cpm"],"default":"relevance"},"example":"lowest_cpm"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/creator.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.get","tags":["douyin"],"summary":"Douyin Xingtu creator profile","x-capability":{"id":"douyin.xingtu.creators.get","category":"creator","role":"creator.creators.get","stability":"preview","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0"},"when":[{"params":["id"],"values":{},"unavailable":{"ext.rate_integrated":"capability","ext.rate_custom":"capability","ext.expected_views":"capability","ext.cpm_integrated":"capability","ext.cpm_custom":"capability"}},{"params":["ids"],"values":{},"unavailable":{"account_id":"capability","username":"capability","ext.agency":"capability","ext.content_labels":"capability"}}]},"description":"Get a Douyin creator's profile on Xingtu by Xingtu creator ID: name, location, content categories, followers, gender; one ID also gives the Douyin account ID, handle, agency and content labels, several IDs (up to 50) give what an integrated and a custom video cost, their expected CPMs (in yuan) and the views expected of a video instead.\n\nPrice: $0.004 per call.\n\nGive exactly one of id, ids.\n\nWith id: without ext.rate_integrated, ext.rate_custom, ext.expected_views, ext.cpm_integrated, ext.cpm_custom.\n\nWith ids: without account_id, username, ext.agency, ext.content_labels.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","description":"Xingtu creator ID, a string of digits; not the Douyin account ID: take it from the Xingtu creator search","schema":{"type":"string"},"example":"6763236383382306828"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/creator.item.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"douyin.xingtu.creators.get.batch","tags":["douyin"],"summary":"Douyin Xingtu creator profile (batch)","x-capability":{"id":"douyin.xingtu.creators.get","category":"creator","role":"creator.creators.get","stability":"preview","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0"},"when":[{"params":["id"],"values":{},"unavailable":{"ext.rate_integrated":"capability","ext.rate_custom":"capability","ext.expected_views":"capability","ext.cpm_integrated":"capability","ext.cpm_custom":"capability"}},{"params":["ids"],"values":{},"unavailable":{"account_id":"capability","username":"capability","ext.agency":"capability","ext.content_labels":"capability"}}]},"description":"Get a Douyin creator's profile on Xingtu by Xingtu creator ID: name, location, content categories, followers, gender; one ID also gives the Douyin account ID, handle, agency and content labels, several IDs (up to 50) give what an integrated and a custom video cost, their expected CPMs (in yuan) and the views expected of a video instead.\n\nPrice: $0.004 per call.\n\nGive exactly one of id, ids.\n\nWith id: without ext.rate_integrated, ext.rate_custom, ext.expected_views, ext.cpm_integrated, ext.cpm_custom.\n\nWith ids: without account_id, username, ext.agency, ext.content_labels.\n\nPreview: the returned object may change, announced beforehand.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":50,"description":"Several Xingtu creator IDs, each a string of digits"},"view":{"type":"string","enum":["compact","standard","full"],"default":"standard","description":"How much of each item to return"},"fields":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Return only these fields"}}},"example":{"ids":["6763236383382306828","6816144920949030920"]}}}},"responses":{"200":{"$ref":"#/components/responses/creator.items.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/audience/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.audience.get","tags":["douyin"],"summary":"Douyin Xingtu creator audience","x-capability":{"id":"douyin.xingtu.creators.audience.get","category":"creator","role":"creator.creators.audience.get","stability":"preview","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0","charge_when_not_found":"0.004"},"unavailable":{"measured_at":"capability"}},"description":"Get who follows a Douyin creator, by Xingtu creator ID: followers and share in each segment by gender, age, province, city, city tier, interest, device, consumer group, purchase category and purchase amount.\n\nPrice: $0.004 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Xingtu creator ID, a string of digits; not the Douyin account ID: take it from the Xingtu creator search","schema":{"type":"string"},"example":"6763236383382306828"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/audience.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/metrics":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.metrics","tags":["douyin"],"summary":"Douyin Xingtu creator metrics","x-capability":{"id":"douyin.xingtu.creators.metrics","category":"creator","role":"creator.creators.metrics","stability":"preview","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0","charge_when_not_found":"0.004"}},"description":"Get how a Douyin creator's videos did over the last 30 or 90 days, by Xingtu creator ID: videos, median views, average likes, comments and shares, engagement and completion ratios, expected cost per thousand views and per interaction (in yuan). The figures are of all the videos: the platform gives none for the sponsored ones alone.\n\nPrice: $0.004 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Xingtu creator ID, a string of digits; not the Douyin account ID: take it from the Xingtu creator search","schema":{"type":"string"},"example":"6763236383382306828"},{"name":"window","in":"query","description":"The period: the last 30 or the last 90 days","schema":{"type":"string","enum":["30d","90d"],"default":"30d"},"example":"30d"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/xingtu_creator_metrics.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.videos.list","tags":["douyin"],"summary":"Douyin Xingtu creator video performance","x-capability":{"id":"douyin.xingtu.creators.videos.list","category":"creator","role":"creator.creators.posts.list","stability":"preview","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0.004"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600}},"description":"Get a page of a Douyin creator's videos by Xingtu creator ID, newest first, with the figures Xingtu gives for each: views, likes, completion and engagement ratios, length. Sponsored and everyday videos come together: the platform neither marks which are sponsored nor gives the sponsored ones alone.\n\nPrice: $0.004 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nA creator that does not exist cannot be told from a creator without videos: both return an empty result, not a 404.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Xingtu creator ID, a string of digits; not the Douyin account ID: take it from the Xingtu creator search","schema":{"type":"string"},"example":"6763236383382306828"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/xingtu_creator_post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/keywords/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.keywords.get","tags":["douyin"],"summary":"Douyin Xingtu creator content keywords","x-capability":{"id":"douyin.xingtu.creators.keywords.get","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.002","max_charge":"0.002","charge_when_empty":"0","charge_when_not_found":"0.002"}},"description":"Get the words Xingtu takes from a few of a Douyin creator's recent videos, by Xingtu creator ID: about twenty, each with how many times it was counted (usually single digits). They often come from one or two videos, which may be a sponsored one: a news outlet's account was found to return nothing but skincare words. They do not stand for the creator's content as a whole; for that, use the Xingtu content mix endpoint.\n\nPrice: $0.002 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Xingtu creator ID, a string of digits; not the Douyin account ID: take it from the Xingtu creator search","schema":{"type":"string"},"example":"6763236383382306828"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/xingtu_creator_keywords.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/scores/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.scores.get","tags":["douyin"],"summary":"Douyin Xingtu creator index scores","x-capability":{"id":"douyin.xingtu.creators.scores.get","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.008","max_charge":"0.008","charge_when_empty":"0","charge_when_not_found":"0.008"}},"description":"Get the six scores Xingtu gives a Douyin creator, by Xingtu creator ID: the overall Xingtu score and those for reach, seeding, conversion, cooperation and value for money, each with the score, the average of comparable creators, the rank and how far from the top that rank is.\n\nPrice: $0.008 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Xingtu creator ID, a string of digits; not the Douyin account ID: take it from the Xingtu creator search","schema":{"type":"string"},"example":"6763236383382306828"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/xingtu_creator_scores.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/content_mix/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.content_mix.get","tags":["douyin"],"summary":"Douyin Xingtu creator content mix","x-capability":{"id":"douyin.xingtu.creators.content_mix.get","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0","charge_when_not_found":"0.004"}},"description":"Get what a Douyin creator's recent videos are about, by Xingtu creator ID: the number of videos in each of the marketplace's content categories and their share. It shows whether the creator keeps to one subject.\n\nPrice: $0.004 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Xingtu creator ID, a string of digits; not the Douyin account ID: take it from the Xingtu creator search","schema":{"type":"string"},"example":"6763236383382306828"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/xingtu_creator_content_mix.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/creators/conversion/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.creators.conversion.get","tags":["douyin"],"summary":"Douyin Xingtu creator conversion","x-capability":{"id":"douyin.xingtu.creators.conversion.get","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0","charge_when_not_found":"0.004"}},"description":"Get how well a Douyin creator's product videos sell, by Xingtu creator ID: videos counted, their median views, products recommended, the bands that sales, sales per thousand views, product price, cost per click, product-link clicks and click rate fall in, and the categories of goods. A band is the platform's text, not an exact figure; for most creators tried, a seller of e-commerce level L4 among them, every band was empty (null), and a creator with no selling figures is answered as not found.\n\nPrice: $0.004 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Xingtu creator ID, a string of digits; not the Douyin account ID: take it from the Xingtu creator search","schema":{"type":"string"},"example":"6763236383382306828"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/xingtu_creator_conversion.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/campaigns/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.campaigns.list","tags":["douyin"],"summary":"Douyin Xingtu marketing calendar","x-capability":{"id":"douyin.xingtu.campaigns.list","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0.004"},"page":{"typical":40,"max":200}},"description":"Get the campaigns on Xingtu's marketing calendar over a span of time: platform events, e-commerce and seasonal moments, creative and industry campaigns, each with its name, description, kind, stage, sign-up period and running period. All at once, no paging.\n\nPrice: $0.004 per call.\n\n40 items on a usual page, 200 at most. Given whole: there is no next page.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"since","in":"query","required":true,"description":"Start of the span: campaigns that overlap the span are returned","schema":{"type":"string","format":"date-time"},"example":"2026-10-01T00:00:00Z"},{"name":"until","in":"query","required":true,"description":"End of the span","schema":{"type":"string","format":"date-time"},"example":"2026-12-31T23:59:59Z"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/xingtu_campaign.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.search","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY creator search","x-capability":{"id":"xiaohongshu.pgy.creators.search","category":"creator","role":"creator.creators.search","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0.04"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600,"note":{"zh":"一次搜索最多翻到前 5000 位博主（250 页），平台不再往后给，即使总数更多。","en":"A search goes as far as its first 5,000 creators (250 pages): the platform gives no more, whatever the total says."}}},"description":"Find Xiaohongshu creators on PGY by search terms, by the filters of PGY's creator square, or both: followers, the price of a sponsored note, estimated CPM, median reads and interactions of everyday and sponsored notes, image or video creators, content category, content feature, persona, where they are, gender, followers' gender and age, industry worked with lately; leaving out the inactive and those losing followers; ordered by followers, price, reads, interactions, shop visits, cost per read, invitations answered, growth, completion and more. Each with creator ID, name, handle, location, content categories and followers, and in the full view prices and medians. A search goes as far as its first 5,000 creators. The creator ID the other PGY endpoints take comes from here.\n\nPrice: $0.04 per call.\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"query","in":"query","description":"Search terms, matched against what creators' notes are about; for terms no creator matches the platform still returns loosely related creators, not an empty result. Leave out to find by the filters alone","schema":{"type":"string"},"example":"咖啡"},{"name":"sort","in":"query","description":"Order: relevance (the default); most_followers; lowest_rate, highest_rate; most_reads, most_engagements, most_impressions (medians of everyday notes); most_sponsored_reads, most_sponsored_engagements, most_sponsored_impressions; most_shop_visits; lowest_read_cost_image, lowest_read_cost_video (estimated cost per read); highest_reply_rate; fastest_growth; most_active_followers; most_thousand_like_notes; highest_completion_rate (of videos)","schema":{"type":"string","enum":["relevance","most_followers","lowest_rate","highest_rate","most_reads","most_engagements","most_impressions","most_sponsored_reads","most_sponsored_engagements","most_sponsored_impressions","most_shop_visits","lowest_read_cost_image","lowest_read_cost_video","highest_reply_rate","fastest_growth","most_active_followers","most_thousand_like_notes","highest_completion_rate"],"default":"relevance"},"example":"lowest_rate"},{"name":"followers_min","in":"query","description":"At least this many followers","schema":{"type":"integer","minimum":1},"example":10000},{"name":"followers_max","in":"query","description":"At most this many followers","schema":{"type":"integer","minimum":1},"example":50000},{"name":"rate_min","in":"query","description":"Rate at least this, in yuan: of an image note, or of a video note with type=video","schema":{"type":"integer","minimum":1},"example":3000},{"name":"rate_max","in":"query","description":"Rate at most this, in yuan: of an image note, or of a video note with type=video","schema":{"type":"integer","minimum":1},"example":8000},{"name":"cpm_min","in":"query","description":"Estimated CPM at least this, in yuan: of an image note, or of a video note with type=video","schema":{"type":"integer","minimum":1},"example":20},{"name":"cpm_max","in":"query","description":"Estimated CPM at most this, in yuan: of an image note, or of a video note with type=video","schema":{"type":"integer","minimum":1},"example":150},{"name":"median_reads_min","in":"query","description":"Median reads of everyday notes at least this","schema":{"type":"integer","minimum":1},"example":5000},{"name":"median_engagements_min","in":"query","description":"Median interactions of everyday notes at least this","schema":{"type":"integer","minimum":1},"example":300},{"name":"sponsored_median_reads_min","in":"query","description":"Median reads of sponsored notes at least this","schema":{"type":"integer","minimum":1},"example":8000},{"name":"type","in":"query","description":"Creators mostly of image notes (image) or of video notes (video); both when left out","schema":{"type":"string","enum":["image","video"]},"example":"video"},{"name":"category","in":"query","description":"Content category, top or second level (such as 护肤 or 面部保养), in PGY's own words; only a value of its dictionary is taken, anything else is a 400","schema":{"type":"string"},"example":"护肤"},{"name":"feature_tag","in":"query","description":"Content feature, top or second level (such as vlog or 探店), in PGY's own words; only a value of its dictionary is taken, anything else is a 400","schema":{"type":"string"},"example":"探店"},{"name":"persona","in":"query","description":"Persona, any level (such as 妈妈 or 职业身份), in PGY's own words; only a value of its dictionary is taken, anything else is a 400","schema":{"type":"string"},"example":"妈妈"},{"name":"location","in":"query","description":"Where the creator is, a province or a city (such as 上海 or 杭州), in PGY's own words; only a value of its dictionary is taken, anything else is a 400","schema":{"type":"string"},"example":"杭州"},{"name":"gender","in":"query","description":"The creator's gender: female or male","schema":{"type":"string","enum":["female","male"]},"example":"female"},{"name":"audience_gender","in":"query","description":"Creators whose followers are mostly women (female) or men (male)","schema":{"type":"string","enum":["female","male"]},"example":"female"},{"name":"audience_age","in":"query","description":"The age band most of the followers are in: under_18, 18_24, 25_34, 35_44, over_44","schema":{"type":"string","enum":["under_18","18_24","25_34","35_44","over_44"]},"example":"25_34"},{"name":"industry","in":"query","description":"Creators who worked with this industry lately: beauty, food_drink, mother_baby, electronics, household, fashion, internet, local_services, home_building, auto","schema":{"type":"string","enum":["beauty","food_drink","mother_baby","electronics","household","fashion","internet","local_services","home_building","auto"]},"example":"beauty"},{"name":"exclude","in":"query","description":"Creators to leave out: low_active, the inactive; follower_drop, those losing followers; both","schema":{"type":"string","enum":["low_active","follower_drop","both"]},"example":"both"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/creator.items.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.get","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY creator detail","x-capability":{"id":"xiaohongshu.pgy.creators.get","category":"creator","role":"creator.creators.get","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.04"}},"description":"Get a Xiaohongshu creator's profile on PGY by creator ID: name, handle, location, content categories, followers, and in the full view what an image note and a video note cost, the least a note costs and whether each is open, sponsored notes in all and in the last 30 days, median reads and interactions, gender, content and persona tags, industries worked with, the agency (MCN) and likes and saves in all.\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search","schema":{"type":"string"},"example":"5c0017ef6b58b740c92463fb"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/creator.item.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/audience/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.audience.get","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY creator audience profile","x-capability":{"id":"xiaohongshu.pgy.creators.audience.get","category":"creator","role":"creator.creators.audience.get","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.04"},"unavailable":{"gender.count":"capability","age.count":"capability","province.count":"capability","city.count":"capability","interest.count":"capability","device.count":"capability","city_tier":"platform","crowd":"platform","purchase_category":"platform","purchase_amount":"platform"}},"description":"Get who follows a Xiaohongshu creator, by PGY creator ID: the share of each segment by gender, age, province, city, interest and device, and the day the figures are of.\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search","schema":{"type":"string"},"example":"5c0017ef6b58b740c92463fb"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/audience.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/metrics":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.metrics","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY creator metrics","x-capability":{"id":"xiaohongshu.pgy.creators.metrics","category":"creator","role":"creator.creators.metrics","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.04"}},"description":"Get how a Xiaohongshu creator's everyday or sponsored notes did over the last 30 or 90 days, by PGY creator ID: notes and video notes, median impressions, reads, interactions and follows, engagement and completion ratios, the share of notes past 100 and 1,000 likes, the standing among comparable creators, and the share of impressions and reads from the explore feed, search, the following feed and other entry points. The full view adds each note's impressions, reads and interactions and how far each is above the median, and long-term notes (published about half a year back): their recent and long-term reads and where those came from.\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search","schema":{"type":"string"},"example":"5c0017ef6b58b740c92463fb"},{"name":"window","in":"query","description":"The period: the last 30 or the last 90 days","schema":{"type":"string","enum":["30d","90d"],"default":"30d"},"example":"30d"},{"name":"tab","in":"query","description":"Whose figures: everyday for the creator's everyday notes, sponsored for the sponsored ones; everyday by default, as the two tabs of the creator's PGY page","schema":{"type":"string","enum":["everyday","sponsored"],"default":"everyday"},"example":"everyday"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/pgy_creator_metrics.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/notes/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.notes.list","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY creator notes","x-capability":{"id":"xiaohongshu.pgy.creators.notes.list","category":"creator","role":"creator.creators.posts.list","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0.04"},"page":{"typical":8,"max":8,"cursor_ttl_seconds":3600}},"description":"Get a page of a Xiaohongshu creator's notes by PGY creator ID (PGY's note cases), with the figures PGY gives for each: reads, likes, saves, shop visitors, whether it was sponsored and for which brand, and whether paid promotion sent it traffic. Sponsored, cross-domain sponsored, image or video notes alone; newest, most read or most engaged first; by content feature or category; reads of organic traffic alone.\n\nPrice: $0.04 per call.\n\nNot taken together: tab=sponsored and type.\n\nNot taken together: tab=cross_domain and type.\n\n8 items on a usual page, 8 at most. A cursor is valid for 3600 seconds.\n\nA creator that does not exist cannot be told from a creator without notes: both return an empty result, not a 404.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search","schema":{"type":"string"},"example":"5c0017ef6b58b740c92463fb"},{"name":"tab","in":"query","description":"Which notes: all; sponsored, the sponsored notes alone (the page's 合作); cross_domain, the cross-domain sponsored notes alone (the page's 跨域合作, those with shop visitors). all by default","schema":{"type":"string","enum":["all","sponsored","cross_domain"],"default":"all"},"example":"sponsored"},{"name":"type","in":"query","description":"Image notes (image) or video notes (video) alone; both when left out. Only with tab=all","schema":{"type":"string","enum":["image","video"]},"example":"video"},{"name":"sort","in":"query","description":"Order: latest, newest first (the default); most_read, most read first; most_engaged, most interactions first","schema":{"type":"string","enum":["latest","most_read","most_engaged"],"default":"latest"},"example":"most_read"},{"name":"traffic","in":"query","description":"Which traffic reads count: all, promoted traffic included (the default); organic, organic traffic alone. It changes the reads only (recorded: 12,462 against 11,428 for one note); likes and saves stay the same","schema":{"type":"string","enum":["all","organic"],"default":"all"},"example":"organic"},{"name":"feature_tag","in":"query","description":"Only notes with this content feature tag, written as in the creator detail's ext.feature_tags (such as vlog); a misspelt tag is no error, it finds nothing","schema":{"type":"string"},"example":"vlog"},{"name":"category","in":"query","description":"Only notes of this content category, written as in the creator detail's categories or subcategories (such as 家居家装); a misspelt category is no error, it finds nothing","schema":{"type":"string"},"example":"美妆"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/pgy_creator_post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/xingtu/videos/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.xingtu.videos.get","tags":["douyin"],"summary":"Douyin Xingtu video report: plays and completion rate","x-capability":{"id":"douyin.xingtu.videos.get","category":"social","stability":"stable","pricing":{"per":"call","price":"0.004","max_charge":"0.004","charge_when_empty":"0","charge_when_not_found":"0.004"},"unavailable":{"title":"platform","lang":"capability","author.id":"capability","author.username":"capability","author.avatar_url":"capability","author.verified":"capability","metrics.reposts":"platform","images":"capability","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get Xingtu's report on one Douyin video by ID or link: plays and engagement counts, plus the completion rate, interaction rate, length, the author's followers and the author's Xingtu creator ID (to look up the creator's rates and metrics next). Only for videos Xingtu covers (mostly its creators').\n\nPrice: $0.004 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.douyin.com/video/7667629259711844858); share_text (7.69 复制打开抖音，看看【示例的作品】 https://www.douyin.com/video/7667629259711844858 复制此链接，打开Dou音搜索，直接观看视频！).","parameters":[{"name":"id","in":"query","description":"Video ID, a string of digits. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"7667629259711844858"},{"name":"url","in":"query","description":"Link to the video, pasted as it is: the https://www.douyin.com/video/… web link, a web link with modal_id in it, the page a share opens on a phone, the v.douyin.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which video it leads to","schema":{"type":"string"},"example":"https://www.douyin.com/video/7667629259711844858"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.douyin"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/keywords/related":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.keywords.related","tags":["douyin"],"summary":"Douyin search suggestions","x-capability":{"id":"douyin.keywords.related","category":"social","stability":"preview","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":10,"max":20},"unavailable":{"relevance":"platform","search_index":"platform","composite_index":"platform"}},"description":"Get the suggestions Douyin's search box lists as a keyword is typed into it (autocomplete), in the order it lists them, about 10 at a time. The words and their places only, with no index.\n\nPrice: $0.02 per call.\n\n10 items on a usual page, 20 at most. Given whole: there is no next page.\n\nA keyword Douyin has no suggestions for returns an empty result, never a not-found error.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"keyword","in":"query","required":true,"description":"One keyword","schema":{"type":"string"},"example":"露营"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/keyword_related.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/keywords/related":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.keywords.related","tags":["xiaohongshu"],"summary":"Xiaohongshu search suggestions","x-capability":{"id":"xiaohongshu.keywords.related","category":"social","stability":"preview","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0.02"},"page":{"typical":10,"max":20},"unavailable":{"relevance":"platform","search_index":"platform","composite_index":"platform"}},"description":"Get the suggestions Xiaohongshu's search box lists as a keyword is typed into it (autocomplete), in the order it lists them, about 10 at a time. The words and their places only, with no index.\n\nPrice: $0.02 per call.\n\n10 items on a usual page, 20 at most. Given whole: there is no next page.\n\nA keyword Xiaohongshu has no suggestions for returns an empty result, never a not-found error.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"keyword","in":"query","required":true,"description":"One keyword","schema":{"type":"string"},"example":"露营"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/keyword_related.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/videos/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.videos.get","tags":["xiaohongshu"],"summary":"Xiaohongshu video note with its video and subtitles","x-capability":{"id":"xiaohongshu.videos.get","category":"social","stability":"stable","pricing":{"per":"call","price":"0.02","max_charge":"0.02","charge_when_empty":"0","charge_when_not_found":"0.02"},"unavailable":{"metrics.views":"platform","metrics.reposts":"platform","author.verified":"capability","author.followers":"capability","mentions.username":"platform","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get one Xiaohongshu video note by ID or link: title, text, author, engagement counts, plus the video file's address, its length, its cover, the Chinese subtitles the platform made (SRT, usable as a transcript) and whether it is a brand partnership note on record. Video notes only; an image note is the note detail's.\n\nPrice: $0.02 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.xiaohongshu.com/explore/6ac7701f000000001800508c?xsec_token=ABx1y2z3); share_text (周末咖啡探店合集 https://www.xiaohongshu.com/discovery/item/6ac7701f000000001800508c?xsec_token=ABx1y2z3 复制这段文字，打开小红书查看).","parameters":[{"name":"id","in":"query","description":"Note ID, 24 hexadecimal characters. With only a link or a share text, give it as url","schema":{"type":"string"},"example":"6ac7701f000000001800508c"},{"name":"url","in":"query","description":"Link to the note, pasted as it is: the https://www.xiaohongshu.com/explore/… address from the browser, the https://www.xiaohongshu.com/discovery/item/… link the website shares (query parameters such as xsec_token are fine), a whole share text with such a link in it, or the xhslink.com short link the app copies (alone or in its share text). A short link is opened once to see which note it leads to; where it cannot be, paste the note's full link or its ID","schema":{"type":"string"},"example":"https://www.xiaohongshu.com/explore/6ac7701f000000001800508c?xsec_token=ABx1y2z3"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.item.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/followers/history":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.followers.history","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY creator follower history","x-capability":{"id":"xiaohongshu.pgy.creators.followers.history","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.04"}},"description":"Get a Xiaohongshu creator's follower count for each of the last 30 or 60 days, by PGY creator ID, with the net gain over the period and that gain as a share. Shows whether a creator is growing, or lost or bought followers all at once.\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search","schema":{"type":"string"},"example":"5c0017ef6b58b740c92463fb"},{"name":"window","in":"query","description":"How many of the most recent days: 30d for the last 30, 60d for the last 60; 30d by default","schema":{"type":"string","enum":["30d","60d"],"default":"30d"},"example":"30d"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/follower_history.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/related":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.related","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY similar creators","x-capability":{"id":"xiaohongshu.pgy.creators.related","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0.04"},"page":{"typical":4,"max":4,"cursor_ttl_seconds":3600}},"description":"Give a PGY creator ID and get the Xiaohongshu creators PGY recommends as similar: creator ID, name, handle, location, content categories, followers, and in the full view what a note with them costs and median reads and interactions. Four a call (PGY shows four a page), usually a handful to a few dozen in all, page by page.\n\nPrice: $0.04 per call.\n\n4 items on a usual page, 4 at most. A cursor is valid for 3600 seconds.\n\nA creator that does not exist cannot be told from one with no similar creators: both return an empty result, not a 404.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search","schema":{"type":"string"},"example":"5c0017ef6b58b740c92463fb"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/creator.items.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/notes/trending":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.notes.trending","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY trending notes","x-capability":{"id":"xiaohongshu.pgy.notes.trending","category":"social","stability":"stable","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0.04"},"page":{"typical":34,"max":34,"cursor_ttl_seconds":3600},"unavailable":{"text":"capability","lang":"capability","author.username":"capability","author.verified":"capability","metrics.shares":"capability","metrics.reposts":"platform","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"}},"description":"Get the trending notes of PGY's content square: eight boards such as Xiaohongshu hot, product seeding, e-commerce promotion and PGY sponsored, the whole board or the notes about some words, over the last 3, 7, 14 or 30 days, image or video notes only if wanted. Each note with its title, time published, reads, likes, saves, comments and pictures, and the creator's ID, name and followers. No ID needed: a way to find what is working and what to post about.\n\nPrice: $0.04 per call.\n\n34 items on a usual page, 34 at most. A cursor is valid for 3600 seconds.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which board: hot (Xiaohongshu hot), seeding (product seeding), shop_promo (e-commerce promotion), pgy (PGY sponsored), leads (lead collection), shop_hot (e-commerce hot), direct_seeding (seeding to shop), app_promo (app promotion); hot by default","schema":{"type":"string","enum":["hot","seeding","shop_promo","pgy","leads","shop_hot","direct_seeding","app_promo"],"default":"hot"},"example":"hot"},{"name":"query","in":"query","description":"Only the notes about these words, matched against a note's whole text, so a title need not hold them; leave out for the whole board","schema":{"type":"string"},"example":"咖啡"},{"name":"window","in":"query","description":"Over how many of the last days: 3d, 7d, 14d or 30d; 7d by default","schema":{"type":"string","enum":["3d","7d","14d","30d"],"default":"7d"},"example":"7d"},{"name":"type","in":"query","description":"Image notes (image) or video notes (video) only; leave out for both","schema":{"type":"string","enum":["image","video"]},"example":"video"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.xiaohongshu"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/costs/metrics":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.costs.metrics","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY creator costs and data summary","x-capability":{"id":"xiaohongshu.pgy.creators.costs.metrics","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.04"}},"description":"Get what a Xiaohongshu creator is expected to cost, by PGY creator ID: the estimated CPM, cost per interaction, cost per read and cost per shop visitor of an image note and of a video note, each with the share of comparable creators it beats; the median impressions, reads, interactions and shop visitors of a note, follower growth and notes published over 30 days, the share of invitations answered within 48 hours and the \"easy to reach\" mark, active days of the last 7 and the \"active\" mark, the strength PGY marks, the content mix and the industries worked with. Of everyday or of sponsored notes.\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search","schema":{"type":"string"},"example":"5c0017ef6b58b740c92463fb"},{"name":"tab","in":"query","description":"Whose figures: everyday for the creator's everyday notes, sponsored for the sponsored ones; everyday by default, as the two tabs of the creator's PGY page","schema":{"type":"string","enum":["everyday","sponsored"],"default":"everyday"},"example":"sponsored"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/pgy_creator_costs.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/followers/metrics":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.followers.metrics","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY creator follower summary","x-capability":{"id":"xiaohongshu.pgy.creators.followers.metrics","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.04"}},"description":"Get how much a Xiaohongshu creator's followers are worth, by PGY creator ID: followers and the net gain over 30 days, how many are active, engaged, reading and buying, each as a share of all followers and against comparable creators. Shows whether the followers really read and buy.\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search","schema":{"type":"string"},"example":"5c0017ef6b58b740c92463fb"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/pgy_creator_followers.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/creators/costs/history":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.creators.costs.history","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY creator core figures history","x-capability":{"id":"xiaohongshu.pgy.creators.costs.history","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.04"}},"description":"Get a Xiaohongshu creator's core figures for each of the last 30 or 90 days, by PGY creator ID: CPM, CPE (cost per interaction), CPV (cost per read), cost per shop visitor, and the median impressions, reads, interactions and shop visitors of a note, with the same figures for the whole period. Of everyday or of sponsored notes: shows whether a creator is getting better or worse value.\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"PGY creator ID, 24 hexadecimal characters; take it from the PGY creator search","schema":{"type":"string"},"example":"5c0017ef6b58b740c92463fb"},{"name":"window","in":"query","description":"The period: the last 30 or the last 90 days; 30d by default","schema":{"type":"string","enum":["30d","90d"],"default":"30d"},"example":"30d"},{"name":"tab","in":"query","description":"Whose figures: everyday for the creator's everyday notes, sponsored for the sponsored ones; everyday by default, as the two tabs of the creator's PGY page","schema":{"type":"string","enum":["everyday","sponsored"],"default":"everyday"},"example":"everyday"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/pgy_creator_cost_history.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/xiaohongshu/pgy/notes/get":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"xiaohongshu.pgy.notes.get","tags":["xiaohongshu"],"summary":"Xiaohongshu PGY note metrics","x-capability":{"id":"xiaohongshu.pgy.notes.get","category":"creator","stability":"preview","pricing":{"per":"call","price":"0.04","max_charge":"0.04","charge_when_empty":"0","charge_when_not_found":"0.04"}},"description":"Get the figures PGY shows a brand for one Xiaohongshu note, by note ID: impressions, reads, likes, saves, comments, shares and the follows it brought, the brand it was reported for, the click-through band of the brand's components (comment area, text, bottom), and its title, text, pictures, time published and creator ID. For closing a sponsored note's campaign and checking what a creator delivered. PGY keeps figures for its creators' notes only; a note it has none for (such as a brand's own) is a 404.\n\nPrice: $0.04 per call.\n\nPreview: the returned object may change, announced beforehand.","parameters":[{"name":"id","in":"query","required":true,"description":"Note ID, 24 hexadecimal characters: the part after explore/ in a Xiaohongshu note link, or an id the PGY creator notes endpoint returns","schema":{"type":"string"},"example":"6a20edfa0000000021020951"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/pgy_note.item"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/bilibili/backup/users/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"bilibili.backup.users.videos.list","tags":["bilibili"],"summary":"Bilibili user videos (backup)","x-capability":{"id":"bilibili.backup.users.videos.list","category":"social","role":"social.accounts.posts.list","role_type":"backup","backup_of":"bilibili.users.videos.list","stability":"stable","pricing":{"per":"call","price":"0.03","max_charge":"0.03","charge_when_empty":"0.03"},"page":{"typical":30,"max":30,"cursor_ttl_seconds":3600},"unavailable":{"lang":"capability","author.username":"platform","author.avatar_url":"capability","author.verified":"capability","author.followers":"capability","metrics.likes":"capability","metrics.shares":"capability","metrics.favorites":"capability","metrics.reposts":"platform","images":"platform","hashtags":"capability","mentions":"capability","is_pinned":"capability","post_id":"platform","parent_id":"platform","root_id":"platform"},"when":[{"params":["id"],"values":{},"unavailable":{"text":"capability","metrics.comments":"capability"}}]},"description":"The backup of Bilibili user videos, to call when the original cannot serve: the same parameters and result (without the description and the comment count), at a higher price.\n\nPrice: $0.03 per call.\n\n30 items on a usual page, 30 at most. A cursor is valid for 3600 seconds.\n\nWith id: without text, metrics.comments.\n\nA user that does not exist cannot be told from a user without videos: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","required":true,"description":"User number (mid), a string of digits","schema":{"type":"string"},"example":"8047632"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items.bilibili"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/backup/users/videos/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.backup.users.videos.list","tags":["douyin"],"summary":"Douyin user videos (backup)","x-capability":{"id":"douyin.backup.users.videos.list","category":"social","role":"social.accounts.posts.list","role_type":"backup","backup_of":"douyin.users.videos.list","stability":"stable","pricing":{"per":"call","price":"0.03","max_charge":"0.03","charge_when_empty":"0.03"},"page":{"typical":20,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"metrics.views":"capability","metrics.reposts":"platform","author.verified":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","author.followers":"capability"}},"description":"The backup of Douyin user videos, to call when the original cannot serve: the same parameters and result, at a higher price.\n\nPrice: $0.03 per call.\n\nGive exactly one of id, url.\n\nLinks taken by `url`: long (https://www.douyin.com/user/MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8); share_text (长按复制此条消息，打开抖音搜索，查看TA的更多作品。 https://www.douyin.com/user/MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8).\n\n20 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.\n\nAn account that does not exist cannot be told from an account without videos: both return an empty result, not a 404.","parameters":[{"name":"id","in":"query","description":"Account ID (the sec_uid, the string that starts with MS4w). With only a profile link or a share text, give it as url","schema":{"type":"string"},"example":"MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8"},{"name":"url","in":"query","description":"Link to the profile, pasted as it is: the https://www.douyin.com/user/… web link, the page a share opens on a phone, the v.douyin.com short link the app copies, or a whole share text with one of these in it. A short link is opened once to see which account it leads to","schema":{"type":"string"},"example":"https://www.douyin.com/user/MS4wLjABAAAAZ0aPDJzFhBrs0q3wVsp2a9WWrBuAUMsVyygoaO0bCw8"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/douyin/backup/videos/search":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"douyin.backup.videos.search","tags":["douyin"],"summary":"Douyin video search (backup)","x-capability":{"id":"douyin.backup.videos.search","category":"social","role":"social.posts.search","role_type":"backup","backup_of":"douyin.videos.search","stability":"stable","pricing":{"per":"call","price":"0.03","max_charge":"0.03","charge_when_empty":"0.03"},"page":{"typical":8,"max":20,"cursor_ttl_seconds":3600},"unavailable":{"metrics.views":"capability","metrics.reposts":"platform","author.verified":"capability","mentions":"capability","post_id":"platform","parent_id":"platform","root_id":"platform","is_pinned":"capability"}},"description":"The backup of Douyin video search, to call when the original cannot serve: the same parameters and result, at a higher price.\n\nPrice: $0.03 per call.\n\n8 items on a usual page, 20 at most. A cursor is valid for 3600 seconds.","parameters":[{"name":"query","in":"query","required":true,"description":"Search terms","schema":{"type":"string"},"example":"露营"},{"name":"sort","in":"query","description":"Order: the platform's ranking, newest first, most liked first. Douyin does not serve most liked within a day; with that pair, a day's results come with each page in order of likes","schema":{"type":"string","enum":["relevance","latest","popular"],"default":"relevance"},"example":"relevance"},{"name":"published_within","in":"query","description":"Only videos posted within the last day, week or half year; any time when left out","schema":{"type":"string","enum":["day","week","half_year"]},"example":"week"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/post.items"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/weibo/backup/trends/list":{"parameters":[{"$ref":"#/components/parameters/Idempotency-Key"},{"$ref":"#/components/parameters/X-Max-Price"},{"$ref":"#/components/parameters/X-Run-Id"},{"$ref":"#/components/parameters/X-Run-Step"},{"$ref":"#/components/parameters/X-Run-Iteration"},{"$ref":"#/components/parameters/X-Source"},{"$ref":"#/components/parameters/X-End-User"},{"$ref":"#/components/parameters/X-Entry"}],"get":{"operationId":"weibo.backup.trends.list","tags":["weibo"],"summary":"Weibo hot search board (backup)","x-capability":{"id":"weibo.backup.trends.list","category":"social","role":"social.trends.list","role_type":"backup","backup_of":"weibo.trends.list","stability":"stable","pricing":{"per":"call","price":"0.03","max_charge":"0.03","charge_when_empty":"0.03"},"page":{"typical":50,"max":51},"unavailable":{"id":"platform"}},"description":"The backup of the Weibo hot search board, to call when the original cannot serve: the same parameters and result, at a higher price.\n\nPrice: $0.03 per call.\n\n50 items on a usual page, 51 at most. Given whole: there is no next page.\n\nServed from a shared snapshot for up to 600 seconds.","parameters":[{"name":"board","in":"query","description":"Which list: hot searches is the only one","schema":{"type":"string","enum":["hot_search"],"default":"hot_search"},"example":"hot_search"},{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/trend.items.weibo"},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/catalog":{"get":{"operationId":"catalog.get","tags":["catalog"],"summary":"The whole catalog: capabilities, objects, parameters, errors, prices","security":[],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"ETag":{"$ref":"#/components/headers/ETag"}},"content":{"application/json":{"schema":{"type":"object","required":["code","data"],"properties":{"code":{"const":"ok"},"data":{"type":"object","required":["revision","prices","capabilities","categories","objects","ext","common_fields","params","errors","namespaces","tasks","jobs","roles","boards","lookups"],"properties":{"revision":{"type":"string"},"prices":{"type":"object","required":["version","effective_at","currency"],"properties":{"version":{"type":["string","null"]},"effective_at":{"type":["string","null"]},"currency":{"const":"USD"}}},"capabilities":{"type":"array","items":{"type":"object"}},"categories":{"type":"object","additionalProperties":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}}},"objects":{"type":"object"},"ext":{"type":"object"},"common_fields":{"type":"object"},"params":{"type":"object"},"errors":{"type":"object"},"namespaces":{"type":"object"},"tasks":{"type":"array","items":{"type":"object"}},"jobs":{"type":"object","additionalProperties":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}}},"roles":{"type":"object","description":"What each role is called and gives, by the role as callers name it."},"boards":{"type":"array","description":"The trend boards of the site: one capability with fixed options each.","items":{"type":"object"}},"lookups":{"type":"array","description":"The lookups of the site: one capability each, run by a person who has signed in.","items":{"type":"object"}}}}},"additionalProperties":false}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/catalog/capabilities":{"get":{"operationId":"catalog.capabilities.list","tags":["catalog"],"summary":"One line per capability, with prices and what is up right now","security":[],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"ETag":{"$ref":"#/components/headers/ETag"}},"content":{"application/json":{"schema":{"type":"object","required":["code","data"],"properties":{"code":{"const":"ok"},"data":{"type":"object","required":["revision","prices","capabilities","live"],"properties":{"revision":{"type":"string"},"prices":{"type":"object","required":["version","effective_at","currency"],"properties":{"version":{"type":["string","null"]},"effective_at":{"type":["string","null"]},"currency":{"const":"USD"}}},"capabilities":{"type":"array","items":{"type":"object"}},"live":{"$ref":"#/components/schemas/Live"}}}},"additionalProperties":false}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/catalog/capabilities/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"A capability's ID.","schema":{"type":"string"},"example":"douyin.videos.comments.list"}],"get":{"operationId":"catalog.capabilities.get","tags":["catalog"],"summary":"One capability's whole contract","security":[],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"ETag":{"$ref":"#/components/headers/ETag"}},"content":{"application/json":{"schema":{"type":"object","required":["code","data"],"properties":{"code":{"const":"ok"},"data":{"type":"object","required":["revision","prices","capability","live"],"properties":{"revision":{"type":"string"},"prices":{"type":"object","required":["version","effective_at","currency"],"properties":{"version":{"type":["string","null"]},"effective_at":{"type":["string","null"]},"currency":{"const":"USD"}}},"capability":{"type":"object"},"live":{"type":"object","required":["as_of"],"properties":{"as_of":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["available","degraded","paused"]}}}}}},"additionalProperties":false}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/catalog/objects":{"get":{"operationId":"catalog.objects.get","tags":["catalog"],"summary":"The returned objects and their fields","security":[],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"ETag":{"$ref":"#/components/headers/ETag"}},"content":{"application/json":{"schema":{"type":"object","required":["code","data"],"properties":{"code":{"const":"ok"},"data":{"type":"object","required":["revision","objects","ext","common_fields"],"properties":{"revision":{"type":"string"},"objects":{"type":"object"},"ext":{"type":"object"},"common_fields":{"type":"object"}}}},"additionalProperties":false}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/catalog/errors":{"get":{"operationId":"catalog.errors.get","tags":["catalog"],"summary":"The error codes","security":[],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"ETag":{"$ref":"#/components/headers/ETag"}},"content":{"application/json":{"schema":{"type":"object","required":["code","data"],"properties":{"code":{"const":"ok"},"data":{"type":"object","required":["revision","errors"],"properties":{"revision":{"type":"string"},"errors":{"type":"object"}}}},"additionalProperties":false}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/catalog/tasks":{"get":{"operationId":"catalog.tasks.get","tags":["catalog"],"summary":"The tasks","security":[],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"ETag":{"$ref":"#/components/headers/ETag"}},"content":{"application/json":{"schema":{"type":"object","required":["code","data"],"properties":{"code":{"const":"ok"},"data":{"type":"object","required":["revision","tasks","jobs"],"properties":{"revision":{"type":"string"},"tasks":{"type":"array","items":{"type":"object"}},"jobs":{"type":"object","additionalProperties":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}}}}}},"additionalProperties":false}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/catalog/status":{"get":{"operationId":"catalog.status.get","tags":["catalog"],"summary":"What is up right now, the incidents on record, and the share of the last 30 days each capability was serving","security":[],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"ETag":{"$ref":"#/components/headers/ETag"}},"content":{"application/json":{"schema":{"type":"object","required":["code","data"],"properties":{"code":{"const":"ok"},"data":{"type":"object","additionalProperties":false,"required":["live","platforms","incidents","availability"],"properties":{"live":{"$ref":"#/components/schemas/Live"},"platforms":{"type":"object","description":"By namespace: available when every capability of the platform is, paused when all are paused, degraded in between.","additionalProperties":{"type":"object","additionalProperties":false,"required":["status","capabilities","available","degraded","paused"],"properties":{"status":{"type":"string","enum":["available","degraded","paused"]},"capabilities":{"type":"integer"},"available":{"type":"integer"},"degraded":{"type":"integer"},"paused":{"type":"integer"}}}},"incidents":{"type":"array","description":"Written by a person, newest first: those still open, and those of the last 90 days.","items":{"type":"object","additionalProperties":false,"required":["id","title","body","billing_note","started_at","resolved_at","affected"],"properties":{"id":{"type":"string"},"title":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}},"body":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}},"billing_note":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}},"description":"Whether callers were charged while it lasted."},"started_at":{"type":"string","format":"date-time"},"resolved_at":{"type":["string","null"],"format":"date-time"},"affected":{"type":"object","description":"What it was about, as its writer named it; either list may be empty.","additionalProperties":false,"required":["capabilities","platforms"],"properties":{"capabilities":{"type":"array","items":{"type":"string"}},"platforms":{"type":"array","items":{"type":"string"}}}}}}},"availability":{"type":["object","null"],"description":"The share of time (0 to 1) each capability was serving calls, over the last 30 full UTC days on record (`days` of them, the first `since`): serving means at least one of its routes took calls, so not paused and not down. Degraded counts as serving. Not a call success rate. null until the first day is on record.","additionalProperties":false,"required":["days","since","service","platforms","capabilities"],"properties":{"days":{"type":"integer"},"since":{"type":"string","format":"date"},"service":{"type":"number","description":"Over every capability served."},"platforms":{"type":"object","description":"By namespace, over its capabilities.","additionalProperties":{"type":"number"}},"capabilities":{"type":"object","additionalProperties":{"type":"number"}}}}}}},"additionalProperties":false}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/catalog/search":{"get":{"operationId":"catalog.search","tags":["catalog"],"summary":"Find a capability from a need in words","security":[],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"ETag":{"$ref":"#/components/headers/ETag"}},"content":{"application/json":{"schema":{"type":"object","required":["code","data"],"properties":{"code":{"const":"ok"},"data":{"type":"object","required":["revision","prices","matches","platforms","unknown","nearest","namespaces","live"],"properties":{"revision":{"type":"string"},"prices":{"type":"object","required":["version","effective_at","currency"],"properties":{"version":{"type":["string","null"]},"effective_at":{"type":["string","null"]},"currency":{"const":"USD"}}},"matches":{"type":"array","maxItems":5,"description":"Best first. Empty: the catalog has nothing that is what was asked for, and nothing is put forward in its place.","items":{"type":"object","required":["type","id","url","name"],"properties":{"type":{"type":"string","enum":["capability","skill","guide"],"description":"Only a capability can be called as it is."},"id":{"type":"string"},"url":{"type":"string","description":"Its page, from the site's root."},"name":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}},"summary":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}},"backup":{"type":"boolean","enum":[true],"description":"A backup: the same as another capability at a higher price, to call when that one fails. Listed after the others."},"path":{"type":"string"},"methods":{"type":"array","items":{"type":"string","enum":["GET","POST"]}},"required":{"type":"array","items":{"type":"string"},"description":"Parameters every call needs."},"one_of":{"type":"array","items":{"type":"string"},"description":"Parameters of which exactly one is given."},"pricing":{"type":["object","null"]},"example":{"type":"object","description":"A call with its parameters filled in."}}}},"platforms":{"type":"array","items":{"type":"string"},"description":"The platforms the request was read as being about."},"unknown":{"type":"array","items":{"type":"string"},"description":"Words of the request that nothing in the catalog has."},"nearest":{"type":"array","description":"With no match on a platform that was named: everything that platform has, then what other platforms have that names it.","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}},"summary":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}},"backup":{"type":"boolean","enum":[true]}}}},"namespaces":{"type":"object","description":"Every platform the catalog has, by its key.","additionalProperties":{"type":"object","required":["zh","en"],"properties":{"zh":{"type":"string"},"en":{"type":"string"}}}},"live":{"$ref":"#/components/schemas/Live"}}}},"additionalProperties":false}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}},"description":"Free, no key. Ranked by words, not by meaning: a need the catalog does not have is answered with no match. Give `query`, `platform`, or both.","parameters":[{"name":"query","in":"query","description":"The need in plain words, English or Chinese: 1 to 200 characters.","schema":{"type":"string","minLength":1,"maxLength":200},"example":"comments on a douyin video"},{"name":"platform","in":"query","description":"Only this platform, by its key or any of its names. Alone, it lists all the platform has.","schema":{"type":"string","minLength":1,"maxLength":200}},{"name":"category","in":"query","schema":{"type":"string","enum":["ads","commerce","creator","social"]}}]}},"/v1/calls":{"get":{"operationId":"calls.byKey","tags":["calls"],"summary":"What an idempotency key stands for right now","description":"Asking starts nothing, holds nothing and charges nothing, whatever the answer: it is how a call sent under a key is found again without sending it. No request comes with the question, so `idempotency_conflict` is never answered here: a different request sent under the key is still refused with it where it is sent. A key another account used is a key this account never used. Free; it draws on the account's rate for what is not charged, and answers 429 `rate_limited` with `Retry-After` when that is used up.","parameters":[{"name":"idempotency_key","in":"query","required":true,"description":"The key a call was sent under: 1 to 255 visible characters without spaces.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$"}}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","required":["code","request_id","data"],"properties":{"code":{"const":"ok"},"request_id":{"type":"string","format":"uuid"},"data":{"$ref":"#/components/schemas/KeyStanding"}}}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/calls/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"The request ID of a call of this account.","schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"calls.get","tags":["calls"],"summary":"What became of a call, and what it was charged","description":"Another account's request ID answers like one that was never issued. Free; it draws on the account's rate for what is not charged, and answers 429 `rate_limited` with `Retry-After` when that is used up.","responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","required":["code","request_id","data"],"properties":{"code":{"const":"ok"},"request_id":{"type":"string","format":"uuid"},"data":{"$ref":"#/components/schemas/Receipt"}}}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/calls/{id}/result":{"parameters":[{"name":"id","in":"path","required":true,"description":"The request ID of a call of this account.","schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"calls.result.get","tags":["calls"],"summary":"The saved result of a call again, in any view","description":"For 24 hours after the call. The envelope is that call's: `replayed` is true and nothing is added to the bill. Free; it draws on the account's rate for what is not charged, and answers 429 `rate_limited` with `Retry-After` when that is used up.","parameters":[{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/account":{"get":{"operationId":"account.get","tags":["account"],"summary":"The balance, this key's budget and scopes, the rate limits","description":"Free; it draws on the account's rate for what is not charged, and answers 429 `rate_limited` with `Retry-After` when that is used up.","responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","required":["code","request_id","data"],"properties":{"code":{"const":"ok"},"request_id":{"type":"string","format":"uuid"},"data":{"$ref":"#/components/schemas/Account"}}}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/usage":{"get":{"operationId":"usage.get","tags":["account"],"summary":"The account's finished calls, counted and summed","description":"`since` and `until` are at most 92 days apart: a longer time is asked for in several requests. More than 10,000 rows is refused, not cut short: narrow the dates or group by less. Free; it draws on the account's rate for what is not charged, and answers 429 `rate_limited` with `Retry-After` when that is used up.","parameters":[{"name":"since","in":"query","description":"Calls that ended at or after. Left out: the last 30 days.","schema":{"type":"string","format":"date-time"}},{"name":"until","in":"query","description":"Calls that ended before. Left out: up to now.","schema":{"type":"string","format":"date-time"}},{"name":"capability","in":"query","schema":{"type":"string"}},{"name":"key_id","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"source","in":"query","schema":{"type":"string"}},{"name":"end_user","in":"query","schema":{"type":"string"}},{"name":"group_by","in":"query","description":"One or more of day, capability, key_id, entry, source, end_user, comma-separated. `day` is the UTC day.","schema":{"type":"string","default":"day"}},{"name":"format","in":"query","schema":{"type":"string","enum":["json","csv"],"default":"json"}}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","required":["code","request_id","data"],"properties":{"code":{"const":"ok"},"request_id":{"type":"string","format":"uuid"},"data":{"$ref":"#/components/schemas/Usage"}}}},"text/csv":{"schema":{"type":"string"}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/runs":{"post":{"operationId":"runs.create","tags":["runs"],"summary":"Open the budget of one run of a task","description":"Calls that name the run in `X-Run-Id` are held to its amount and call limits by the server. An account has at most 100 runs open (not yet expired) at once: one more is refused with 429 `rate_limited`, reason `open_runs`, until one expires. Free; it draws on the account's rate for what is not charged, and answers 429 `rate_limited` with `Retry-After` when that is used up.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["task_id","task_revision","max_amount","max_calls"],"properties":{"task_id":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,99}$"},"task_revision":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,99}$"},"max_amount":{"type":"string","description":"US dollars, as a decimal string."},"max_calls":{"type":"integer","minimum":1,"maximum":10000},"ttl_seconds":{"type":"integer","minimum":60,"maximum":86400,"default":3600}}}}}},"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","required":["code","request_id","data"],"properties":{"code":{"const":"ok"},"request_id":{"type":"string","format":"uuid"},"data":{"type":"object","required":["run_id","expires_at"],"properties":{"run_id":{"type":"string","format":"uuid"},"expires_at":{"type":"string","format":"date-time"}}}}}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}},"/v1/runs/{id}":{"parameters":[{"name":"id","in":"path","required":true,"description":"A run ID of this account.","schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"runs.get","tags":["runs"],"summary":"Where a run stands","description":"An expired run can still be read. Free; it draws on the account's rate for what is not charged, and answers 429 `rate_limited` with `Retry-After` when that is used up.","responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"type":"object","required":["code","request_id","data"],"properties":{"code":{"const":"ok"},"request_id":{"type":"string","format":"uuid"},"data":{"$ref":"#/components/schemas/Run"}}}}}},"4XX":{"$ref":"#/components/responses/error"},"5XX":{"$ref":"#/components/responses/error"}}}}},"components":{"securitySchemes":{"key":{"type":"http","scheme":"bearer","description":"An API key in `Authorization: Bearer`. Never in the address."}},"parameters":{"Idempotency-Key":{"name":"Idempotency-Key","in":"header","description":"Runs the request once: the same key and parameters again return the first result and charge nothing more; the same key with other parameters is a 409. Kept 24 hours, per account.","schema":{"type":"string","pattern":"^[\\x21-\\x7e]{1,255}$"}},"X-Max-Price":{"name":"X-Max-Price","in":"header","description":"The most this call may be charged, in US dollars. A call that could cost more is refused before anything runs.","schema":{"type":"string","pattern":"^\\d{1,7}(\\.\\d{1,6})?$"},"example":"0.01"},"X-Run-Id":{"name":"X-Run-Id","in":"header","description":"The run (POST /v1/runs) this call belongs to: checked against the run's amount and call limits.","schema":{"type":"string","format":"uuid"}},"X-Run-Step":{"name":"X-Run-Step","in":"header","description":"Which step of the run.","schema":{"type":"string","pattern":"^\\d{1,6}$"}},"X-Run-Iteration":{"name":"X-Run-Iteration","in":"header","description":"Which page or turn of the step.","schema":{"type":"string","pattern":"^\\d{1,6}$"}},"X-Source":{"name":"X-Source","in":"header","description":"Your own label for where the call comes from (a skill, a task, a product). Recorded for usage figures, never acted on.","schema":{"type":"string","pattern":"^[\\x21-\\x7e]{1,128}$"}},"X-End-User":{"name":"X-End-User","in":"header","description":"Your own label for the end user the call is for. Recorded for usage figures; do not put personal data in it.","schema":{"type":"string","pattern":"^[\\x21-\\x7e]{1,128}$"}},"X-Entry":{"name":"X-Entry","in":"header","description":"Set by the SDK and the command line to say the request is theirs.","schema":{"type":"string","enum":["sdk","cli"]}},"cursor":{"name":"cursor","in":"query","description":"The `next_cursor` of the previous page. A new page is a new call.","schema":{"type":"string"}},"view":{"name":"view","in":"query","description":"How much of each item: compact (the most used fields, long text cut short), standard, or full (adds `ext`).","schema":{"type":"string","enum":["compact","standard","full"],"default":"standard"}},"fields":{"name":"fields","in":"query","description":"Return only these fields of each item, by path (`author.name`).","schema":{"type":"array","items":{"type":"string"}},"explode":false}},"headers":{"X-Request-Id":{"description":"The request ID, the same as `request_id` in the body. The catalog's addresses, which a cache may keep, carry it here only.","schema":{"type":"string","format":"uuid"}},"X-RateLimit-Limit":{"description":"Requests per minute the account may make. Absent when no caller was identified.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the bucket.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"When the bucket is full again, in Unix seconds.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying, when the service can say; the same number as `retry_after_seconds`.","schema":{"type":"integer"}},"Cache-Control":{"description":"On the catalog's addresses: `public, max-age=…`, how long whoever fetched the answer may keep it.","schema":{"type":"string"}},"ETag":{"description":"On the addresses whose data is the catalog's alone: names the definitions and the price book the answer was made from. Sent back in `If-None-Match`, it is answered 304 while both are the same.","schema":{"type":"string"}}},"responses":{"error":{"description":"An error. Nothing was charged unless `charged` is null.\n\n- `invalid_params` (400, retry: after_fix, charged the endpoint's price where its data source billed the answer): A parameter is invalid\n- `request_not_served` (400, retry: after_fix): This combination of parameters cannot be served at present\n- `max_price_exceeded` (400, retry: after_fix): The most this call could cost is above the limit you set\n- `cursor_invalid` (400, retry: no): The cursor does not exist\n- `cursor_mismatch` (400, retry: after_fix): The cursor was issued for another endpoint or other parameters\n- `unauthorized` (401, retry: no): No credential was sent, or it is invalid, disabled or expired\n- `insufficient_balance` (402, retry: after_fix): The balance is too low\n- `key_budget_exceeded` (402, retry: after_fix): This key's spending limit does not cover the call\n- `run_budget_exceeded` (402, retry: no): This run's amount or call limit does not cover the call\n- `account_suspended` (403, retry: no): The account is suspended\n- `forbidden` (403, retry: no): This credential may not use that option\n- `key_scope_denied` (403, retry: no): This key may not call this endpoint\n- `not_found` (404, retry: no, charged the endpoint's price where its data source billed the answer): The object does not exist, is private or was deleted\n- `result_not_found` (404, retry: no): No result under this request ID\n- `run_not_found` (404, retry: no): No run under this run ID\n- `unknown_endpoint` (404, retry: no): There is no such endpoint\n- `call_in_progress` (409, retry: same_key): The call under this idempotency key is still running; ask again with the same key shortly\n- `idempotency_conflict` (409, retry: after_fix): This idempotency key was used for a different request\n- `cursor_expired` (410, retry: no): The cursor expired; start again from the first page\n- `result_expired` (410, retry: no): Results are kept for 24 hours; this one is gone\n- `run_expired` (410, retry: no): This run has expired and starts no more calls\n- `rate_limited` (429, retry: yes): Too many requests, or too many calls in progress\n- `cost_cap_exceeded` (429, retry: yes): This account's allowance for today is used up\n- `uncharged_cost_limit` (429, retry: yes): Too many of this account's calls today returned nothing and were not charged; endpoints of this kind can be called again tomorrow (UTC)\n- `settlement_unknown` (500, retry: same_key, may have been charged): Whether this call settled is not known; ask again with the same idempotency key, or look it up by request ID\n- `internal_error` (500, retry: yes): The service failed\n- `upstream_failed` (502, retry: yes): No result came back this time and nothing was charged; retry shortly\n- `cursor_unavailable` (502, retry: yes): This cursor is unavailable just now; retry later or start again from the first page\n- `upstream_busy` (503, retry: yes): Busy just now; retry shortly\n- `capability_paused` (503, retry: yes): This endpoint is paused\n- `overloaded` (503, retry: yes): The service is busy; retry shortly\n- `timeout` (504, retry: yes): The data did not arrive in time; retry with the same idempotency key","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"comment.items.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/post"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"comment.items.bilibili":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.bilibili.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"trend.items.bilibili":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/trend"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.bilibili.trend"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.item.bilibili":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.bilibili.account"}}}]},{"type":"null"}]}}}}}]}}}},"post.items.bilibili":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.bilibili.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.bilibili":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.bilibili.post"}}}]},{"type":"null"}]}}}}}]}}}},"brand_history.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/brand_history"},{"type":"null"}]}}}}}]}}}},"brand_metrics.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/brand_metrics"},{"type":"null"}]}}}}}]}}}},"post.items.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"audience.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/audience"},{"type":"null"}]}}}}}]}}}},"index_creator_metrics.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/index_creator_metrics"},{"type":"null"}]}}}}}]}}}},"keyword_audience.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/keyword_audience"},{"type":"null"}]}}}}}]}}}},"keyword_history.items.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/keyword_history"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.keyword_history"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"keyword_related.items.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/keyword_related"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.keyword_related"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"trend.items.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/trend"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.trend"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.item.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.account"}}}]},{"type":"null"}]}}}}}]}}}},"account_history.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/account_history"},{"type":"null"}]}}}}}]}}}},"account_history.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/account_history"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.items.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.account"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.post"}}}]},{"type":"null"}]}}}}}]}}}},"post.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/post"},{"type":"null"}]}}}}}]}}}},"creator_rates.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/creator_rates"},{"type":"null"}]}}}}}]}}}},"comment.items.kuaishou":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.kuaishou.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"trend.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/trend"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.item.kuaishou":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.kuaishou.account"}}}]},{"type":"null"}]}}}}}]}}}},"account.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/account"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.items.kuaishou":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.kuaishou.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.kuaishou":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.kuaishou.post"}}}]},{"type":"null"}]}}}}}]}}}},"account.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/account"},{"type":"null"}]}}}}}]}}}},"post.items.telegram":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.telegram.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.telegram":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.telegram.post"}}}]},{"type":"null"}]}}}}}]}}}},"post.items.x":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.x.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.x":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.x.post"}}}]},{"type":"null"}]}}}}}]}}}},"account.item.facebook":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.facebook.account"}}}]},{"type":"null"}]}}}}}]}}}},"comment.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/comment"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"ad.item.google":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/ad"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.google.ad"}}}]},{"type":"null"}]}}}}}]}}}},"ad.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ad"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"advertiser.items.google":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/advertiser"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.google.advertiser"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"ad.item.linkedin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/ad"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.linkedin.ad"}}}]},{"type":"null"}]}}}}}]}}}},"ad.items.linkedin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ad"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.linkedin.ad"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.item.linkedin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.linkedin.account"}}}]},{"type":"null"}]}}}}}]}}}},"ad.item.meta":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/ad"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.meta.ad"}}}]},{"type":"null"}]}}}}}]}}}},"ad.items.meta":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ad"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.meta.ad"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"transcript.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/transcript"},{"type":"null"}]}}}}}]}}}},"advertiser.items.meta":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/advertiser"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.meta.advertiser"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.threads":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.threads.post"}}}]},{"type":"null"}]}}}}}]}}}},"post.items.threads":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.threads.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.items.instagram":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.instagram.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.instagram":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.instagram.post"}}}]},{"type":"null"}]}}}}}]}}}},"account.item.instagram":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.instagram.account"}}}]},{"type":"null"}]}}}}}]}}}},"account.items.instagram":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.instagram.account"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"ad.items.tiktok":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ad"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.tiktok.ad"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"ad.item.tiktok":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/ad"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.tiktok.ad"}}}]},{"type":"null"}]}}}}}]}}}},"comment.items.tiktok":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.tiktok.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.items.tiktok":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.tiktok.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.item.tiktok":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.tiktok.account"}}}]},{"type":"null"}]}}}}}]}}}},"account.items.tiktok":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.tiktok.account"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.tiktok":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.tiktok.post"}}}]},{"type":"null"}]}}}}}]}}}},"comment.items.weibo":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.weibo.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.weibo":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.weibo.post"}}}]},{"type":"null"}]}}}}}]}}}},"account.items.weibo":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.weibo.account"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.items.weibo":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.weibo.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"trend.items.weibo":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/trend"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.weibo.trend"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.item.weibo":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.weibo.account"}}}]},{"type":"null"}]}}}}}]}}}},"account.item.x":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.x.account"}}}]},{"type":"null"}]}}}}}]}}}},"account.items.x":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.x.account"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.xiaohongshu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.xiaohongshu.post"}}}]},{"type":"null"}]}}}}}]}}}},"comment.items.xiaohongshu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.xiaohongshu.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.items.xiaohongshu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.xiaohongshu.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"keyword_history.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/keyword_history"},{"type":"null"}]}}}}}]}}}},"keyword_related.items.xiaohongshu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/keyword_related"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.xiaohongshu.keyword_related"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"topic.item.xiaohongshu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/topic"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.xiaohongshu.topic"}}}]},{"type":"null"}]}}}}}]}}}},"account.item.xiaohongshu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.xiaohongshu.account"}}}]},{"type":"null"}]}}}}}]}}}},"account.item.youtube":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.youtube.account"}}}]},{"type":"null"}]}}}}}]}}}},"post.items.youtube":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.youtube.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"comment.items.youtube":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.youtube.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.youtube":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.youtube.post"}}}]},{"type":"null"}]}}}}}]}}}},"account.item.wechat_channels":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_channels.account"}}}]},{"type":"null"}]}}}}}]}}}},"post.item.wechat_channels":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_channels.post"}}}]},{"type":"null"}]}}}}}]}}}},"comment.items.wechat_channels":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_channels.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"channels_share_link.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/channels_share_link"},{"type":"null"}]}}}}}]}}}},"channels_collection.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/channels_collection"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.items.wechat_channels":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_channels.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.items.wechat":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.items.wechat_mp":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_mp.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.item.wechat_mp":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_mp.account"}}}]},{"type":"null"}]}}}}}]}}}},"comment.items.wechat_mp":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_mp.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.wechat_mp":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_mp.post"}}}]},{"type":"null"}]}}}}}]}}}},"account.items.wechat":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat.account"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.items.wechat_mp":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_mp.account"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account_owner.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/account_owner"},{"type":"null"}]}}}}}]}}}},"keyword_history.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/keyword_history"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"keyword_related.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/keyword_related"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"miniprogram.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/miniprogram"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.items.wechat_channels":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.wechat_channels.account"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"comment.items.reddit":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.reddit.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.reddit":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.reddit.post"}}}]},{"type":"null"}]}}}}}]}}}},"post.items.reddit":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.reddit.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.item.reddit":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.reddit.account"}}}]},{"type":"null"}]}}}}}]}}}},"comment.items.zhihu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/comment"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.zhihu.comment"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.zhihu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.zhihu.post"}}}]},{"type":"null"}]}}}}}]}}}},"trend.items.zhihu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/trend"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.zhihu.trend"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.items.zhihu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.zhihu.account"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"account.item.zhihu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/account"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.zhihu.account"}}}]},{"type":"null"}]}}}}}]}}}},"community.item.reddit":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/community"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.reddit.community"}}}]},{"type":"null"}]}}}}}]}}}},"community.items.reddit":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/community"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.reddit.community"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"community.item.x":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/community"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.x.community"}}}]},{"type":"null"}]}}}}}]}}}},"product.item.tiktok":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/product"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.tiktok.product"}}}]},{"type":"null"}]}}}}}]}}}},"review.items.tiktok":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/review"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.tiktok.review"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"product.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/product"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"product.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/product"},{"type":"null"}]}}}}}]}}}},"review.items.xiaohongshu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/review"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.xiaohongshu.review"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"post.item.pinterest":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.pinterest.post"}}}]},{"type":"null"}]}}}}}]}}}},"post.items.pinterest":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/post"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.pinterest.post"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"creator.items.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/creator"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.creator"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"creator.item.douyin":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/creator"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.douyin.creator"}}}]},{"type":"null"}]}}}}}]}}}},"xingtu_creator_metrics.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/xingtu_creator_metrics"},{"type":"null"}]}}}}}]}}}},"xingtu_creator_post.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/xingtu_creator_post"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"xingtu_creator_keywords.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/xingtu_creator_keywords"},{"type":"null"}]}}}}}]}}}},"xingtu_creator_scores.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/xingtu_creator_scores"},{"type":"null"}]}}}}}]}}}},"xingtu_creator_content_mix.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/xingtu_creator_content_mix"},{"type":"null"}]}}}}}]}}}},"xingtu_creator_conversion.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/xingtu_creator_conversion"},{"type":"null"}]}}}}}]}}}},"xingtu_campaign.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/xingtu_campaign"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"creator.items.xiaohongshu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/creator"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.xiaohongshu.creator"}}}]}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"creator.item.xiaohongshu":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/creator"},{"type":"object","properties":{"ext":{"$ref":"#/components/schemas/ext.xiaohongshu.creator"}}}]},{"type":"null"}]}}}}}]}}}},"pgy_creator_metrics.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/pgy_creator_metrics"},{"type":"null"}]}}}}}]}}}},"pgy_creator_post.items":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/pgy_creator_post"}},"missing":{"type":"array","items":{"$ref":"#/components/schemas/Missing"}}}}}}]}}}},"follower_history.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/follower_history"},{"type":"null"}]}}}}}]}}}},"pgy_creator_costs.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/pgy_creator_costs"},{"type":"null"}]}}}}}]}}}},"pgy_creator_followers.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/pgy_creator_followers"},{"type":"null"}]}}}}}]}}}},"pgy_creator_cost_history.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/pgy_creator_cost_history"},{"type":"null"}]}}}}}]}}}},"pgy_note.item":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Envelope"},{"type":"object","properties":{"data":{"type":"object","required":["item"],"properties":{"item":{"anyOf":[{"$ref":"#/components/schemas/pgy_note"},{"type":"null"}]}}}}}]}}}}},"schemas":{"Page":{"type":"object","description":"Present on capabilities that return lists. A page is asked for with `cursor`; each page is its own call and is charged on its own.","required":["next_cursor","cursor_expires_at","has_more","returned"],"properties":{"next_cursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page; null when there is none."},"cursor_expires_at":{"type":["string","null"],"format":"date-time"},"has_more":{"type":"boolean"},"returned":{"type":"integer"}}},"Warning":{"type":"object","required":["code"],"properties":{"code":{"type":"string","enum":["items_dropped","items_not_requested","fields_unparsed","text_truncated"]},"count":{"type":"integer","description":"items_dropped, items_not_requested: how many."},"item":{"type":"integer","description":"fields_unparsed, text_truncated: index of the item."},"fields":{"type":"array","items":{"type":"string"}}}},"Missing":{"type":"object","description":"An ID of a batch that is not among the items.","required":["id","reason"],"properties":{"id":{"type":"string"},"reason":{"type":"string","enum":["not_found","invalid"]}}},"Meta":{"type":"object","required":["capability","result_status","fetched_at","cached","replayed","unavailable","billing"],"properties":{"capability":{"type":"string"},"result_status":{"type":"string","enum":["complete","partial","empty"]},"fetched_at":{"type":"string","format":"date-time"},"cached":{"type":"boolean","description":"From a shared snapshot."},"replayed":{"type":"boolean","description":"The saved result of an earlier call: `request_id` is that call's and nothing was added to the bill."},"unavailable":{"type":"object","description":"Fields this result could not carry, each with why.","additionalProperties":{"type":"string"}},"billing":{"type":"object","required":["amount","currency","balance_after"],"properties":{"amount":{"type":"string","description":"US dollars, as a decimal string."},"currency":{"const":"USD"},"balance_after":{"type":["string","null"]},"covers_next":{"const":false,"description":"Present when what is left does not cover what another call like this one holds before it runs (its price at the most items)."},"top_up_url":{"type":"string","format":"uri","description":"With covers_next: where to top up."}}}}},"Envelope":{"type":"object","description":"The envelope every capability answers with.","required":["code","request_id","data","warnings","meta"],"properties":{"code":{"const":"ok"},"request_id":{"type":"string","format":"uuid"},"data":{"type":"object"},"page":{"$ref":"#/components/schemas/Page"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Warning"}},"meta":{"$ref":"#/components/schemas/Meta"}}},"Error":{"type":"object","description":"Every error the service sends has this structure.","required":["code","request_id","message","message_zh","charged","retry","retry_after_seconds","param","docs_url"],"properties":{"code":{"type":"string","enum":["invalid_params","request_not_served","max_price_exceeded","cursor_invalid","cursor_mismatch","unauthorized","insufficient_balance","key_budget_exceeded","run_budget_exceeded","account_suspended","forbidden","key_scope_denied","not_found","result_not_found","run_not_found","unknown_endpoint","call_in_progress","idempotency_conflict","cursor_expired","result_expired","run_expired","rate_limited","cost_cap_exceeded","uncharged_cost_limit","settlement_unknown","internal_error","upstream_failed","cursor_unavailable","upstream_busy","capability_paused","overloaded","timeout"]},"request_id":{"type":"string","format":"uuid"},"message":{"type":"string"},"message_zh":{"type":"string"},"charged":{"type":["boolean","null"],"description":"false: nothing was charged. true: `amount` was charged, the endpoint's price, for an object not there or input refused that its data source billed. null: not known (settlement_unknown only); look the call up before assuming either."},"amount":{"type":"string","description":"What was charged, where `charged` is true."},"retry":{"type":"string","enum":["no","yes","once","after_fix","same_key"],"description":"no; yes; once: one more try only; after_fix: only with a changed request; same_key: only under the same Idempotency-Key."},"retry_after_seconds":{"type":["integer","null"]},"param":{"type":["string","null"],"description":"The parameter or option at fault."},"problems":{"type":"array","items":{"type":"string"}},"reason":{"type":"string","description":"Which case of the code: not_found or private_or_deleted; rate or concurrency; day, month or total; moved or retired, for a path of the interface as it was before this one."},"why":{"type":"string","enum":["self_only","partial","deleted","withheld","no_such","uid_not_served","closed","link_refused"],"description":"not_found: why the object cannot be had, where the platform said; `message` and `message_zh` then say it in place of the code's general words."},"platform_says":{"type":"string","description":"not_found: the platform's own sentence for it, as it gave it, where its answer carried one (at most 200 characters)."},"moved_to":{"type":"string","description":"On a path of the earlier interface: the path to call instead (for a retired one, the nearest of its kind, or the list of capabilities)."},"moved_to_docs":{"type":"string","format":"uri","description":"The page that documents `moved_to`."},"alternative":{"type":"object","description":"When the data source failed and the endpoint has a backup version that takes calls: the backup to send the same request to, with a new Idempotency-Key. The same parameters and fields, at its own price.","required":["capability","path","per","price","note","note_zh"],"properties":{"capability":{"type":"string"},"path":{"type":"string"},"per":{"type":"string","enum":["call","item"]},"price":{"type":"string","description":"US dollars, as a decimal string."},"minimum":{"type":"string","description":"US dollars, as a decimal string."},"note":{"type":"string"},"note_zh":{"type":"string"}}},"required":{"type":"string","description":"US dollars, as a decimal string."},"available":{"type":"string","description":"US dollars, as a decimal string."},"top_up_url":{"type":"string","format":"uri","description":"insufficient_balance: where to top up, in the account's language. Then send the same request again, unchanged."},"next_step":{"type":"string","description":"insufficient_balance: what to do next."},"next_step_zh":{"type":"string","description":"insufficient_balance: the same in Chinese."},"docs_url":{"type":"string","format":"uri"}}},"Live":{"type":"object","description":"What is so right now, apart from the catalog, which is a snapshot.","required":["as_of","status"],"properties":{"as_of":{"type":"string","format":"date-time"},"status":{"type":"object","additionalProperties":{"type":"string","enum":["available","degraded","paused"]}}}},"Receipt":{"type":"object","description":"The record of one call. Kept; its result is kept 24 hours.","required":["request_id","capability","status","charged","result_status","error_code","started_at","finished_at","result_expires_at","entry","run_id","source","end_user"],"properties":{"request_id":{"type":"string","format":"uuid"},"capability":{"type":"string"},"status":{"type":"string","enum":["in_progress","settled","released"]},"charged":{"type":["string","null"],"description":"null while in progress."},"result_status":{"type":["string","null"]},"error_code":{"type":["string","null"],"description":"Why a released call delivered nothing."},"started_at":{"type":"string","format":"date-time"},"finished_at":{"type":["string","null"],"format":"date-time"},"result_expires_at":{"type":["string","null"],"format":"date-time","description":"Until when the result can be read again; null when there is none."},"entry":{"type":"string"},"run_id":{"type":["string","null"]},"source":{"type":["string","null"]},"end_user":{"type":["string","null"]}}},"KeyStanding":{"type":"object","description":"What an idempotency key of the account stands for right now. free: nothing answers for it (never used, or what it kept is gone), and a request under it starts a new call. in_progress: its call is still running. settled: its call settled; `charged` says for how much and the saved result is read by `request_id`. failed: its call ended without a charge, for good, and the same request under the key answers the same error. retryable: its call ended without a charge in a way that may be retried, and the same request under the key starts a new call. retry_refused: its last two calls both ended unclear, and a third is refused. Everything but the key and the state is null while the state is free.","required":["idempotency_key","state","request_id","capability","charged","result_status","error_code","result_expires_at"],"properties":{"idempotency_key":{"type":"string"},"state":{"type":"string","enum":["free","in_progress","settled","failed","retryable","retry_refused"]},"request_id":{"type":["string","null"],"format":"uuid","description":"The call the key stands for."},"capability":{"type":["string","null"],"description":"The capability of that call. Whether a request is the one the key was used for is not checked here."},"charged":{"type":["string","null"],"description":"null while in progress."},"result_status":{"type":["string","null"]},"error_code":{"type":["string","null"],"description":"Why a call that ended without a charge delivered nothing."},"result_expires_at":{"type":["string","null"],"format":"date-time","description":"Until when the saved result can be read; null when there is none."}}},"Account":{"type":"object","required":["balance","currency","key","rate"],"properties":{"balance":{"type":"string","description":"US dollars, as a decimal string."},"currency":{"const":"USD"},"key":{"type":["object","null"],"description":"The key the request came with; null for a signed-in person.","required":["id","prefix","name","purpose","scopes","expires_at","budget"],"properties":{"id":{"type":"string"},"prefix":{"type":"string"},"name":{"type":["string","null"]},"purpose":{"type":"string"},"scopes":{"type":["array","null"],"items":{"type":"string"},"description":"The capabilities it may call; null: any."},"expires_at":{"type":["string","null"],"format":"date-time"},"budget":{"type":"object","required":["daily","monthly","total"],"properties":{"daily":{"type":"object","required":["limit","spent","remaining"],"properties":{"limit":{"type":["string","null"]},"spent":{"type":"string","description":"US dollars, as a decimal string."},"remaining":{"type":["string","null"]}}},"monthly":{"type":"object","required":["limit","spent","remaining"],"properties":{"limit":{"type":["string","null"]},"spent":{"type":"string","description":"US dollars, as a decimal string."},"remaining":{"type":["string","null"]}}},"total":{"type":"object","required":["limit","spent","remaining"],"properties":{"limit":{"type":["string","null"]},"spent":{"type":"string","description":"US dollars, as a decimal string."},"remaining":{"type":["string","null"]}}}}}}},"rate":{"type":"object","required":["tier","per_minute","concurrent"],"properties":{"tier":{"type":"string"},"per_minute":{"type":"integer"},"concurrent":{"type":"integer"}}}}},"Usage":{"type":"object","required":["since","until","group_by","rows","total"],"properties":{"since":{"type":"string","format":"date-time"},"until":{"type":["string","null"],"format":"date-time"},"group_by":{"type":"array","items":{"type":"string"}},"rows":{"type":"array","items":{"type":"object","required":["calls","settled","charged"],"properties":{"calls":{"type":"integer"},"settled":{"type":"integer"},"charged":{"type":"string","description":"US dollars, as a decimal string."}},"additionalProperties":{"type":["string","null"]}}},"total":{"type":"object","required":["calls","settled","charged"],"properties":{"calls":{"type":"integer"},"settled":{"type":"integer"},"charged":{"type":"string","description":"US dollars, as a decimal string."}}}}},"Run":{"type":"object","description":"The budget of one run of a task: limits and totals. The steps are the caller's to run, each a call that names the run.","required":["run_id","task_id","task_revision","max_amount","settled","held","remaining_amount","max_calls","calls_used","remaining_calls","expires_at","expired"],"properties":{"run_id":{"type":"string","format":"uuid"},"task_id":{"type":"string"},"task_revision":{"type":"string"},"max_amount":{"type":"string","description":"US dollars, as a decimal string."},"settled":{"type":"string","description":"US dollars, as a decimal string."},"held":{"type":"string","description":"US dollars, as a decimal string."},"remaining_amount":{"type":"string","description":"US dollars, as a decimal string."},"max_calls":{"type":"integer"},"calls_used":{"type":"integer"},"remaining_calls":{"type":"integer"},"expires_at":{"type":"string","format":"date-time"},"expired":{"type":"boolean"}}},"post":{"type":"object","description":"Post.","properties":{"id":{"type":["string","null"],"description":"ID; pass it unchanged to the get endpoint"},"url":{"type":["string","null"],"format":"uri","description":"Link that opens the post"},"type":{"type":["string","null"],"enum":["video","image","text","article",null],"description":"Content format"},"title":{"type":["string","null"],"description":"Title"},"text":{"type":["string","null"],"description":"Body text"},"lang":{"type":["string","null"],"description":"Language of the text (standard view and up)"},"published_at":{"type":["string","null"],"format":"date-time","description":"When it was published"},"author":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"Author's account ID"},"username":{"type":["string","null"],"description":"Author's handle"},"name":{"type":["string","null"],"description":"Author's display name"},"avatar_url":{"type":["string","null"],"format":"uri","description":"Author's avatar (standard view and up)"},"verified":{"type":["boolean","null"],"description":"Whether the author is verified (standard view and up)"},"followers":{"type":["integer","null"],"description":"Author's follower count (standard view and up)"}},"description":"Author"},"metrics":{"type":["object","null"],"properties":{"likes":{"type":["integer","null"],"description":"Likes"},"comments":{"type":["integer","null"],"description":"Comments"},"shares":{"type":["integer","null"],"description":"Shares"},"favorites":{"type":["integer","null"],"description":"Saves"},"views":{"type":["integer","null"],"description":"Views"},"reposts":{"type":["integer","null"],"description":"Reposts"}},"description":"Engagement counts"},"images":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"Image addresses (standard view and up)"},"hashtags":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Hashtags, without the # (standard view and up)"},"mentions":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"Account ID (standard view and up)"},"username":{"type":["string","null"],"description":"Handle (standard view and up)"},"name":{"type":["string","null"],"description":"Display name (standard view and up)"}}},"description":"Accounts mentioned in the text (standard view and up)"},"is_pinned":{"type":["boolean","null"],"description":"Whether the author pinned it (standard view and up)"},"post_id":{"type":["string","null"],"description":"ID of the thread's root post when this is a reply; otherwise null"},"parent_id":{"type":["string","null"],"description":"ID of the item it replies to directly; otherwise null"},"root_id":{"type":["string","null"],"description":"ID of the first-level reply its thread hangs under"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"comment":{"type":"object","description":"Comment.","properties":{"id":{"type":["string","null"],"description":"ID"},"url":{"type":["string","null"],"format":"uri","description":"Link that opens the comment"},"text":{"type":["string","null"],"description":"Text"},"published_at":{"type":["string","null"],"format":"date-time","description":"When it was posted"},"author":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"Commenter's account ID"},"username":{"type":["string","null"],"description":"Commenter's handle"},"name":{"type":["string","null"],"description":"Commenter's display name"},"avatar_url":{"type":["string","null"],"format":"uri","description":"Commenter's avatar (standard view and up)"}},"description":"Commenter"},"metrics":{"type":["object","null"],"properties":{"likes":{"type":["integer","null"],"description":"Likes"},"comments":{"type":["integer","null"],"description":"Replies"}},"description":"Engagement counts"},"post_id":{"type":["string","null"],"description":"ID of the post it is under"},"parent_id":{"type":["string","null"],"description":"ID of the comment it replies to directly; null for a top-level comment"},"root_id":{"type":["string","null"],"description":"ID of the top-level comment of its thread; null for a top-level comment"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"account":{"type":"object","description":"Account.","properties":{"id":{"type":["string","null"],"description":"ID"},"username":{"type":["string","null"],"description":"Handle"},"name":{"type":["string","null"],"description":"Display name"},"url":{"type":["string","null"],"format":"uri","description":"Link to the profile"},"bio":{"type":["string","null"],"description":"Bio"},"avatar_url":{"type":["string","null"],"format":"uri","description":"Avatar (standard view and up)"},"verified":{"type":["boolean","null"],"description":"Whether the account is verified (standard view and up)"},"created_at":{"type":["string","null"],"format":"date-time","description":"When the account was created (standard view and up)"},"metrics":{"type":["object","null"],"properties":{"followers":{"type":["integer","null"],"description":"Followers"},"following":{"type":["integer","null"],"description":"Following"},"posts":{"type":["integer","null"],"description":"Posts published"}},"description":"Account counts"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"trend":{"type":"object","description":"Trend.","properties":{"id":{"type":["string","null"],"description":"The platform's ID for the entry"},"name":{"type":["string","null"],"description":"Name of the entry"},"rank":{"type":["integer","null"],"description":"Position on the board, from 1; a pinned entry has none"},"heat":{"type":["integer","null"],"description":"The platform's heat score"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"transcript":{"type":"object","description":"Transcript.","properties":{"post_id":{"type":["string","null"],"description":"ID of the post it belongs to"},"lang":{"type":["string","null"],"description":"Language code"},"text":{"type":["string","null"],"description":"The whole text"},"segments":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"start":{"type":["number","null"],"description":"Start, in seconds (standard view and up)"},"end":{"type":["number","null"],"description":"End, in seconds (standard view and up)"},"text":{"type":["string","null"],"description":"Text of the segment (standard view and up)"}}},"description":"Timed segments (standard view and up)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"creator_rates":{"type":"object","description":"Creator rates (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"Creator ID"},"currency":{"type":["string","null"],"description":"Currency of the rates"},"rates":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Kind of work, in the platform's words"},"amount":{"type":["string","null"],"description":"The rate; null when this kind has no fixed rate"},"settlement":{"type":["string","null"],"description":"How it is settled, in the platform's words"},"open":{"type":["boolean","null"],"description":"Whether the creator takes this kind of work now"}}},"description":"Rate for each kind of sponsored work"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"community":{"type":"object","description":"Community (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"ID; pass it unchanged to the endpoints that get the community and list its posts"},"name":{"type":["string","null"],"description":"Name of the community"},"url":{"type":["string","null"],"format":"uri","description":"Link that opens the community"},"description":{"type":["string","null"],"description":"What the community says it is about"},"avatar_url":{"type":["string","null"],"format":"uri","description":"The community's icon (standard view and up)"},"nsfw":{"type":["boolean","null"],"description":"Whether it is marked not safe for work (standard view and up)"},"created_at":{"type":["string","null"],"format":"date-time","description":"When the community was created (standard view and up)"},"metrics":{"type":["object","null"],"properties":{"members":{"type":["integer","null"],"description":"Members"}},"description":"Community counts"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"product":{"type":"object","description":"Product (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"ID; pass it unchanged to the endpoints that get the product and list its reviews"},"url":{"type":["string","null"],"format":"uri","description":"Link that opens the product"},"title":{"type":["string","null"],"description":"Title of the product"},"description":{"type":["string","null"],"description":"The text of the product's description (standard view and up)"},"price":{"type":["string","null"],"description":"Current price; the lowest one when its variants are priced differently"},"original_price":{"type":["string","null"],"description":"The price before the discount; null when there is none (standard view and up)"},"currency":{"type":["string","null"],"description":"Currency of the prices, an ISO 4217 code"},"images":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"Addresses of the product's pictures (standard view and up)"},"rating":{"type":["number","null"],"description":"Buyers' rating, out of 5"},"metrics":{"type":["object","null"],"properties":{"sold":{"type":["integer","null"],"description":"Units sold"},"reviews":{"type":["integer","null"],"description":"Reviews"}},"description":"Product counts"},"shop":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"Shop ID"},"name":{"type":["string","null"],"description":"Name of the shop"}},"description":"The shop that sells it"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"review":{"type":"object","description":"Review (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"ID"},"product_id":{"type":["string","null"],"description":"ID of the product it reviews"},"text":{"type":["string","null"],"description":"Text of the review; null when the buyer gave a rating and wrote nothing"},"rating":{"type":["number","null"],"description":"The buyer's rating of the product, out of 5"},"published_at":{"type":["string","null"],"format":"date-time","description":"When it was written"},"author":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"Reviewer's account ID"},"name":{"type":["string","null"],"description":"Reviewer's display name, as the platform shows it (it may be masked)"},"avatar_url":{"type":["string","null"],"format":"uri","description":"Reviewer's avatar (standard view and up)"}},"description":"Reviewer"},"images":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"Addresses of the pictures the buyer attached (standard view and up)"},"variant":{"type":["string","null"],"description":"Which variant was bought, as the platform words it (standard view and up)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"keyword_history":{"type":"object","description":"Keyword index history (preview: may change, announced beforehand).","properties":{"keyword":{"type":["string","null"],"description":"The keyword"},"points":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"date":{"type":["string","null"],"format":"date-time","description":"The day: a calendar day in China time (UTC+8), written as midnight UTC of its date (8 a.m. that day in China); passed back as since or until it asks for that same day"},"search_index":{"type":["integer","null"],"description":"Search index of the day: the platform's index of how much the keyword was searched, not a count of searches"},"composite_index":{"type":["integer","null"],"description":"Composite index of the day: the platform's index of how much attention content about the keyword drew, not a count"},"notes":{"type":["integer","null"],"description":"Posts about the keyword that day (standard view and up)"},"impressions":{"type":["integer","null"],"description":"Times those posts were shown that day (standard view and up)"},"views":{"type":["integer","null"],"description":"Times those posts were read that day (standard view and up)"},"engagements":{"type":["integer","null"],"description":"Engagements with those posts that day (standard view and up)"}}},"description":"The figures day by day, one entry a day, oldest first"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"keyword_related":{"type":"object","description":"Related keyword (preview: may change, announced beforehand).","properties":{"keyword":{"type":["string","null"],"description":"The related keyword"},"related_to":{"type":["string","null"],"description":"The keyword it is related to: the one asked about"},"relation":{"type":["string","null"],"enum":["query","posts","prior","after","suggestion",null],"description":"How it is related: query (searched together with the keyword asked about), posts (appears together with it in content), prior (searched before it), after (searched after it), suggestion (what the platform suggests as the keyword is typed into its search box)"},"rank":{"type":["integer","null"],"description":"Position by relevance among the keywords of the same relation, from 1"},"relevance":{"type":["number","null"],"description":"How closely it is related to the keyword asked about, 0 to 1"},"search_index":{"type":["integer","null"],"description":"Search index of the related keyword: the platform's index, not a count of searches; null where the platform gives no figure for the word"},"composite_index":{"type":["integer","null"],"description":"Composite index of the related keyword: the platform's index of how much attention content about it drew, not a count"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"keyword_audience":{"type":"object","description":"Keyword audience (preview: may change, announced beforehand).","properties":{"keyword":{"type":["string","null"],"description":"The keyword"},"age":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"label":{"type":["string","null"],"description":"Name of the group, in the platform's words"},"share":{"type":["number","null"],"description":"Share of the audience in this group, 0 to 1"},"tgi":{"type":["number","null"],"description":"TGI: how much this group leans to the keyword; 100 is the platform's average, above 100 leans more"}}},"description":"By age group"},"gender":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"label":{"type":["string","null"],"description":"Name of the group, in the platform's words"},"share":{"type":["number","null"],"description":"Share of the audience in this group, 0 to 1"},"tgi":{"type":["number","null"],"description":"TGI: how much this group leans to the keyword; 100 is the platform's average, above 100 leans more"}}},"description":"By gender"},"province":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"label":{"type":["string","null"],"description":"Name of the group, in the platform's words"},"share":{"type":["number","null"],"description":"Share of the audience in this group, 0 to 1"},"tgi":{"type":["number","null"],"description":"TGI: how much this group leans to the keyword; 100 is the platform's average, above 100 leans more"}}},"description":"By province"},"city":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"label":{"type":["string","null"],"description":"Name of the group, in the platform's words"},"share":{"type":["number","null"],"description":"Share of the audience in this group, 0 to 1"},"tgi":{"type":["number","null"],"description":"TGI: how much this group leans to the keyword; 100 is the platform's average, above 100 leans more"}}},"description":"By city: the cities with the largest shares, as the platform lists them; they do not add up to 1"},"city_tier":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"label":{"type":["string","null"],"description":"Name of the group, in the platform's words"},"share":{"type":["number","null"],"description":"Share of the audience in this group, 0 to 1"},"tgi":{"type":["number","null"],"description":"TGI: how much this group leans to the keyword; 100 is the platform's average, above 100 leans more"}}},"description":"By city tier"},"interest":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"label":{"type":["string","null"],"description":"Name of the group, in the platform's words"},"share":{"type":["number","null"],"description":"Share of the audience in this group, 0 to 1"},"tgi":{"type":["number","null"],"description":"TGI: how much this group leans to the keyword; 100 is the platform's average, above 100 leans more"}}},"description":"By interest; the shares do not add up to 1"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"account_history":{"type":"object","description":"Account recent change (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"The account's numeric ID (Douyin's uid): the one the request gave"},"name":{"type":["string","null"],"description":"Display name"},"url":{"type":["string","null"],"format":"uri","description":"Link to the profile; pass it unchanged to the account endpoint"},"avatar_url":{"type":["string","null"],"format":"uri","description":"Avatar (standard view and up)"},"days":{"type":["integer","null"],"description":"How many of the most recent days the figures cover"},"gained":{"type":["object","null"],"properties":{"followers":{"type":["integer","null"],"description":"Net new followers; negative when followers were lost"},"likes":{"type":["integer","null"],"description":"New likes"},"comments":{"type":["integer","null"],"description":"New comments"},"shares":{"type":["integer","null"],"description":"New shares"},"posts":{"type":["integer","null"],"description":"Posts published"}},"description":"What was gained over the period"},"change":{"type":["object","null"],"properties":{"followers":{"type":["number","null"],"description":"Change in net new followers"},"likes":{"type":["number","null"],"description":"Change in new likes"},"comments":{"type":["number","null"],"description":"Change in new comments"},"shares":{"type":["number","null"],"description":"Change in new shares"},"posts":{"type":["number","null"],"description":"Change in posts published"}},"description":"Change against the period of the same length before it, as a ratio: 0.3 is 30% more, -0.5 is half as much"},"totals":{"type":["object","null"],"properties":{"followers":{"type":["integer","null"],"description":"Followers (standard view and up)"},"likes":{"type":["integer","null"],"description":"Likes received in all (standard view and up)"},"posts":{"type":["integer","null"],"description":"Posts (standard view and up)"}},"description":"The account's totals as of now (standard view and up)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"brand_history":{"type":"object","description":"Brand index history (preview: may change, announced beforehand).","properties":{"brand":{"type":["string","null"],"description":"The brand's name"},"category":{"type":["string","null"],"description":"The industry the platform files the brand under, in its words"},"points":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"date":{"type":["string","null"],"format":"date-time","description":"The day: a calendar day in China time (UTC+8), written as midnight UTC of its date (8 a.m. that day in China); passed back as since or until it asks for that same day"},"search_index":{"type":["integer","null"],"description":"Search index: how much the brand was searched, not a count of searches"},"content_index":{"type":["integer","null"],"description":"Content index: how much content about the brand there was, not a count of posts"},"spread_index":{"type":["integer","null"],"description":"Spread index: how far that content travelled, not a count"}}},"description":"The indexes day by day, one entry a day, oldest first"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"brand_metrics":{"type":"object","description":"Brand index averages (preview: may change, announced beforehand).","properties":{"brand":{"type":["string","null"],"description":"The brand's name"},"category":{"type":["string","null"],"description":"The industry the platform files the brand under, in its words"},"search_index":{"type":["integer","null"],"description":"Daily average of the search index over the period"},"content_index":{"type":["integer","null"],"description":"Daily average of the content index over the period"},"spread_index":{"type":["integer","null"],"description":"Daily average of the spread index over the period"},"benchmarks":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"scope":{"type":["string","null"],"enum":["all","top3","top5","top10","top15","top30",null],"description":"Which brands: all of the industry, or its top 3, 5, 10, 15 or 30"},"search_index":{"type":["integer","null"],"description":"Daily average search index of that group"},"content_index":{"type":["integer","null"],"description":"Daily average content index of that group"},"spread_index":{"type":["integer","null"],"description":"Daily average spread index of that group"}}},"description":"What to hold it against: the average of every brand in the industry, and of its leading brands"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"creator":{"type":"object","description":"Creator (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"The creator's ID in the marketplace"},"account_id":{"type":["string","null"],"description":"ID of the creator's account on the platform, as the platform's account endpoints take it"},"username":{"type":["string","null"],"description":"Handle"},"name":{"type":["string","null"],"description":"Display name"},"avatar_url":{"type":["string","null"],"format":"uri","description":"Avatar (standard view and up)"},"location":{"type":["string","null"],"description":"Where the creator is based, in the platform's words (standard view and up)"},"categories":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Content categories, first level, in the platform's words"},"subcategories":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Content categories, second level, in the platform's words (standard view and up)"},"metrics":{"type":["object","null"],"properties":{"followers":{"type":["integer","null"],"description":"Followers"}},"description":"Creator counts"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"audience":{"type":"object","description":"Audience (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"Creator ID"},"measured_at":{"type":["string","null"],"format":"date-time","description":"The day the figures are of, given as the start of that day in China time"},"gender":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By gender"},"age":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By age group"},"province":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By province"},"city":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By city, the largest only"},"interest":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By interest"},"device":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By phone brand"},"city_tier":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By city tier"},"crowd":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By the consumer groups the platform sorts people into"},"purchase_category":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By the category of goods bought"},"purchase_amount":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the segment, in the platform's words (the two genders come in lower-case English)"},"share":{"type":["number","null"],"description":"The segment's share of the segments listed, 0 to 1"},"count":{"type":["integer","null"],"description":"Followers in the segment"}}},"description":"By the amount spent on an order"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"xingtu_creator_metrics":{"type":"object","description":"Xingtu creator metrics (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"Xingtu creator ID"},"videos":{"type":["integer","null"],"description":"Videos in the period"},"median_views":{"type":["integer","null"],"description":"Median views of a video"},"average_likes":{"type":["integer","null"],"description":"Average likes of a video"},"average_comments":{"type":["integer","null"],"description":"Average comments of a video"},"average_shares":{"type":["integer","null"],"description":"Average shares of a video"},"engagement_rate":{"type":["number","null"],"description":"Engagement rate, 0 to 1"},"engagement_rate_percentile":{"type":["number","null"],"description":"Share of comparable creators whose engagement rate it exceeds, 0 to 1 (standard view and up)"},"completion_rate":{"type":["number","null"],"description":"Completion rate, 0 to 1"},"completion_rate_percentile":{"type":["number","null"],"description":"Share of comparable creators whose completion rate it exceeds, 0 to 1 (standard view and up)"},"currency":{"type":["string","null"],"description":"Currency of the amounts below"},"cpm_integrated":{"type":["string","null"],"description":"Expected cost per thousand views of an integrated video (植入视频)"},"cpm_custom":{"type":["string","null"],"description":"Expected cost per thousand views of a custom video (定制视频)"},"cpe_integrated":{"type":["string","null"],"description":"Expected cost per interaction of an integrated video (植入视频)"},"cpe_custom":{"type":["string","null"],"description":"Expected cost per interaction of a custom video (定制视频)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"xingtu_creator_post":{"type":"object","description":"Xingtu creator video (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"Video ID, the one the Douyin video endpoints take"},"url":{"type":["string","null"],"format":"uri","description":"Link to the video"},"title":{"type":["string","null"],"description":"The video's caption"},"published_at":{"type":["string","null"],"format":"date-time","description":"When it was published"},"duration":{"type":["number","null"],"description":"Length of the video, in seconds (standard view and up)"},"metrics":{"type":["object","null"],"properties":{"views":{"type":["integer","null"],"description":"Views"},"likes":{"type":["integer","null"],"description":"Likes"},"comments":{"type":["integer","null"],"description":"Comments"},"completion_rate":{"type":["number","null"],"description":"Completion rate, 0 to 1"},"engagement_rate":{"type":["number","null"],"description":"Engagement rate, 0 to 1"}},"description":"The video's figures"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"pgy_creator_metrics":{"type":"object","description":"PGY creator metrics (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"PGY creator ID"},"notes":{"type":["integer","null"],"description":"Notes in the period"},"median_impressions":{"type":["integer","null"],"description":"Median impressions of a note"},"median_reads":{"type":["integer","null"],"description":"Median reads of a note"},"median_engagements":{"type":["integer","null"],"description":"Median interactions of a note"},"median_likes":{"type":["integer","null"],"description":"Median likes of a note (standard view and up)"},"median_favorites":{"type":["integer","null"],"description":"Median saves of a note (standard view and up)"},"median_comments":{"type":["integer","null"],"description":"Median comments of a note (standard view and up)"},"median_shares":{"type":["integer","null"],"description":"Median shares of a note (standard view and up)"},"engagement_rate":{"type":["number","null"],"description":"Engagement rate, 0 to 1"},"video_completion_rate":{"type":["number","null"],"description":"Completion rate of video notes, 0 to 1 (standard view and up)"},"image_3s_read_rate":{"type":["number","null"],"description":"Share of image-note reads that last 3 seconds, 0 to 1 (standard view and up)"},"hundred_like_share":{"type":["number","null"],"description":"Share of notes with 100 likes or more, 0 to 1 (standard view and up)"},"thousand_like_share":{"type":["number","null"],"description":"Share of notes with 1,000 likes or more, 0 to 1 (standard view and up)"},"impressions_percentile":{"type":["number","null"],"description":"Share of comparable creators whose median impressions it exceeds, 0 to 1 (standard view and up)"},"reads_percentile":{"type":["number","null"],"description":"Share of comparable creators whose median reads it exceeds, 0 to 1 (standard view and up)"},"engagements_percentile":{"type":["number","null"],"description":"Share of comparable creators whose median interactions it exceeds, 0 to 1 (standard view and up)"},"video_notes":{"type":["integer","null"],"description":"Video notes in the period (counted in notes too) (standard view and up)"},"video_completion_percentile":{"type":["number","null"],"description":"Share of comparable creators whose video completion rate it exceeds, 0 to 1 (standard view and up)"},"median_follows":{"type":["integer","null"],"description":"Median follows a note brought (new followers gained from it) (standard view and up)"},"traffic_sources":{"type":["object","null"],"properties":{"impressions":{"type":["object","null"],"properties":{"homefeed":{"type":["number","null"],"description":"Share of the impressions from the explore feed, 0 to 1 (standard view and up)"},"search":{"type":["number","null"],"description":"Share of the impressions from search, 0 to 1 (standard view and up)"},"follow":{"type":["number","null"],"description":"Share of the impressions from the following feed, 0 to 1 (standard view and up)"},"detail":{"type":["number","null"],"description":"Share of the impressions from note detail pages, 0 to 1 (standard view and up)"},"nearby":{"type":["number","null"],"description":"Share of the impressions from the nearby feed, 0 to 1 (standard view and up)"},"other":{"type":["number","null"],"description":"Share of the impressions from anywhere else, 0 to 1 (standard view and up)"}},"description":"Shares of the impressions (standard view and up)"},"reads":{"type":["object","null"],"properties":{"homefeed":{"type":["number","null"],"description":"Share of the reads from the explore feed, 0 to 1 (standard view and up)"},"search":{"type":["number","null"],"description":"Share of the reads from search, 0 to 1 (standard view and up)"},"follow":{"type":["number","null"],"description":"Share of the reads from the following feed, 0 to 1 (standard view and up)"},"detail":{"type":["number","null"],"description":"Share of the reads from note detail pages, 0 to 1 (standard view and up)"},"nearby":{"type":["number","null"],"description":"Share of the reads from the nearby feed, 0 to 1 (standard view and up)"},"other":{"type":["number","null"],"description":"Share of the reads from anywhere else, 0 to 1 (standard view and up)"}},"description":"Shares of the reads (standard view and up)"}},"description":"Where the period's notes got their traffic: the share of impressions and of reads from each entry point (PGY's traffic sources); each set adds up to 1 (standard view and up)"},"long_term":{"type":["object","null"],"properties":{"published_from":{"type":["string","null"],"format":"date-time","description":"First publication day of these notes: a calendar day in China time (UTC+8), written as midnight UTC of its date (full view)"},"published_to":{"type":["string","null"],"format":"date-time","description":"Last publication day of these notes, written the same way (full view)"},"notes":{"type":["integer","null"],"description":"Notes published in that span; with 0, everything below is null (full view)"},"recent_reads":{"type":["integer","null"],"description":"Recent reads: a figure of one note, the platform's representative value (of the same order as this endpoint's median reads; the platform does not say whether it is a median or a mean) (full view)"},"recent_reads_percentile":{"type":["number","null"],"description":"Share of comparable creators whose recent reads it exceeds, 0 to 1 (full view)"},"long_term_reads":{"type":["integer","null"],"description":"Long-term reads: a figure of one note, as recent reads (full view)"},"long_term_reads_percentile":{"type":["number","null"],"description":"Share of comparable creators whose long-term reads it exceeds, 0 to 1 (full view)"},"recent_sources":{"type":["object","null"],"properties":{"homefeed":{"type":["number","null"],"description":"Share of the recent reads from the explore feed, 0 to 1 (full view)"},"search":{"type":["number","null"],"description":"Share of the recent reads from search, 0 to 1 (full view)"},"profile":{"type":["number","null"],"description":"Share of the recent reads from the creator's profile page, 0 to 1 (full view)"},"follow":{"type":["number","null"],"description":"Share of the recent reads from the following feed, 0 to 1 (full view)"},"other":{"type":["number","null"],"description":"Share of the recent reads from anywhere else, 0 to 1 (full view)"}},"description":"Where the recent reads came from, shares adding up to 1 (full view)"},"long_term_sources":{"type":["object","null"],"properties":{"homefeed":{"type":["number","null"],"description":"Share of the long-term reads from the explore feed, 0 to 1 (full view)"},"search":{"type":["number","null"],"description":"Share of the long-term reads from search, 0 to 1 (full view)"},"profile":{"type":["number","null"],"description":"Share of the long-term reads from the creator's profile page, 0 to 1 (full view)"},"follow":{"type":["number","null"],"description":"Share of the long-term reads from the following feed, 0 to 1 (full view)"},"other":{"type":["number","null"],"description":"Share of the long-term reads from anywhere else, 0 to 1 (full view)"}},"description":"Where the long-term reads came from, shares adding up to 1 (full view)"}},"description":"Long-term performance (PGY's long-term notes): the notes published in a two-month span about half a year back, whose reads the platform splits into a \"recent\" part after publication and a \"long-term\" part after that, each with reads, the standing among peers and where the reads came from. Of the everyday notes with tab=everyday, of the sponsored ones with tab=sponsored. The platform does not say where the two parts divide (full view)"},"note_list":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"Note ID (full view)"},"title":{"type":["string","null"],"description":"The note's title (full view)"},"type":{"type":["string","null"],"enum":["image","video",null],"description":"An image note or a video note (full view)"},"published_at":{"type":["string","null"],"format":"date-time","description":"The day it was published; the platform gives the day only, given as the start of that day in China time (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Address of the cover image (full view)"},"impressions":{"type":["integer","null"],"description":"Impressions (full view)"},"reads":{"type":["integer","null"],"description":"Reads (full view)"},"engagements":{"type":["integer","null"],"description":"Interactions (full view)"},"likes":{"type":["integer","null"],"description":"Likes (full view)"},"favorites":{"type":["integer","null"],"description":"Saves (full view)"},"impressions_vs_median":{"type":["number","null"],"description":"How far the note's impressions are above the creator's median impressions of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view)"},"reads_vs_median":{"type":["number","null"],"description":"How far the note's reads are above the creator's median reads of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view)"},"engagements_vs_median":{"type":["number","null"],"description":"How far the note's interactions are above the creator's median interactions of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view)"},"likes_vs_median":{"type":["number","null"],"description":"How far the note's likes are above the creator's median likes of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view)"},"favorites_vs_median":{"type":["number","null"],"description":"How far the note's saves are above the creator's median saves of the period: 1.5 is 150% more, -0.3 is 30% fewer, 0 is the median itself (full view)"}}},"description":"The period's notes one by one, oldest first; 15 at most (recorded: 15 given of 34 in the period); null when the period has no note (full view)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"pgy_creator_post":{"type":"object","description":"PGY creator note (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"Note ID"},"title":{"type":["string","null"],"description":"The note's title"},"type":{"type":["string","null"],"enum":["image","video",null],"description":"An image note or a video note"},"published_at":{"type":["string","null"],"format":"date-time","description":"The day it was published; the platform gives the day only, given as the start of that day in China time"},"cover_url":{"type":["string","null"],"format":"uri","description":"Address of the cover image (standard view and up)"},"is_sponsored":{"type":["boolean","null"],"description":"Whether it is a sponsored note: one with a brand it was made for (brand)"},"brand":{"type":["string","null"],"description":"The brand it was made for, in the platform's words; null when it is not sponsored"},"is_promoted":{"type":["boolean","null"],"description":"Whether paid promotion has sent traffic to the note (PGY marks it 含推广流量, \"includes promoted traffic\"). It is not whether the note is sponsored: a sponsored note may have none, an everyday note may have some"},"metrics":{"type":["object","null"],"properties":{"views":{"type":["integer","null"],"description":"Reads"},"likes":{"type":["integer","null"],"description":"Likes"},"favorites":{"type":["integer","null"],"description":"Saves"},"shop_visits":{"type":["integer","null"],"description":"Shop visitors the note brought (PGY's spillover store visits); only cross-domain sponsored notes have any, others give 0 (standard view and up)"}},"description":"The note's figures"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"pgy_note":{"type":"object","description":"PGY note detail (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"Note ID"},"url":{"type":["string","null"],"format":"uri","description":"Link to the note, with the access token the platform gives, so it opens as it is"},"type":{"type":["string","null"],"enum":["image","video",null],"description":"An image note or a video note"},"title":{"type":["string","null"],"description":"The note's title"},"text":{"type":["string","null"],"description":"The note's text (standard view and up)"},"published_at":{"type":["string","null"],"format":"date-time","description":"When it was published"},"images":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"Addresses of the pictures, in the note's order (standard view and up)"},"creator_id":{"type":["string","null"],"description":"The creator's PGY creator ID, as the other PGY creator endpoints take it"},"creator_name":{"type":["string","null"],"description":"The creator's name"},"brand":{"type":["string","null"],"description":"The brand the note was reported as sponsored by, in the platform's words; null when it is no reported sponsored note"},"brand_id":{"type":["string","null"],"description":"The Xiaohongshu account ID of that brand; null when there is none (standard view and up)"},"metrics":{"type":["object","null"],"properties":{"impressions":{"type":["integer","null"],"description":"Impressions"},"views":{"type":["integer","null"],"description":"Reads"},"likes":{"type":["integer","null"],"description":"Likes"},"favorites":{"type":["integer","null"],"description":"Saves"},"comments":{"type":["integer","null"],"description":"Comments"},"shares":{"type":["integer","null"],"description":"Shares"},"follows":{"type":["integer","null"],"description":"Follows the note brought (new followers gained from it)"}},"description":"The figures PGY gives for the note"},"component_clicks":{"type":["object","null"],"properties":{"comment_area":{"type":["string","null"],"enum":["normal","high","very_high",null],"description":"Click-through band of the comment-area component: normal (0-2%), high (2-10%) or very_high (over 10%), as PGY grades it; null when the note carries no such component (standard view and up)"},"content":{"type":["string","null"],"enum":["normal","high","very_high",null],"description":"Click-through band of the in-text component: normal (0-2%), high (2-10%) or very_high (over 10%), as PGY grades it; null when the note carries no such component (standard view and up)"},"note_bottom":{"type":["string","null"],"enum":["normal","high","very_high",null],"description":"Click-through band of the component at the bottom of the note: normal (0-2%), high (2-10%) or very_high (over 10%), as PGY grades it; null when the note carries no such component (standard view and up)"}},"description":"The click-through band of each component the brand put in the note (PGY's component clicks); null when the note has no such figures (standard view and up)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"ad":{"type":"object","description":"Ad (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"ID; pass it unchanged to the ad's get endpoint"},"url":{"type":["string","null"],"format":"uri","description":"The ad's page in the platform's ad library"},"format":{"type":["string","null"],"enum":["video","image","carousel","text","other",null],"description":"Format of the creative; other is a format of the platform's own"},"title":{"type":["string","null"],"description":"Headline"},"text":{"type":["string","null"],"description":"Body text"},"landing_url":{"type":["string","null"],"format":"uri","description":"Where a click on the ad leads (standard view and up)"},"advertiser":{"type":["object","null"],"properties":{"id":{"type":["string","null"],"description":"Advertiser ID"},"name":{"type":["string","null"],"description":"Advertiser's name"},"url":{"type":["string","null"],"format":"uri","description":"The advertiser's page on the platform (standard view and up)"},"avatar_url":{"type":["string","null"],"format":"uri","description":"The advertiser's picture or logo (standard view and up)"}},"description":"Advertiser"},"images":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"Addresses of the ad's images (standard view and up)"},"videos":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"Addresses of the ad's videos; they expire (full view)"},"first_shown_at":{"type":["string","null"],"format":"date-time","description":"When the ad was first shown"},"last_shown_at":{"type":["string","null"],"format":"date-time","description":"When the ad was last shown; for an ad still running, when the platform last saw it"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"advertiser":{"type":"object","description":"Advertiser (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"ID; pass it unchanged to the advertiser's ads endpoint"},"name":{"type":["string","null"],"description":"Name"},"avatar_url":{"type":["string","null"],"format":"uri","description":"Picture or logo (standard view and up)"},"region":{"type":["string","null"],"description":"Code of the country or region the advertiser is registered in"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"index_creator_metrics":{"type":"object","description":"Douyin trend-index creator metrics (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"The account's numeric ID (Douyin's uid): the one the request gave"},"average_7d":{"type":["object","null"],"properties":{"likes":{"type":["number","null"],"description":"New likes a day, on average over the last week"},"follows":{"type":["number","null"],"description":"Follows a day, on average over the last week, as the platform counts them: not the net gain in followers: the same platform's like figure comes to 2 to 10 times the net daily gain, and is above 0 for an account that lost followers. The platform does not say how it is counted: use it for trends and to compare accounts, not as a net gain"},"shares":{"type":["number","null"],"description":"New shares a day, on average over the last week"},"comments":{"type":["number","null"],"description":"New comments a day, on average over the last week"}},"description":"Daily averages over the last week"},"average_30d":{"type":["object","null"],"properties":{"likes":{"type":["number","null"],"description":"New likes a day, on average over the last month"},"follows":{"type":["number","null"],"description":"Follows a day, on average over the last month, as the platform counts them; as above, not the net gain in followers"},"shares":{"type":["number","null"],"description":"New shares a day, on average over the last month"},"comments":{"type":["number","null"],"description":"New comments a day, on average over the last month"}},"description":"Daily averages over the last month"},"change_7d":{"type":["object","null"],"properties":{"likes":{"type":["number","null"],"description":"Change in new likes a day"},"follows":{"type":["number","null"],"description":"Change in follows a day (as the platform counts them, not the net gain)"},"shares":{"type":["number","null"],"description":"Change in new shares a day"},"comments":{"type":["number","null"],"description":"Change in new comments a day"}},"description":"The last week's daily averages against the week before, as a ratio: 0.3 is 30% more, -0.5 is half as much"},"change_30d":{"type":["object","null"],"properties":{"likes":{"type":["number","null"],"description":"Change in new likes a day"},"follows":{"type":["number","null"],"description":"Change in follows a day (as the platform counts them, not the net gain)"},"shares":{"type":["number","null"],"description":"Change in new shares a day"},"comments":{"type":["number","null"],"description":"Change in new comments a day"}},"description":"The last month's daily averages against the month before, written the same way"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"xingtu_creator_keywords":{"type":"object","description":"Xingtu creator content keywords (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"Xingtu creator ID"},"keywords":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"keyword":{"type":["string","null"],"description":"The keyword"},"mentions":{"type":["integer","null"],"description":"How many times the marketplace counted the word; the counts are small and good for ordering only"}}},"description":"The keywords, one entry each"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"xingtu_creator_scores":{"type":"object","description":"Xingtu creator scores (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"Xingtu creator ID"},"overall":{"type":["object","null"],"properties":{"score":{"type":["number","null"],"description":"The score, 0 to 100"},"average":{"type":["number","null"],"description":"Average of comparable creators on this score"},"rank":{"type":["integer","null"],"description":"Rank on this score, 1 being the highest"},"rank_share":{"type":["number","null"],"description":"How far from the top the rank is, 0 to 1: 0.05 is the top 5%. Given to four decimals, so a rank in about the top hundred reads 0"}},"description":"The overall Xingtu score"},"reach":{"type":["object","null"],"properties":{"score":{"type":["number","null"],"description":"The score, 0 to 100"},"average":{"type":["number","null"],"description":"Average of comparable creators on this score"},"rank":{"type":["integer","null"],"description":"Rank on this score, 1 being the highest"},"rank_share":{"type":["number","null"],"description":"How far from the top the rank is, 0 to 1: 0.05 is the top 5%. Given to four decimals, so a rank in about the top hundred reads 0"}},"description":"Reach score"},"seeding":{"type":["object","null"],"properties":{"score":{"type":["number","null"],"description":"The score, 0 to 100"},"average":{"type":["number","null"],"description":"Average of comparable creators on this score"},"rank":{"type":["integer","null"],"description":"Rank on this score, 1 being the highest"},"rank_share":{"type":["number","null"],"description":"How far from the top the rank is, 0 to 1: 0.05 is the top 5%. Given to four decimals, so a rank in about the top hundred reads 0"}},"description":"Seeding score: how well the creator's videos raise interest in products"},"conversion":{"type":["object","null"],"properties":{"score":{"type":["number","null"],"description":"The score, 0 to 100"},"average":{"type":["number","null"],"description":"Average of comparable creators on this score"},"rank":{"type":["integer","null"],"description":"Rank on this score, 1 being the highest"},"rank_share":{"type":["number","null"],"description":"How far from the top the rank is, 0 to 1: 0.05 is the top 5%. Given to four decimals, so a rank in about the top hundred reads 0"}},"description":"Conversion score"},"cooperation":{"type":["object","null"],"properties":{"score":{"type":["number","null"],"description":"The score, 0 to 100"},"average":{"type":["number","null"],"description":"Average of comparable creators on this score"},"rank":{"type":["integer","null"],"description":"Rank on this score, 1 being the highest"},"rank_share":{"type":["number","null"],"description":"How far from the top the rank is, 0 to 1: 0.05 is the top 5%. Given to four decimals, so a rank in about the top hundred reads 0"}},"description":"Cooperation score"},"value_for_money":{"type":["object","null"],"properties":{"score":{"type":["number","null"],"description":"The score, 0 to 100"},"average":{"type":["number","null"],"description":"Average of comparable creators on this score"},"rank":{"type":["integer","null"],"description":"Rank on this score, 1 being the highest"},"rank_share":{"type":["number","null"],"description":"How far from the top the rank is, 0 to 1: 0.05 is the top 5%. Given to four decimals, so a rank in about the top hundred reads 0"}},"description":"Value-for-money score"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"xingtu_creator_content_mix":{"type":"object","description":"Xingtu creator content mix (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"Xingtu creator ID"},"categories":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the category, in the platform's words"},"share":{"type":["number","null"],"description":"The category's share of the videos counted, 0 to 1"},"videos":{"type":["integer","null"],"description":"Videos in the category"}}},"description":"The content categories, one entry each"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"xingtu_creator_conversion":{"type":"object","description":"Xingtu creator conversion (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"Xingtu creator ID"},"videos":{"type":["integer","null"],"description":"Videos counted: the ones that carry products"},"median_views":{"type":["integer","null"],"description":"Median views of those videos"},"products":{"type":["integer","null"],"description":"Products recommended"},"currency":{"type":["string","null"],"description":"Currency of the money bands below"},"sales_range":{"type":["string","null"],"description":"Band of the average sales of a video, in the platform's words"},"gpm_range":{"type":["string","null"],"description":"Band of the sales per thousand views (GPM), in the platform's words"},"product_price_range":{"type":["string","null"],"description":"Band of the prices of the products recommended, in the platform's words"},"click_cost_range":{"type":["string","null"],"description":"Band of the cost per click (CPC), in the platform's words"},"clicks_range":{"type":["string","null"],"description":"Band of the clicks on the product link shown in a video, in the platform's words"},"click_rate_range":{"type":["string","null"],"description":"Band of the click rate of that product link, in the platform's words"},"categories":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"Name of the category, in the platform's words"},"share":{"type":["number","null"],"description":"The category's share, 0 to 1"},"sales_range":{"type":["string","null"],"description":"Band of the category's sales, in the platform's words"}}},"description":"The categories of goods sold, one entry each"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"xingtu_campaign":{"type":"object","description":"Xingtu campaign (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"Campaign ID"},"name":{"type":["string","null"],"description":"Name of the campaign"},"description":{"type":["string","null"],"description":"What the campaign is"},"category":{"type":["string","null"],"enum":["platform_event","ecommerce","seasonal","creative","industry",null],"description":"Kind of campaign: a platform event, an e-commerce moment, a seasonal or mood moment, creative marketing, an industry campaign"},"stage":{"type":["string","null"],"enum":["preparing","open","live","ended",null],"description":"How far along the campaign is: being prepared, open for sign-up, live, ended"},"signup_starts_at":{"type":["string","null"],"format":"date-time","description":"When sign-up opens"},"signup_ends_at":{"type":["string","null"],"format":"date-time","description":"When sign-up closes"},"starts_at":{"type":["string","null"],"format":"date-time","description":"When the campaign starts"},"ends_at":{"type":["string","null"],"format":"date-time","description":"When the campaign ends"},"image_url":{"type":["string","null"],"format":"uri","description":"The campaign's main image (standard view and up)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"channels_collection":{"type":"object","description":"Channels collection (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"The collection's ID; pass it unchanged to the endpoint that lists its videos"},"name":{"type":["string","null"],"description":"Name of the collection"},"description":{"type":["string","null"],"description":"What the collection says it is about; null when it says nothing"},"cover_url":{"type":["string","null"],"format":"uri","description":"Address of the collection's cover image (standard view and up)"},"updated_at":{"type":["string","null"],"format":"date-time","description":"When the collection was last updated"},"metrics":{"type":["object","null"],"properties":{"videos":{"type":["integer","null"],"description":"Videos in the collection"}},"description":"Collection counts"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"channels_share_link":{"type":"object","description":"Channels share link (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"The video's ID"},"url":{"type":["string","null"],"format":"uri","description":"Share link that opens the video in WeChat"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"topic":{"type":"object","description":"Topic (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"ID; pass it unchanged to the endpoints that get the topic and list the posts under it"},"name":{"type":["string","null"],"description":"Name of the topic"},"url":{"type":["string","null"],"format":"uri","description":"Link that opens the topic"},"description":{"type":["string","null"],"description":"What the topic says it is about; null when it says nothing"},"metrics":{"type":["object","null"],"properties":{"views":{"type":["integer","null"],"description":"Views of the topic"},"posts":{"type":["integer","null"],"description":"Posts under the topic"}},"description":"Topic counts"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"account_owner":{"type":"object","description":"Account owner (preview: may change, announced beforehand).","properties":{"name":{"type":["string","null"],"description":"The owner's name: the full name of a company or body, or a person's name for a personal owner"},"type":{"type":["string","null"],"enum":["company","government","media","individual","other",null],"description":"What the owner is: company, government, media, individual, or other (another kind of organisation)"},"registration_id":{"type":["string","null"],"description":"The number the owner is registered under (unified social credit code, business licence or organisation code); null where the platform gives none"},"country":{"type":["string","null"],"description":"The owner's country or region, in the platform's words (standard view and up)"},"verification":{"type":["string","null"],"enum":["verified","unverified","expired",null],"description":"The account's verification: verified (a personal verification included), unverified, or expired"},"verification_type":{"type":["string","null"],"description":"The kind of verification, in the platform's words (such as 企业认证, company verification); null when not verified (standard view and up)"},"verified_at":{"type":["string","null"],"format":"date-time","description":"The date the verification was granted, written as midnight UTC of that date (standard view and up)"},"account_id":{"type":["string","null"],"description":"ID of the account asked about: this is its owner"},"account_created_at":{"type":["string","null"],"format":"date-time","description":"The date the account asked about was registered, written as midnight UTC of that date (standard view and up)"},"authorized_services":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Third-party services the account asked about has authorised, in the platform's words (company names) (full view)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"miniprogram":{"type":"object","description":"Mini program (preview: may change, announced beforehand).","properties":{"id":{"type":["string","null"],"description":"Original ID (starting with gh_)"},"app_id":{"type":["string","null"],"description":"AppID (starting with wx), used to open or link to the mini program; null where the platform gives none"},"name":{"type":["string","null"],"description":"Name"},"description":{"type":["string","null"],"description":"Description"},"icon_url":{"type":["string","null"],"format":"uri","description":"Icon (standard view and up)"},"owner_name":{"type":["string","null"],"description":"The owner's name: the company or body that runs it"},"owner_verified":{"type":["boolean","null"],"description":"Whether the owner is verified (standard view and up)"},"recent_users":{"type":["integer","null"],"description":"How many people used it lately, as the platform shows it; one shown like 1万+ is a lower bound; null where it shows none (standard view and up)"},"is_game":{"type":["boolean","null"],"description":"Whether it is a mini game (standard view and up)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"follower_history":{"type":"object","description":"Follower history (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"The creator ID: the one the request gave"},"days":{"type":["integer","null"],"description":"How many of the most recent days the figures cover"},"gained":{"type":["integer","null"],"description":"Net followers gained over the period; negative when followers were lost"},"growth":{"type":["number","null"],"description":"The net gain as a share of the followers at the start: 0.01 is 1% more"},"points":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"date":{"type":["string","null"],"format":"date-time","description":"The day: a calendar day in China time (UTC+8), written as midnight UTC of its date"},"followers":{"type":["integer","null"],"description":"Followers that day"}}},"description":"The follower count day by day, one entry a day, oldest first"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"pgy_creator_costs":{"type":"object","description":"PGY creator costs and summary (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"PGY creator ID"},"date":{"type":["string","null"],"format":"date-time","description":"The day the figures are of: a calendar day in China time (UTC+8), written as midnight UTC of its date"},"currency":{"type":["string","null"],"description":"Currency of the costs below"},"image_cpm":{"type":["string","null"],"description":"Estimated CPM of an image note (cost of a thousand impressions), in yuan; null where PGY has no estimate"},"image_cpm_percentile":{"type":["number","null"],"description":"Share of comparable creators whose image-note CPM is higher (PGY's \"better than peers\"), 0 to 1 (standard view and up)"},"video_cpm":{"type":["string","null"],"description":"Estimated CPM of a video note (cost of a thousand impressions), in yuan; null where PGY has no estimate"},"video_cpm_percentile":{"type":["number","null"],"description":"Share of comparable creators whose video-note CPM is higher (PGY's \"better than peers\"), 0 to 1 (standard view and up)"},"image_cpe":{"type":["string","null"],"description":"Estimated cost per interaction of an image note, in yuan; null where PGY has no estimate"},"image_cpe_percentile":{"type":["number","null"],"description":"Share of comparable creators whose image-note cost per interaction is higher (PGY's \"better than peers\"), 0 to 1 (standard view and up)"},"video_cpe":{"type":["string","null"],"description":"Estimated cost per interaction of a video note, in yuan; null where PGY has no estimate"},"video_cpe_percentile":{"type":["number","null"],"description":"Share of comparable creators whose video-note cost per interaction is higher (PGY's \"better than peers\"), 0 to 1 (standard view and up)"},"image_read_cost":{"type":["string","null"],"description":"Estimated cost per read of an image note, in yuan; null where PGY has no estimate"},"image_read_cost_percentile":{"type":["number","null"],"description":"Share of comparable creators whose image-note cost per read is higher (PGY's \"better than peers\"), 0 to 1 (standard view and up)"},"video_read_cost":{"type":["string","null"],"description":"Estimated cost per read of a video note, in yuan; null where PGY has no estimate"},"video_read_cost_percentile":{"type":["number","null"],"description":"Share of comparable creators whose video-note cost per read is higher (PGY's \"better than peers\"), 0 to 1 (standard view and up)"},"image_shop_visit_cost":{"type":["string","null"],"description":"Estimated cost per shop visitor an image note brings (PGY's spillover store visits), in yuan; null where PGY has no estimate"},"image_shop_visit_cost_percentile":{"type":["number","null"],"description":"Share of comparable creators whose image-note cost per shop visitor is higher (PGY's \"better than peers\"), 0 to 1 (standard view and up)"},"video_shop_visit_cost":{"type":["string","null"],"description":"Estimated cost per shop visitor a video note brings (PGY's spillover store visits), in yuan; null where PGY has no estimate"},"video_shop_visit_cost_percentile":{"type":["number","null"],"description":"Share of comparable creators whose video-note cost per shop visitor is higher (PGY's \"better than peers\"), 0 to 1 (standard view and up)"},"median_impressions":{"type":["integer","null"],"description":"Median impressions of a note"},"median_impressions_percentile":{"type":["number","null"],"description":"Share of comparable creators whose median impressions it exceeds, 0 to 1 (standard view and up)"},"median_reads":{"type":["integer","null"],"description":"Median reads of a note"},"median_reads_percentile":{"type":["number","null"],"description":"Share of comparable creators whose median reads it exceeds, 0 to 1 (standard view and up)"},"median_engagements":{"type":["integer","null"],"description":"Median interactions of a note"},"median_engagements_percentile":{"type":["number","null"],"description":"Share of comparable creators whose median interactions it exceeds, 0 to 1 (standard view and up)"},"median_shop_visits":{"type":["integer","null"],"description":"Median shop visitors a note brings"},"median_shop_visits_percentile":{"type":["number","null"],"description":"Share of comparable creators whose median shop visitors it exceeds, 0 to 1 (standard view and up)"},"follower_growth":{"type":["number","null"],"description":"Follower growth over the last 30 days: 0.037 is 3.7% more; negative when followers were lost (standard view and up)"},"follower_growth_percentile":{"type":["number","null"],"description":"Share of comparable creators whose follower growth it exceeds, 0 to 1 (standard view and up)"},"invite_reply_rate":{"type":["number","null"],"description":"Share of collaboration invitations answered within 48 hours, 0 to 1 (standard view and up)"},"easy_to_reach":{"type":["boolean","null"],"description":"Whether PGY marks the creator \"easy to reach\" (好联系, the mark beside the invitation reply rate on the page) (standard view and up)"},"active_days_7d":{"type":["integer","null"],"description":"Days active in the last 7 (standard view and up)"},"is_active":{"type":["boolean","null"],"description":"Whether PGY marks the creator \"active\" (活跃, the mark beside the active days of the last 7 on the page) (standard view and up)"},"notes_30d":{"type":["integer","null"],"description":"Notes published in the last 30 days, everyday and sponsored alike (the page's \"notes published\"); the same in either tab (standard view and up)"},"highlight":{"type":["string","null"],"description":"The strength PGY marks the creator with, in its words (a title for a kind of creator); null when none (standard view and up)"},"highlight_reason":{"type":["string","null"],"description":"PGY's explanation of that strength, in its words (such as which figure ranks in what top share of peers) (standard view and up)"},"content_mix":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"category":{"type":["string","null"],"description":"The content category, in the platform's words (standard view and up)"},"share":{"type":["number","null"],"description":"The share, 0 to 1 (standard view and up)"}}},"description":"The share of the creator's notes in each content category, largest first (standard view and up)"},"industries":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Industries the creator has worked with, in the platform's words (standard view and up)"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"pgy_creator_followers":{"type":"object","description":"PGY creator follower summary (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"PGY creator ID"},"followers":{"type":["integer","null"],"description":"Followers"},"gained":{"type":["integer","null"],"description":"Net followers gained over the last 30 days; negative when followers were lost"},"growth":{"type":["number","null"],"description":"Follower growth over the last 30 days: 0.008 is 0.8% more; negative when followers were lost"},"growth_percentile":{"type":["number","null"],"description":"Share of comparable creators whose follower growth it exceeds, 0 to 1 (standard view and up)"},"active_followers":{"type":["integer","null"],"description":"Active followers: followers active on Xiaohongshu in the last 28 days"},"active_share":{"type":["number","null"],"description":"Active followers as a share of all followers, 0 to 1"},"active_percentile":{"type":["number","null"],"description":"Share of comparable creators whose share of active followers it exceeds, 0 to 1 (standard view and up)"},"engaged_followers":{"type":["integer","null"],"description":"Engaged followers: followers who interacted with the creator's notes in the last 30 days"},"engaged_share":{"type":["number","null"],"description":"Engaged followers as a share of all followers, 0 to 1"},"engaged_percentile":{"type":["number","null"],"description":"Share of comparable creators whose share of engaged followers it exceeds, 0 to 1 (standard view and up)"},"reading_followers":{"type":["integer","null"],"description":"Reading followers: followers who read the creator's notes in the last 30 days"},"reading_share":{"type":["number","null"],"description":"Reading followers as a share of all followers, 0 to 1"},"reading_percentile":{"type":["number","null"],"description":"Share of comparable creators whose share of reading followers it exceeds, 0 to 1 (standard view and up)"},"buying_followers":{"type":["integer","null"],"description":"Buying followers: followers who bought something on Xiaohongshu in the last 30 days"},"buying_share":{"type":["number","null"],"description":"Buying followers as a share of all followers, 0 to 1"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"pgy_creator_cost_history":{"type":"object","description":"PGY creator core figures history (preview: may change, announced beforehand).","properties":{"creator_id":{"type":["string","null"],"description":"PGY creator ID"},"days":{"type":["integer","null"],"description":"How many of the most recent days the figures cover"},"currency":{"type":["string","null"],"description":"Currency of the costs"},"date":{"type":["string","null"],"format":"date-time","description":"The day the period's figures run to: a calendar day in China time (UTC+8), written as midnight UTC of its date"},"cpm":{"type":["string","null"],"description":"CPM: the cost of a thousand impressions, in yuan; null where there is none"},"cpe":{"type":["string","null"],"description":"CPE: the cost of one interaction, in yuan; null where there is none"},"cpv":{"type":["string","null"],"description":"CPV: the cost of one read, in yuan, as PGY's trend chart works it out; null where there is none"},"shop_visit_cost":{"type":["string","null"],"description":"Cost per shop visitor a note brings (PGY's spillover store visits), in yuan; null where there is none"},"median_impressions":{"type":["integer","null"],"description":"Median impressions of a note"},"median_reads":{"type":["integer","null"],"description":"Median reads of a note"},"median_engagements":{"type":["integer","null"],"description":"Median interactions of a note"},"median_shop_visits":{"type":["integer","null"],"description":"Median shop visitors a note brings (PGY's spillover store visits); a note that brought none counts as 0"},"points":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"date":{"type":["string","null"],"format":"date-time","description":"The day: a calendar day in China time (UTC+8), written as midnight UTC of its date"},"cpm":{"type":["string","null"],"description":"CPM: the cost of a thousand impressions, in yuan; null where there is none"},"cpe":{"type":["string","null"],"description":"CPE: the cost of one interaction, in yuan; null where there is none"},"cpv":{"type":["string","null"],"description":"CPV: the cost of one read, in yuan, as PGY's trend chart works it out; null where there is none"},"shop_visit_cost":{"type":["string","null"],"description":"Cost per shop visitor a note brings (PGY's spillover store visits), in yuan; null where there is none"},"median_impressions":{"type":["integer","null"],"description":"Median impressions of a note"},"median_reads":{"type":["integer","null"],"description":"Median reads of a note"},"median_engagements":{"type":["integer","null"],"description":"Median interactions of a note"},"median_shop_visits":{"type":["integer","null"],"description":"Median shop visitors a note brings (PGY's spillover store visits); a note that brought none counts as 0"}}},"description":"The figures day by day, one entry a day, oldest first: each the figures PGY worked out that day"},"approximate":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"field":{"type":["string","null"],"description":"Path of the field, such as metrics.views"},"kind":{"type":["string","null"],"enum":["approximate","lower_bound",null],"description":"Approximate, or a lower bound"}}},"description":"Which numbers of this item are approximate or lower bounds; absent when all are exact"},"ext":{"type":"object","description":"The platform's own fields (full view)."}}},"ext.douyin.comment":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"}}},"ext.douyin.trend":{"type":"object","properties":{"views":{"type":["integer","null"],"description":"Total views of the related content (full view)"},"videos":{"type":["integer","null"],"description":"Number of related videos (full view)"},"artist":{"type":["string","null"],"description":"Who performs the song, on the music chart (full view)"},"category":{"type":["string","null"],"description":"The category the entry is filed under, in the platform's words (full view)"}}},"ext.douyin.account":{"type":"object","properties":{"likes":{"type":["integer","null"],"description":"Likes received across all of the account's posts (full view)"},"uid":{"type":["string","null"],"description":"The account's numeric ID (uid): what the account history and trend-index creator endpoints take, not the Douyin handle (username) (full view)"},"is_live":{"type":["boolean","null"],"description":"Whether the account was live when the profile was fetched (full view)"},"live_room_id":{"type":["string","null"],"description":"ID of the live room while the account is live; null when it is not (full view)"},"has_shop":{"type":["boolean","null"],"description":"Whether the profile has a product showcase (橱窗) entry (full view)"},"live_commerce":{"type":["boolean","null"],"description":"Whether the platform marks the account as able to sell in live streams (full view)"},"verified_label":{"type":["string","null"],"description":"The line beside the verification badge, in the platform's words (such as 店铺账号, a shop account); null without a badge (full view)"},"is_business":{"type":["boolean","null"],"description":"Whether it carries an organisation's, business's or shop's verification (the blue V), not a person's (full view)"},"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (a province or a country, without the IP属地 label); null for an account that shows none (full view)"}}},"ext.douyin.post":{"type":"object","properties":{"new_followers":{"type":["integer","null"],"description":"Followers the post gained its author (full view)"},"like_rate":{"type":["number","null"],"description":"Like rate: likes over views, 0 to 1 (full view)"},"follow_rate":{"type":["number","null"],"description":"Follow rate: new followers over views, 0 to 1 (full view)"},"index":{"type":["integer","null"],"description":"The index 巨量算数 gives the video: a score, not a count of plays (full view)"},"category":{"type":["string","null"],"description":"The category the video is filed under, in the platform's words (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Address of the cover image (full view)"},"duration":{"type":["number","null"],"description":"Length of the video, in seconds; an image post has none (full view)"},"video_url":{"type":["string","null"],"format":"uri","description":"Address the video plays from: a signed address of the platform's that expires, so use it soon; an image post has none (full view)"},"finish_rate":{"type":["number","null"],"description":"Completion rate: the share of plays watched to the end, 0 to 1 (Xingtu's figure) (full view)"},"interaction_rate":{"type":["number","null"],"description":"Interaction rate: interactions over plays, 0 to 1 (Xingtu's figure) (full view)"},"categories":{"type":["array","null"],"items":{"type":["string","null"]},"description":"What the platform files the post under, from the first level to the third, in its words (such as 美食 › 美食教程 › 饮品教程, food › food tutorials › drink tutorials); null where it filed it under none (full view)"},"author_xingtu_id":{"type":["string","null"],"description":"The author's Xingtu creator ID, as the other Xingtu endpoints take it (Xingtu's figure) (full view)"},"author_uid":{"type":["string","null"],"description":"The numeric ID (uid) of the author's Douyin account, what the trend-index creator endpoints take (Xingtu's figure) (full view)"}}},"ext.douyin.keyword_history":{"type":"object","properties":{"composite_average":{"type":["integer","null"],"description":"Daily average of the composite index over the period asked for (full view)"},"search_average":{"type":["integer","null"],"description":"Daily average of the search index over the period asked for (full view)"},"previous_composite_average":{"type":["integer","null"],"description":"Daily average of the composite index over the period of the same length before it (full view)"},"previous_search_average":{"type":["integer","null"],"description":"Daily average of the search index over the period of the same length before it (full view)"},"year_ago_composite_average":{"type":["integer","null"],"description":"Daily average of the composite index over the same period a year earlier (full view)"},"year_ago_search_average":{"type":["integer","null"],"description":"Daily average of the search index over the same period a year earlier (full view)"}}},"ext.douyin.keyword_related":{"type":"object","properties":{"relevance_change":{"type":["number","null"],"description":"Change in relevance against the week before, as a ratio: 0.1 is 10% up; null for a keyword newly related this week (full view)"},"is_new":{"type":["boolean","null"],"description":"Whether the keyword is newly related this week (full view)"}}},"ext.douyin.creator":{"type":"object","properties":{"uid":{"type":["string","null"],"description":"The numeric ID (uid) of the creator's Douyin account; not the ID the account endpoints take (full view)"},"rate_integrated":{"type":["string","null"],"description":"Rate for an integrated video (植入视频: the brand placed in the creator's own content), in yuan (full view)"},"rate_custom":{"type":["string","null"],"description":"Rate for a custom video (定制视频: a video made for the brand), in yuan (full view)"},"expected_views":{"type":["integer","null"],"description":"Views the platform expects of one video (full view)"},"agency":{"type":["string","null"],"description":"Name of the agency (MCN) the creator is signed to; null when there is none (full view)"},"cpm_integrated":{"type":["string","null"],"description":"Expected cost per thousand views (CPM) of an integrated video, in yuan: the integrated rate over the views the platform expects, times 1000; null without a rate or an estimate (full view)"},"cpm_custom":{"type":["string","null"],"description":"Expected cost per thousand views (CPM) of a custom video, in yuan, worked out the same way; null where there is none (full view)"},"cpm_promoted":{"type":["string","null"],"description":"Xingtu's other expected cost per thousand views of an integrated video, in yuan: the same rate over the platform's promotion view estimate (not expected_views), times 1000, above or below cpm_integrated; it is what the search's CPM order (sort=lowest_cpm) goes by; null where there is none (full view)"},"interaction_rate_30d":{"type":["number","null"],"description":"Interaction rate of the last 30 days' videos, 0 to 1 (0.0085 is 0.85%); null where the platform has none (full view)"},"completion_rate_30d":{"type":["number","null"],"description":"Completion rate of the last 30 days' videos, 0 to 1; null where the platform has none (full view)"},"views_median_30d":{"type":["number","null"],"description":"Median views of the last 30 days' videos (ending in .5 where the number of videos is even); null where the platform has none (full view)"},"ecommerce_level":{"type":["string","null"],"description":"Xingtu's e-commerce (selling) level, L0 to L6, in the platform's words; null where there is none (full view)"},"gender":{"type":["string","null"],"enum":["female","male",null],"description":"The creator's gender: female or male; null where the platform gives none (full view)"},"content_labels":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Theme labels Xingtu gives the creator's content, in the platform's words (the last 180 days', in search results); null where there are none (full view)"}}},"ext.kuaishou.account":{"type":"object","properties":{"likes":{"type":["integer","null"],"description":"Likes received across all of the account's posts (full view)"},"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"},"gender":{"type":["string","null"],"enum":["female","male",null],"description":"The gender the user gives on the profile: female or male; null where none is given (full view)"},"has_shop":{"type":["boolean","null"],"description":"Whether the profile shows a shop card (a Kuaishou store) (full view)"},"verified_label":{"type":["string","null"],"description":"What the verification says, in the platform's words; null without one (full view)"}}},"ext.kuaishou.post":{"type":"object","properties":{"duration":{"type":["number","null"],"description":"Length of the video, in seconds; a photo set has none (full view)"}}},"ext.kuaishou.comment":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"}}},"ext.xiaohongshu.post":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it, in English (a province by its pinyin or English name), where the app shows it in Chinese (full view)"},"duration":{"type":["number","null"],"description":"Length of the video, in seconds (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Cover of the video (full view)"},"video_url":{"type":["string","null"],"format":"uri","description":"Address of the video file (the H.264 MP4 the platform plays) (full view)"},"subtitle_url":{"type":["string","null"],"format":"uri","description":"The Chinese subtitles the platform made for the video (an SRT file with timings), usable as its transcript; none where the platform made none (full view)"},"is_sponsored":{"type":["boolean","null"],"description":"Whether it is a brand partnership note the platform has on record (报备, marked as a partnership in the app); the brand is not given here (full view)"}}},"ext.xiaohongshu.comment":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it, in English (a province by its pinyin or English name), where the app shows it in Chinese (full view)"}}},"ext.xiaohongshu.topic":{"type":"object","properties":{"discussions":{"type":["integer","null"],"description":"The discussion count the topic page shows (the number of people its share text says are discussing it) (full view)"}}},"ext.xiaohongshu.account":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it, in English (a province by its pinyin or English name), where the app shows it in Chinese (full view)"},"likes":{"type":["integer","null"],"description":"Likes its notes have received in all (full view)"},"favorites":{"type":["integer","null"],"description":"Times its notes have been saved in all (full view)"},"gender":{"type":["string","null"],"enum":["female","male",null],"description":"The gender the profile shows: female or male; null where it shows none (full view)"},"location":{"type":["string","null"],"description":"The region the account filled in, in the platform's words (country, province and city, spaced); null where none is. Not the IP location (full view)"}}},"ext.xiaohongshu.review":{"type":"object","properties":{"likes":{"type":["integer","null"],"description":"Likes the review received (full view)"},"date_shown":{"type":["string","null"],"description":"When it was written, as the platform shows it: a date, a month and a day without the year, or how long ago (full view)"}}},"ext.xiaohongshu.keyword_related":{"type":"object","properties":{"notes":{"type":["integer","null"],"description":"Notes about the related keyword; null where the platform gives no figure for the word (full view)"},"views":{"type":["integer","null"],"description":"Reads of those notes in all; null where the platform gives no figure for the word (full view)"}}},"ext.xiaohongshu.creator":{"type":"object","properties":{"rate_image_note":{"type":["string","null"],"description":"Rate for an image note, in yuan (full view)"},"rate_video_note":{"type":["string","null"],"description":"Rate for a video note, in yuan (full view)"},"rate_lowest":{"type":["string","null"],"description":"The lowest rate PGY gives (the lower of the image-note and video-note rates), in yuan (full view)"},"sponsored_notes":{"type":["integer","null"],"description":"Number of sponsored notes (full view)"},"median_reads":{"type":["integer","null"],"description":"Median reads of a note (full view)"},"median_engagements":{"type":["integer","null"],"description":"Median interactions of a note (full view)"},"gender":{"type":["string","null"],"enum":["female","male",null],"description":"The creator's gender: female or male; null where the platform says unknown (full view)"},"feature_tags":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Content feature tags, in the platform's words (such as unboxing, reviews) (full view)"},"personal_tags":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Persona tags, in the platform's words (such as tech fan, mother) (full view)"},"industries":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Industries the creator has worked with, in the platform's words (full view)"},"agency":{"type":["string","null"],"description":"Name of the agency (MCN) the creator is signed to; null when there is none (full view)"},"likes_and_favorites":{"type":["integer","null"],"description":"Likes and saves the creator's notes have received in all, as the profile's likes-and-saves count (full view)"},"accepts_sponsorship":{"type":["boolean","null"],"description":"Whether the creator currently takes sponsored work on PGY (full view)"},"accepts_image_notes":{"type":["boolean","null"],"description":"Whether the creator takes sponsored image notes (full view)"},"accepts_video_notes":{"type":["boolean","null"],"description":"Whether the creator takes sponsored video notes (full view)"},"sponsored_notes_30d":{"type":["integer","null"],"description":"Sponsored notes published in the last 30 days (full view)"},"travel_areas":{"type":["array","null"],"items":{"type":["string","null"]},"description":"The travel areas the creator lists on PGY, in the platform's words (a province, or a province and a city) (full view)"}}},"ext.wechat_mp.account":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"},"original_articles":{"type":["integer","null"],"description":"Number of original articles (full view)"},"channels_id":{"type":["string","null"],"description":"ID of the linked Channels account (full view)"},"biz":{"type":["string","null"],"description":"The account's __biz: what follows __biz= in the links of its articles (full view)"},"owner_name":{"type":["string","null"],"description":"Name of the account's owner (a company or body); null for a personal account and where none is on record (full view)"},"estimated_followers":{"type":["integer","null"],"description":"Estimated active followers: a third-party database's estimate from reads and the like, not a follower count the platform publishes (it publishes none), and possibly weeks to months old (full view)"},"estimated_headline_reads":{"type":["integer","null"],"description":"Estimated average reads of the account's lead articles: a third-party database's estimate, possibly out of date (full view)"},"estimated_headline_likes":{"type":["integer","null"],"description":"Estimated average likes of the account's lead articles: a third-party database's estimate, possibly out of date (full view)"},"estimated_weekly_articles":{"type":["integer","null"],"description":"Estimated articles a week: as a third-party database counts them, possibly out of date (full view)"},"estimated_last_published_at":{"type":["string","null"],"format":"date-time","description":"When the account last published, as a third-party database has it; earlier than the truth when the database has not caught up (full view)"},"banned":{"type":["boolean","null"],"description":"Whether the platform has banned the account (the ban type it gives is not \"normal\") (full view)"}}},"ext.wechat_mp.post":{"type":"object","properties":{"recommends":{"type":["integer","null"],"description":"Recommends (formerly \"wow\") (full view)"},"position":{"type":["integer","null"],"description":"Its place in the push it went out in: 1 is the lead article, 2 and on the ones below it (full view)"},"content_type":{"type":["string","null"],"enum":["article","video","audio","images","text","repost",null],"description":"The account's own content format: article (text and pictures), video, audio, images (a picture post), text (words only) or repost (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Cover image (full view)"},"digest":{"type":["string","null"],"description":"The digest its author wrote for the article; null where none was written (full view)"},"byline":{"type":["string","null"],"description":"The author the article is signed by (not the account); null where it is unsigned (full view)"},"source_url":{"type":["string","null"],"format":"uri","description":"The link of the article's \"read the original\" at its end; null where there is none (full view)"},"ip_location":{"type":["string","null"],"description":"Where the article was posted from, as its page shows it: the province, or the country for one posted from abroad (full view)"}}},"ext.wechat_mp.comment":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"},"is_pinned":{"type":["boolean","null"],"description":"Whether the account pinned it to the top (full view)"}}},"ext.wechat.account":{"type":"object","properties":{"owner_name":{"type":["string","null"],"description":"Name of the account's owner (a company or body); null where none is shown (full view)"},"original_articles":{"type":["integer","null"],"description":"Number of original articles as the platform shows it; null for a service account and where none is shown (full view)"}}},"ext.wechat.post":{"type":"object","properties":{"duration":{"type":["number","null"],"description":"Length of the video, in seconds; null for an article (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Cover image: a video's cover or an article's header image (full view)"},"reads_label":{"type":["string","null"],"description":"The band of reads an article's card shows, in the platform's words, such as 阅读 N万+ (reads N0k+): a band, not an exact count; null where the card shows none, and for a video (full view)"}}},"ext.wechat_channels.post":{"type":"object","properties":{"duration":{"type":["number","null"],"description":"Length of the video, in seconds (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Cover of the video (full view)"},"video_url":{"type":["string","null"],"format":"uri","description":"Address of the video file; it expires. The file is encrypted: it plays once its first 128 KB are decrypted with the decode_key of the same answer (full view)"},"decode_key":{"type":["string","null"],"description":"Key that decrypts the file at video_url, good only for the address of the same answer (full view)"},"counted_at":{"type":["string","null"],"format":"date-time","description":"When these counts were taken: often minutes to hours before the call (full view)"}}},"ext.wechat_channels.account":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"},"verification":{"type":["string","null"],"description":"What the verification says, in the platform's words: the owner's name for a company or body, a role or profession for a person; null when not verified (full view)"}}},"ext.wechat_channels.comment":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"}}},"ext.bilibili.post":{"type":"object","properties":{"aid":{"type":["string","null"],"description":"The video's other number (its av number); it names the same video as the BV number (full view)"},"coins":{"type":["integer","null"],"description":"Coins given (full view)"},"danmaku":{"type":["integer","null"],"description":"Number of danmaku (comments shown over the video) (full view)"},"duration":{"type":["number","null"],"description":"Length of the video, in seconds (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Address of the cover image (full view)"},"category":{"type":["string","null"],"description":"The section the video is filed under, in the platform's words (数码, 美食制作, say) (full view)"},"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"},"cid":{"type":["string","null"],"description":"The number of the video's first part (cid): what subtitles and danmaku are asked for by, with the BV number (full view)"},"parts":{"type":["integer","null"],"description":"How many parts the video has (full view)"},"recommend_reason":{"type":["string","null"],"description":"Why the popular list recommends the video, in the platform's words (很多人分享, say); null where it gives none (full view)"}}},"ext.bilibili.account":{"type":"object","properties":{"likes":{"type":["integer","null"],"description":"Likes received in all, on videos, articles and posts: the number the profile shows (full view)"},"verified_reason":{"type":["string","null"],"description":"What the verification says, in the platform's words (百大UP主 or 知名游戏UP主, say); null when not verified (full view)"},"level":{"type":["integer","null"],"description":"Account level, 0 to 6 (full view)"},"live_room_url":{"type":["string","null"],"format":"uri","description":"Link to the user's live room; null when they have none (full view)"}}},"ext.bilibili.comment":{"type":"object","properties":{"author_level":{"type":["integer","null"],"description":"The commenter's account level, 0 to 6 (full view)"}}},"ext.bilibili.trend":{"type":"object","properties":{"display_name":{"type":["string","null"],"description":"The words the list shows for the entry; name is the term searched when it is tapped, and the two often differ (full view)"}}},"ext.weibo.post":{"type":"object","properties":{"text_truncated":{"type":["boolean","null"],"description":"Whether the text is cut short: a long post comes with its beginning only in lists and search; get the post for the whole (full view)"},"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"},"reposted_id":{"type":["string","null"],"description":"ID of the post it reposts; null when it is not a repost (full view)"}}},"ext.weibo.comment":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"}}},"ext.weibo.trend":{"type":"object","properties":{"label":{"type":["string","null"],"description":"The label beside the term, the platform's own character (新 new, 热 hot, 沸 boiling, say); null where it has none (full view)"}}},"ext.weibo.account":{"type":"object","properties":{"interactions":{"type":["integer","null"],"description":"Reposts, comments and likes in all: the number the profile shows, the sum of the three below (full view)"},"likes":{"type":["integer","null"],"description":"Likes received in all, the number the profile shows: likes on the posts and likes on the comments taken together (full view)"},"comments_received":{"type":["integer","null"],"description":"Comments received on all of the account's posts (full view)"},"reposts_received":{"type":["integer","null"],"description":"Times the account's posts have been reposted, in all (full view)"},"verified_type":{"type":["string","null"],"enum":["person","organization",null],"description":"Kind of verification: person (an individual, the orange or gold V) or organization (the blue V of a company, a media outlet, a government body and the like); null when not verified (full view)"},"verified_reason":{"type":["string","null"],"description":"What the verification says, in the platform's words (a brand's 官方微博 or a person's 数码博主, say); null where there is none (full view)"},"gender":{"type":["string","null"],"enum":["female","male",null],"description":"Gender as given on the profile: female or male (full view)"},"location":{"type":["string","null"],"description":"The region given on the profile (北京, 广东 深圳, say; 其他 where none was given), not the IP location (full view)"}}},"ext.x.post":{"type":"object","properties":{"quotes":{"type":["integer","null"],"description":"Times it was quoted (full view)"},"quoted_id":{"type":["string","null"],"description":"ID of the post it quotes (full view)"},"is_retweet":{"type":["boolean","null"],"description":"Whether it is a retweet of someone else's post. A retweet's likes, replies and bookmarks are 0; its views are its own (hundreds of thousands, on a large account); its retweet count is the original's; its text is the original's cut short after \"RT @…\". Leave retweets out when working out the account's own engagement (full view)"},"retweeted_id":{"type":["string","null"],"description":"ID of the original post it retweets; null when it is not a retweet (full view)"},"retweeted_author_id":{"type":["string","null"],"description":"Account ID (digits) of the original post's author; null when it is not a retweet (full view)"}}},"ext.x.account":{"type":"object","properties":{"verified_type":{"type":["string","null"],"enum":["business","government",null],"description":"Which badge it is: business (the gold badge of a company or organisation) or government (the grey badge of a government or official body); null for the blue badge (a paid subscription) and for no badge, which verified tells apart (full view)"},"location":{"type":["string","null"],"description":"The location given on the profile, as written: it may be any text; null where none is given (full view)"},"website":{"type":["string","null"],"format":"uri","description":"The website given on the profile (the full address, not the t.co link); null where none is given (full view)"}}},"ext.x.community":{"type":"object","properties":{"moderators":{"type":["integer","null"],"description":"Number of moderators (full view)"},"join_policy":{"type":["string","null"],"description":"How people join, as the platform words it (Open, for one) (full view)"},"topic":{"type":["string","null"],"description":"The community's main topic; null when none is set (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"The community's banner image (full view)"}}},"ext.telegram.post":{"type":"object","properties":{"number":{"type":["integer","null"],"description":"The message's number within its channel; with the channel's handle it locates the message (full view)"}}},"ext.youtube.account":{"type":"object","properties":{"views":{"type":["integer","null"],"description":"Total views of all the channel's videos (full view)"},"links":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"The links the channel's About section lists (its website, its other social accounts and so on), in the page's order; an empty list where there are none (full view)"},"keywords":{"type":["array","null"],"items":{"type":["string","null"]},"description":"The keywords the channel set for itself, not shown on its page; an empty list where there are none (full view)"}}},"ext.youtube.post":{"type":"object","properties":{"duration":{"type":["number","null"],"description":"Length of the video, in seconds (full view)"},"video_id":{"type":["string","null"],"description":"ID of the video a channel post carries: pass it unchanged to the video endpoint; null for a post without one (full view)"},"keywords":{"type":["array","null"],"items":{"type":["string","null"]},"description":"The tags (keywords) the author set on the video, not shown on its page; an empty list where none were set (full view)"},"category":{"type":["string","null"],"description":"The video's category (the one its author chose on uploading), in the platform's words (full view)"},"chapters":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"title":{"type":["string","null"],"description":"The chapter's title (full view)"},"start":{"type":["number","null"],"description":"Second of the video the chapter starts at (full view)"}}},"description":"The video's chapters (the parts its progress bar is divided into), in order of time; an empty list where it has none (full view)"}}},"ext.youtube.comment":{"type":"object","properties":{"replies_token":{"type":["string","null"],"description":"Token that gets this comment's replies: pass it unchanged as the id of the comment replies endpoint; null for a comment without replies (full view)"}}},"ext.pinterest.post":{"type":"object","properties":{"link":{"type":["string","null"],"format":"uri","description":"Address of the page the pin points to; null when it points nowhere (full view)"},"saves":{"type":["integer","null"],"description":"Times the same content was saved across the platform, other people's copies of the pin included (full view)"},"duration":{"type":["number","null"],"description":"Length of the video, in seconds; null when the pin is not a video (full view)"}}},"ext.facebook.account":{"type":"object","properties":{"likes":{"type":["integer","null"],"description":"People who like the page (full view)"},"talking_about":{"type":["integer","null"],"description":"People talking about the page (full view)"},"category":{"type":["string","null"],"description":"The page's category, as the platform words it (full view)"},"website":{"type":["string","null"],"format":"uri","description":"The website the page gives (full view)"},"ad_library_id":{"type":["string","null"],"description":"The page's ID in Meta's ad library, which is not the page's id; it is the ID that gets the page's ads (meta.advertisers.ads.list) (full view)"}}},"ext.linkedin.account":{"type":"object","properties":{"employees":{"type":["integer","null"],"description":"Number of employees (full view)"},"company_size":{"type":["string","null"],"description":"The company's size bracket, as the platform words it (full view)"},"company_type":{"type":["string","null"],"description":"The kind of company, as the platform words it (full view)"},"industry":{"type":["string","null"],"description":"The industry, as the platform words it (full view)"},"headquarters":{"type":["string","null"],"description":"Where the headquarters are (full view)"},"website":{"type":["string","null"],"format":"uri","description":"The website the company gives (full view)"},"founded":{"type":["integer","null"],"description":"Year the company was founded (full view)"}}},"ext.linkedin.ad":{"type":"object","properties":{"format_label":{"type":["string","null"],"description":"What the platform itself calls this ad format, as it words it (full view)"},"cta":{"type":["string","null"],"description":"Text of the call-to-action button (full view)"},"impressions_range":{"type":["string","null"],"description":"Bracket of total impressions, as the platform words it (full view)"},"targeting_language":{"type":["string","null"],"description":"Languages targeted, as the platform words it (full view)"},"targeting_location":{"type":["string","null"],"description":"Locations targeted, as the platform words it (full view)"}}},"ext.threads.post":{"type":"object","properties":{"quotes":{"type":["integer","null"],"description":"Times it was quoted (full view)"},"media_id":{"type":["string","null"],"description":"The platform's own number for the post (full view)"}}},"ext.reddit.post":{"type":"object","properties":{"score":{"type":["integer","null"],"description":"Score: upvotes less downvotes, not a count of likes (full view)"},"upvote_ratio":{"type":["number","null"],"description":"Share of the votes that are upvotes, 0 to 1 (full view)"},"subreddit":{"type":["string","null"],"description":"Name of the community it is in, without the r/; null for a post on its author's profile (full view)"},"link":{"type":["string","null"],"format":"uri","description":"Address a link post points to; null for a text post (full view)"},"nsfw":{"type":["boolean","null"],"description":"Whether it is marked not safe for work (full view)"}}},"ext.reddit.comment":{"type":"object","properties":{"score":{"type":["integer","null"],"description":"Score: upvotes less downvotes; may be negative (full view)"}}},"ext.reddit.community":{"type":"object","properties":{"fullname":{"type":["string","null"],"description":"The platform's internal ID of the community (it starts with t5_) (full view)"},"title":{"type":["string","null"],"description":"The title its moderators gave the community (full view)"},"type":{"type":["string","null"],"description":"How open the community is (public, restricted and so on), as the platform words it (full view)"},"weekly_active_users":{"type":["integer","null"],"description":"Users active in the last week (full view)"},"weekly_contributions":{"type":["integer","null"],"description":"Posts and comments made in the last week (full view)"}}},"ext.reddit.account":{"type":"object","properties":{"karma":{"type":["integer","null"],"description":"Total karma (full view)"},"post_karma":{"type":["integer","null"],"description":"Karma from posts (full view)"},"comment_karma":{"type":["integer","null"],"description":"Karma from comments (full view)"},"comments":{"type":["integer","null"],"description":"Comments made (full view)"}}},"ext.zhihu.post":{"type":"object","properties":{"answers":{"type":["integer","null"],"description":"Answers the question has (full view)"},"followers":{"type":["integer","null"],"description":"People following the question (full view)"}}},"ext.zhihu.account":{"type":"object","properties":{"answers":{"type":["integer","null"],"description":"Answers written (full view)"},"articles":{"type":["integer","null"],"description":"Articles written (full view)"},"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it (full view)"},"is_organization":{"type":["boolean","null"],"description":"Whether it is an organisation's account (its page is under zhihu.com/org/) rather than a person's (full view)"},"upvotes":{"type":["integer","null"],"description":"Upvotes received in all (full view)"},"last_posted_at":{"type":["string","null"],"format":"date-time","description":"When it last posted anything: whether the account is still active (full view)"}}},"ext.zhihu.comment":{"type":"object","properties":{"ip_location":{"type":["string","null"],"description":"IP location as the platform shows it; null on old comments, from before the platform showed one (full view)"}}},"ext.zhihu.trend":{"type":"object","properties":{"answers":{"type":["integer","null"],"description":"Answers the listed question has (full view)"},"followers":{"type":["integer","null"],"description":"People following the listed question (full view)"},"excerpt":{"type":["string","null"],"description":"The listed question's summary: the words the list gives under it (full view)"},"created_at":{"type":["string","null"],"format":"date-time","description":"When the question was asked (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Address of the picture the list shows with the entry; null where it shows none (full view)"}}},"ext.tiktok.post":{"type":"object","properties":{"duration":{"type":["number","null"],"description":"Length of the video, in seconds (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Cover of the video (full view)"},"video_url":{"type":["string","null"],"format":"uri","description":"Address the video plays from; it expires (full view)"},"collaborators":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Handles of the co-authors of a collab post other than the one who posted it; an empty list for a post that is not a collab. Brands often collaborate this way, but a collab by itself does not say the post is paid for (full view)"}}},"ext.tiktok.comment":{"type":"object","properties":{"region":{"type":["string","null"],"description":"The country or region the platform keeps for the commenter's account, as a two-letter code (full view)"}}},"ext.tiktok.account":{"type":"object","properties":{"sec_uid":{"type":["string","null"],"description":"The platform's other account ID (secUid) (full view)"},"likes":{"type":["integer","null"],"description":"Likes received across the account's posts (full view)"},"region":{"type":["string","null"],"description":"The country or region the platform keeps for the account, as a two-letter code (full view)"},"language":{"type":["string","null"],"description":"The language the account uses, as a code (en, vi, say) (full view)"}}},"ext.tiktok.review":{"type":"object","properties":{"verified_purchase":{"type":["boolean","null"],"description":"Whether the platform marks it a verified purchase (full view)"},"country":{"type":["string","null"],"description":"Code of the country or region the review is from (full view)"}}},"ext.tiktok.product":{"type":"object","properties":{"page_price":{"type":["string","null"],"description":"The price the product's page shows (its lowest variant), in currency. Recorded higher than the same product's price in its shop's list and in the search by about a shipping fee (30.99 on the page, 25 in the list, a fee of 5.99); what a buyer pays is what the checkout says (full view)"},"shipping_fee":{"type":["string","null"],"description":"The standard shipping fee the product's page shows, in currency (full view)"},"shop_rating":{"type":["number","null"],"description":"The shop's rating, out of 5 (full view)"},"shop_followers":{"type":["integer","null"],"description":"Followers of the shop (full view)"},"shop_products":{"type":["integer","null"],"description":"Products the shop has on sale (full view)"}}},"ext.tiktok.ad":{"type":"object","properties":{"likes":{"type":["integer","null"],"description":"Likes on the ad's video (full view)"},"comments":{"type":["integer","null"],"description":"Comments on the ad's video (full view)"},"shares":{"type":["integer","null"],"description":"Shares of the ad's video (full view)"},"duration":{"type":["number","null"],"description":"Length of the video, in seconds (full view)"},"cover_url":{"type":["string","null"],"format":"uri","description":"Cover of the video (full view)"},"objective":{"type":["string","null"],"description":"Campaign objective, as the platform's own code (full view)"},"regions":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Codes of the countries or regions it was shown in (full view)"},"audience_range":{"type":["string","null"],"description":"Bracket of people reached, as the platform words it; null where it gives none (full view)"},"category":{"type":["string","null"],"description":"What the ads library says the ad is about, as it words it; null where it says nothing (full view)"},"industry":{"type":["string","null"],"description":"The industry the Creative Center files the material under, as the platform's own code (label_ and a string of digits); null where there is none (full view)"}}},"ext.meta.ad":{"type":"object","properties":{"format_label":{"type":["string","null"],"description":"What the platform itself calls this ad format, as it words it (VIDEO, DPA, DCO, say) (full view)"},"active":{"type":["boolean","null"],"description":"Whether the ad is running now (full view)"},"platforms":{"type":["object","null"],"properties":{"facebook":{"type":["boolean","null"],"description":"Whether it is delivered on Facebook (full view)"},"instagram":{"type":["boolean","null"],"description":"Whether it is delivered on Instagram (full view)"},"messenger":{"type":["boolean","null"],"description":"Whether it is delivered on Messenger (full view)"},"audience_network":{"type":["boolean","null"],"description":"Whether it is delivered on the Audience Network (third-party apps and sites) (full view)"},"threads":{"type":["boolean","null"],"description":"Whether it is delivered on Threads (full view)"},"whatsapp":{"type":["boolean","null"],"description":"Whether it is delivered on WhatsApp (full view)"}},"description":"Where it is delivered: a yes or no for each platform (full view)"},"cta":{"type":["string","null"],"description":"Text of the call-to-action button (full view)"},"cards":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"title":{"type":["string","null"],"description":"The card's headline (full view)"},"text":{"type":["string","null"],"description":"The card's body text (full view)"},"landing_url":{"type":["string","null"],"format":"uri","description":"Where a click on the card leads (full view)"},"image_url":{"type":["string","null"],"format":"uri","description":"The card's image (full view)"},"video_url":{"type":["string","null"],"format":"uri","description":"The card's video; it expires (full view)"}}},"description":"Each card of a carousel or of an ad with several versions; empty for an ad of one image or one video (full view)"}}},"ext.meta.advertiser":{"type":"object","properties":{"username":{"type":["string","null"],"description":"Handle of the Facebook page (full view)"},"verified":{"type":["boolean","null"],"description":"Whether the page carries the blue verified badge (full view)"},"category":{"type":["string","null"],"description":"The page's category, as the platform words it (full view)"},"likes":{"type":["integer","null"],"description":"People who like the page (full view)"},"instagram_username":{"type":["string","null"],"description":"Handle of the linked Instagram account; null when none is linked (full view)"},"instagram_followers":{"type":["integer","null"],"description":"Followers of the linked Instagram account (full view)"}}},"ext.google.ad":{"type":"object","properties":{"regions":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Codes of the countries or regions it was shown in (full view)"},"impressions_min":{"type":["integer","null"],"description":"Lower end of the range of total impressions; null when the platform does not publish it (full view)"},"impressions_max":{"type":["integer","null"],"description":"Upper end of the range of total impressions; null when the platform does not publish it (full view)"},"variations":{"type":["array","null"],"items":{"type":["object","null"],"properties":{"title":{"type":["string","null"],"description":"The variation's headline (full view)"},"text":{"type":["string","null"],"description":"The variation's description (full view)"},"destination":{"type":["string","null"],"description":"Where the variation leads, as the ad words it; may be a bare domain (full view)"},"image_url":{"type":["string","null"],"format":"uri","description":"The variation's image (full view)"},"video_url":{"type":["string","null"],"format":"uri","description":"The variation's video (full view)"}}},"description":"Each variation of the ad (full view)"}}},"ext.google.advertiser":{"type":"object","properties":{"ads_estimate":{"type":["integer","null"],"description":"The platform's estimate of how many ads it has (full view)"}}},"ext.instagram.post":{"type":"object","properties":{"media_id":{"type":["string","null"],"description":"The platform's numeric ID of the post (full view)"},"duration":{"type":["number","null"],"description":"Length of the video, in seconds (full view)"},"video_url":{"type":["string","null"],"format":"uri","description":"Address the video plays from; it expires (full view)"},"collaborators":{"type":["array","null"],"items":{"type":["string","null"]},"description":"Handles of the co-authors of a collab post other than the one who posted it; an empty list for a post that is not a collab. Brands often collaborate this way, but a collab by itself does not say the post is paid for (full view)"}}},"ext.instagram.account":{"type":"object","properties":{"is_private":{"type":["boolean","null"],"description":"Whether the account is private (full view)"},"website":{"type":["string","null"],"format":"uri","description":"The website given under the profile's bio; null where none is given (full view)"},"links":{"type":["array","null"],"items":{"type":["string","null"],"format":"uri"},"description":"All the links the profile lists, in the page's order; an empty list where there are none (full view)"}}}}}}
