{ "openapi": "3.0.0", "info": { "title": "TikHub API", "description": "Multi-platform social media data via TikHub — Douyin, TikTok, Bilibili, Kuaishou, Weibo, Xiaohongshu, Zhihu, and commercial (Xingtu/Huahuo/Billboard) endpoints.", "version": "1.0.0" }, "servers": [ { "url": "https://api.aisa.one/apis/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "AIsa API key. Get yours at https://aisa.one" } }, "schemas": { "VideoRankingRequest": { "properties": { "time_range": { "title": "Time Range", "description": "Time range: 1 / 2 / 3", "default": 2, "example": 2, "nullable": true, "type": "integer" }, "tag_id": { "title": "Tag Id", "description": "Category id. 601 Drama, 602 Celebrity, 606 Music, 607 Anime, 608 Gaming, 609 Current Affairs, 612 Dance, 614 Agriculture, 615 Technology, 616 Finance, 617 Parenting, 619 Lifestyle, 621 Health, 623 Emotions, 624 Culture, 625 Workplace, 626 Education, 627 Photography, 628 Food, 629 Travel, 631 Fashion, 633 Sports, 634 Entertainment, 635 Automotive", "default": 634, "example": 634, "nullable": true, "type": "integer" }, "dim_type": { "title": "Dim Type", "description": "Ranking dimension: 1=Low-follower Viral, 2=High Completion Rate, 3=High Like Rate, 4=High Follower Growth Rate, 5=Popularity Index", "default": 5, "example": 5, "nullable": true, "type": "integer" }, "adv_id": { "title": "Adv Id", "description": "Advertiser id (optional)", "default": "", "example": "", "nullable": true, "type": "string" } }, "type": "object", "title": "VideoRankingRequest", "description": "DOU+ Video Ranking Request Model" }, "Body_get_item_report_detail_api_v1_douyin_xingtu_v2_get_item_report_detail_post": { "properties": { "item_id": { "type": "string", "title": "Item Id", "description": "Video (item) ID" } }, "type": "object", "required": [ "item_id" ], "title": "Body_get_item_report_detail_api_v1_douyin_xingtu_v2_get_item_report_detail_post" }, "XMssdkInfoModel": { "properties": { "user_agent": { "title": "User Agent", "description": "Optional User-Agent string, currently not supported for customization, defaults to a fixed value", "nullable": true, "type": "string" } }, "type": "object", "title": "XMssdkInfoModel" }, "NotesRateReq": { "properties": { "user_id": { "type": "string", "title": "User Id", "description": "Blogger user ID", "example": "5c668b3e0000000012021605" }, "business": { "type": "integer", "enum": [ 0, 1 ], "title": "Business", "description": "Note scope: 0=organic (default), 1=sponsored", "default": 0, "example": 0 }, "note_type": { "type": "integer", "enum": [ 1, 2, 3 ], "title": "Note Type", "description": "Note type: 3=Image & text + Video (default), 1=Image & text, 2=Video", "default": 3, "example": 3 }, "date_type": { "type": "integer", "enum": [ 1, 2 ], "title": "Date Type", "description": "Date range: 1=last 30 days (default), 2=last 90 days", "default": 1, "example": 1 }, "advertise_switch": { "type": "integer", "enum": [ 0, 1 ], "title": "Advertise Switch", "description": "Traffic type: 1=All (including sponsored), 0=Organic only", "default": 1, "example": 1 } }, "additionalProperties": false, "type": "object", "required": [ "user_id" ], "title": "NotesRateReq" }, "Body_fetch_home_feed_api_v1_douyin_web_fetch_home_feed_post": { "properties": { "count": { "type": "integer", "title": "Count", "description": "Number", "default": 10 }, "refresh_index": { "type": "integer", "title": "Refresh Index", "description": "Refresh-paging index: 0=refresh (first page / pull-down), >0=load-more (scroll down), increment by 1 for next page", "default": 0 }, "cookie": { "type": "string", "title": "Cookie", "description": "Optional: Your web Douyin login Cookie for a personalized feed; uses the default Cookie if omitted", "default": "" } }, "type": "object", "title": "Body_fetch_home_feed_api_v1_douyin_web_fetch_home_feed_post" }, "SearchSuggestRequest": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "The keyword to be suggested", "default": "Artificial Intelligence" } }, "type": "object", "title": "SearchSuggestRequest" }, "LiveRoomHistoryListRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "start_date": { "type": "string", "title": "Start Date", "description": "Start date (format YYYY-MM-DD)", "example": "2025-09-11" }, "end_date": { "type": "string", "title": "End Date", "description": "End date (format YYYY-MM-DD)", "example": "2025-10-11" }, "limit": { "type": "integer", "title": "Limit", "description": "Limit per page (max 400)", "default": 400, "example": 400 }, "need_living": { "type": "integer", "title": "Need Living", "description": "Include live rooms currently streaming: 0=exclude, 1=include", "default": 1, "example": 1 }, "download": { "type": "integer", "title": "Download", "description": "Download: 0=no download, 1=download", "default": 0, "example": 0 } }, "type": "object", "required": [ "cookie", "start_date", "end_date" ], "title": "LiveRoomHistoryListRequest", "description": "Live Room History List Request Model" }, "GetProductListRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "start_date": { "type": "string", "title": "Start Date", "description": "Start date, e.g. '2025-04-01'", "default": "2025-04-01" }, "end_date": { "type": "string", "title": "End Date", "description": "End Date, e.g. '2025-05-01'", "default": "2025-05-01" }, "page": { "type": "integer", "title": "Page", "description": "Page Number", "default": 0 } }, "type": "object", "title": "GetProductListRequest" }, "XingtuCreatorPriceType": { "type": "integer", "enum": [ 1, 2, 3 ], "title": "XingtuCreatorPriceType" }, "VideoSearchRequest": { "properties": { "cookie": { "title": "Cookie", "description": "User www.douyin.com web Cookie", "nullable": true, "type": "string" }, "keyword": { "type": "string", "title": "Keyword", "description": "Video title or keyword", "example": "major" }, "cursor": { "title": "Cursor", "description": "Pagination cursor, 0 for first page", "default": 0, "example": 0, "nullable": true, "type": "integer" }, "count": { "title": "Count", "description": "Page size", "default": 12, "example": 12, "nullable": true, "type": "integer" } }, "type": "object", "required": [ "keyword" ], "title": "VideoSearchRequest", "description": "Video Search Request Model (by title/keyword)" }, "Body_get_ip_activity_list_api_v1_douyin_xingtu_v2_get_ip_activity_list_post": { "properties": { "query_start_time": { "type": "string", "title": "Query Start Time", "description": "Query start timestamp" }, "query_end_time": { "type": "string", "title": "Query End Time", "description": "Query end timestamp" }, "industry_id_list": { "title": "Industry Id List", "description": "Industry ID list", "nullable": true, "items": { "type": "string" }, "type": "array" }, "category_list": { "title": "Category List", "description": "IP category list", "nullable": true, "items": { "type": "integer" }, "type": "array" }, "status_list": { "title": "Status List", "description": "IP status list", "nullable": true, "items": { "type": "integer" }, "type": "array" } }, "type": "object", "required": [ "query_start_time", "query_end_time" ], "title": "Body_get_ip_activity_list_api_v1_douyin_xingtu_v2_get_ip_activity_list_post" }, "ItemAnalysisOverviewRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "start_date": { "type": "string", "title": "Start Date", "description": "Start date (format YYYYMMDD)", "example": "20250713" }, "end_date": { "type": "string", "title": "End Date", "description": "End date (format YYYYMMDD)", "example": "20251011" }, "genres": { "items": { "type": "integer" }, "type": "array", "title": "Genres", "description": "Genres list: 1=video under 1 min, 2=1-3 min video, 3=3-5 min video, 4=video over 5 min, 5=image+text, 8=long-form article", "default": [ 1, 2, 3, 4, 5, 8 ], "example": [ 1, 2, 3, 4, 5, 8 ] }, "primary_verticals": { "items": { "type": "string" }, "type": "array", "title": "Primary Verticals", "description": "Primary verticals list (obtained from the involved_vertical endpoint)", "example": [ "Animal" ] } }, "type": "object", "required": [ "cookie", "start_date", "end_date", "primary_verticals" ], "title": "ItemAnalysisOverviewRequest", "description": "Item Analysis Overview Request Model" }, "Body_get_top_ads_spotlight_api_v1_tiktok_ads_get_top_ads_spotlight_post": { "properties": { "industry": { "type": "string", "title": "Industry", "description": "Industry ID (optional)" }, "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "limit": { "type": "integer", "title": "Limit", "description": "Items per page", "default": 20 }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "title": "Body_get_top_ads_spotlight_api_v1_tiktok_ads_get_top_ads_spotlight_post" }, "PromotedAccountsRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User www.douyin.com web Cookie", "example": "Your_Cookie_Here" }, "limit": { "title": "Limit", "description": "Number of accounts per page", "default": 20, "example": 20, "nullable": true, "type": "integer" }, "cursor": { "title": "Cursor", "description": "Pagination cursor, empty for first page, then pass the `sortID` value from the previous response", "default": "", "example": "", "nullable": true, "type": "string" } }, "type": "object", "required": [ "cookie" ], "title": "PromotedAccountsRequest", "description": "Promoted Accounts Request Model" }, "SimilarReq": { "properties": { "user_id": { "type": "string", "title": "User Id", "description": "Target blogger user ID", "example": "5c668b3e0000000012021605" }, "page_num": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Page Num", "description": "Page", "default": 1, "example": 1 }, "page_size": { "type": "integer", "maximum": 4.0, "minimum": 1.0, "title": "Page Size", "description": "Page size, 1-4 (web fixed at 4)", "default": 4, "example": 4 } }, "additionalProperties": false, "type": "object", "required": [ "user_id" ], "title": "SimilarReq" }, "GetCreatorAccountInfoRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" } }, "type": "object", "title": "GetCreatorAccountInfoRequest" }, "GetViolationRecordRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "page": { "type": "integer", "title": "Page", "description": "Page Number", "default": 1 } }, "type": "object", "title": "GetViolationRecordRequest" }, "NotesV2Req": { "properties": { "user_id": { "type": "string", "title": "User Id", "description": "Blogger user ID", "example": "5c668b3e0000000012021605" }, "page_number": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "title": "Page Number", "description": "Page number, from 1", "default": 1, "example": 1 }, "page_size": { "type": "integer", "maximum": 8.0, "minimum": 1.0, "title": "Page Size", "description": "Page size, 1-8 (fixed at 8 on PGY web)", "default": 8, "example": 8 }, "note_type": { "type": "integer", "enum": [ 0, 1, 2 ], "title": "Note Type", "description": "Note type: 0=All types (default), 1=Image & text, 2=Video", "default": 0, "example": 0 }, "order_type": { "type": "integer", "enum": [ 1, 2, 3 ], "title": "Order Type", "description": "Sort: 1=Latest (default), 2=Most read, 3=Most engaged", "default": 1, "example": 1 } }, "additionalProperties": false, "type": "object", "required": [ "user_id" ], "title": "NotesV2Req" }, "FetchMultiVideoHighQualityPlayUrlRequest": { "properties": { "aweme_ids": { "type": "string", "title": "Aweme Ids", "description": "Video ID list, separated by commas, up to 50", "default": "7512756548356492544,7448118827402972455,7126745726494821640" }, "region": { "title": "Region", "description": "Optional, ISO country code (e.g. CN). Pass 'CN' for users in mainland China to get China-region CDN URLs for faster download.", "example": "CN", "nullable": true, "type": "string" } }, "type": "object", "title": "FetchMultiVideoHighQualityPlayUrlRequest" }, "Body_get_trends_hashtag_list_api_v1_tiktok_ads_get_trends_hashtag_list_post": { "properties": { "time_range": { "type": "integer", "title": "Time Range", "description": "Time range in days: 7/30/90", "default": 7 }, "country_code": { "type": "string", "title": "Country Code", "description": "Country/region code", "default": "US" }, "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "limit": { "type": "integer", "title": "Limit", "description": "Items per page", "default": 20 }, "industry_id": { "type": "integer", "title": "Industry Id", "description": "First-level industry ID (optional), e.g. 10000000000=Education" }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "title": "Body_get_trends_hashtag_list_api_v1_tiktok_ads_get_trends_hashtag_list_post" }, "UserSearchV2Request": { "properties": { "cookie": { "title": "Cookie", "description": "User www.douyin.com web Cookie", "nullable": true, "type": "string" }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword", "example": "Bo" }, "cursor": { "title": "Cursor", "description": "Pagination cursor, 0 for first page", "default": 0, "example": 0, "nullable": true, "type": "integer" }, "count": { "title": "Count", "description": "Page size", "default": 10, "example": 10, "nullable": true, "type": "integer" }, "scope": { "title": "Scope", "description": "Search scope", "default": 1, "example": 1, "nullable": true, "type": "integer" } }, "type": "object", "required": [ "keyword" ], "title": "UserSearchV2Request", "description": "DOU+ User Search V2 Request Model" }, "Body_multi_get_author_info_api_v1_douyin_xingtu_v2_multi_get_author_info_post": { "properties": { "author_ids": { "items": { "type": "string" }, "type": "array", "title": "Author Ids", "description": "Creator ID list, up to 50 per call" }, "platform_source": { "type": "integer", "title": "Platform Source", "description": "Platform source", "default": 1 }, "platform_channel": { "type": "integer", "title": "Platform Channel", "description": "Platform channel", "default": 1 } }, "type": "object", "required": [ "author_ids" ], "title": "Body_multi_get_author_info_api_v1_douyin_xingtu_v2_multi_get_author_info_post" }, "GetVideoToProductStatsRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "start_date": { "type": "string", "title": "Start Date", "description": "Query Start Date, e.g. '04-01-2025'", "default": "04-01-2025" }, "item_id": { "type": "string", "title": "Item Id", "description": "Video ID" }, "product_id": { "type": "string", "title": "Product Id", "description": "Product ID" } }, "type": "object", "required": [ "item_id", "product_id" ], "title": "GetVideoToProductStatsRequest" }, "UserSearchRequestV2": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Keyword", "default": "Cat" }, "cursor": { "type": "integer", "title": "Cursor", "description": "Offset cursor for pagination, obtained from the last response", "default": 0 } }, "type": "object", "title": "UserSearchRequestV2" }, "LiveSearchBody": { "properties": { "nickname_or_mids": { "title": "Nickname Or Mids", "description": "Search by creator nickname or UID", "nullable": true, "type": "string" }, "mids": { "title": "Mids", "description": "Batch exact match by UID", "nullable": true, "items": { "type": "integer" }, "type": "array" }, "is_brand_live": { "title": "Is Brand Live", "description": "Live stream type: 1=Content live stream, 0=Commerce live stream. Available filters differ between the two types.", "nullable": true, "type": "integer" }, "gender": { "title": "Gender", "description": "Anchor gender", "nullable": true, "type": "string" }, "region_id": { "title": "Region Id", "description": "Anchor primary residence region (level 1)", "nullable": true, "items": { "type": "integer" }, "type": "array" }, "second_region_id": { "title": "Second Region Id", "description": "Anchor primary residence region (level 2)", "nullable": true, "items": { "type": "integer" }, "type": "array" }, "min_fans_num": { "title": "Min Fans Num", "description": "Minimum follower count", "nullable": true, "type": "integer" }, "max_fans_num": { "title": "Max Fans Num", "description": "Maximum follower count", "nullable": true, "type": "integer" }, "fans_gender_tag": { "title": "Fans Gender Tag", "description": "Audience gender tag", "nullable": true, "items": { "type": "string" }, "type": "array" }, "fans_age_tag": { "title": "Fans Age Tag", "description": "Audience age tag", "nullable": true, "items": { "type": "string" }, "type": "array" }, "fans_region_tag": { "title": "Fans Region Tag", "description": "Audience region tag", "nullable": true, "items": { "type": "string" }, "type": "array" }, "live_subarea_id": { "title": "Live Subarea Id", "description": "Live area (second-level); see live_area_list for values", "nullable": true, "items": { "type": "integer" }, "type": "array" }, "partition_id": { "title": "Partition Id", "description": "Submission category (level 1)", "nullable": true, "type": "integer" }, "second_partition_id": { "title": "Second Partition Id", "description": "Submission category (level 2)", "nullable": true, "items": { "type": "integer" }, "type": "array" }, "min_popularity": { "title": "Min Popularity", "description": "Minimum average peak popularity per session in the last 30 days", "nullable": true, "type": "integer" }, "max_popularity": { "title": "Max Popularity", "description": "Maximum average peak popularity per session in the last 30 days", "nullable": true, "type": "integer" }, "live_audience_h_avg_30d_min": { "title": "Live Audience H Avg 30D Min", "description": "Minimum average hourly viewer count in the last 30 days", "nullable": true, "type": "integer" }, "live_audience_h_avg_30d_max": { "title": "Live Audience H Avg 30D Max", "description": "Maximum average hourly viewer count in the last 30 days", "nullable": true, "type": "integer" }, "live_danmu_h_avg_30d_min": { "title": "Live Danmu H Avg 30D Min", "description": "Minimum average hourly danmaku count in the last 30 days", "nullable": true, "type": "integer" }, "live_danmu_h_avg_30d_max": { "title": "Live Danmu H Avg 30D Max", "description": "Maximum average hourly danmaku count in the last 30 days", "nullable": true, "type": "integer" }, "live_guild_id": { "title": "Live Guild Id", "description": "Live streaming guild; see live_guild_drop for values", "nullable": true, "items": { "type": "integer" }, "type": "array" }, "high_potential_type": { "title": "High Potential Type", "description": "Registration status", "nullable": true, "type": "integer" }, "live_good_category": { "title": "Live Good Category", "description": "Primary commerce category; 0=all; valid values from live_good_category", "nullable": true, "type": "integer" }, "live_good_gmv": { "title": "Live Good Gmv", "description": "90-day GMV tier, 0=all", "nullable": true, "type": "integer" }, "order_by": { "title": "Order By", "description": "Sort field", "nullable": true, "type": "string" }, "sort": { "title": "Sort", "description": "Sort direction: desc or asc", "nullable": true, "type": "string" }, "page": { "title": "Page", "description": "Page number starting from 1; 20 items per page", "nullable": true, "type": "integer", "minimum": 1.0 } }, "additionalProperties": true, "type": "object", "title": "LiveSearchBody", "description": "Live collaboration marketplace filters. Supports creator attributes,\naudience demographics, live categories, content-live performance,\ncommerce categories, and GMV filters. Every field is optional, and\nadditional filter fields may be supplied." }, "VIPVideoModel": { "properties": { "bv_id": { "type": "string", "title": "Bv Id", "description": "Video ID", "example": "BV1y7411Q7Eq" }, "cid": { "type": "string", "title": "Cid", "description": "Video cid", "example": "171776208" }, "cookie": { "type": "string", "title": "Cookie", "description": "VIP User Cookie", "example": "your_vip_bilibili_cookie" } }, "type": "object", "required": [ "bv_id", "cid", "cookie" ], "title": "VIPVideoModel" }, "ChallengeSearchV2Request": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Keyword", "default": "Cat" }, "cursor": { "type": "integer", "title": "Cursor", "description": "Offset cursor for pagination, obtained from the last response", "default": 0 }, "sort_type": { "type": "string", "title": "Sort Type", "description": "Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest", "default": "0" }, "publish_time": { "type": "string", "title": "Publish Time", "description": "Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year", "default": "0" }, "filter_duration": { "type": "string", "title": "Filter Duration", "description": "Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes", "default": "0" }, "content_type": { "type": "string", "title": "Content Type", "description": "Content type: 0=All, 1=Video, 2=Picture, 3=Article", "default": "0" }, "search_id": { "type": "string", "title": "Search Id", "description": "Search ID for pagination, obtained from the last response", "default": "" }, "backtrace": { "type": "string", "title": "Backtrace", "description": "Backtrace for pagination, obtained from the last response", "default": "" } }, "type": "object", "title": "ChallengeSearchV2Request" }, "DataSummaryReq": { "properties": { "user_id": { "type": "string", "title": "User Id", "description": "Blogger user ID", "example": "5c668b3e0000000012021605" }, "business": { "type": "integer", "enum": [ 0, 1 ], "title": "Business", "description": "Note scope: 0=Organic notes (default), 1=Sponsored notes", "default": 0, "example": 0 } }, "additionalProperties": false, "type": "object", "required": [ "user_id" ], "title": "DataSummaryReq" }, "ItemAnalysisInvolvedVerticalRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "start_date": { "type": "string", "title": "Start Date", "description": "Start date (format YYYYMMDD)", "example": "20250713" }, "end_date": { "type": "string", "title": "End Date", "description": "End date (format YYYYMMDD)", "example": "20251011" } }, "type": "object", "required": [ "cookie", "start_date", "end_date" ], "title": "ItemAnalysisInvolvedVerticalRequest", "description": "Item Analysis Involved Vertical Request Model" }, "ItemSearchKeywordRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "item_id": { "type": "string", "title": "Item Id", "description": "Item ID", "example": "7559536212910853422" } }, "type": "object", "required": [ "cookie", "item_id" ], "title": "ItemSearchKeywordRequest", "description": "Item Search Keywords Request Model" }, "Body_get_ad_interactive_analysis_api_v1_tiktok_ads_get_ad_interactive_analysis_post": { "properties": { "material_id": { "type": "string", "title": "Material Id", "description": "Ad material ID" }, "metric_type": { "type": "string", "title": "Metric Type", "description": "Analysis type (ctr, cvr, clicks, conversion, remain)", "default": "remain" }, "period_type": { "type": "integer", "title": "Period Type", "description": "Period type (days)", "default": 180 }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "required": [ "material_id" ], "title": "Body_get_ad_interactive_analysis_api_v1_tiktok_ads_get_ad_interactive_analysis_post" }, "CoreDataReq": { "properties": { "user_id": { "type": "string", "title": "User Id", "description": "Blogger user ID", "example": "5c668b3e0000000012021605" }, "business": { "type": "integer", "enum": [ 0, 1 ], "title": "Business", "description": "Note scope: 0=Organic notes (default), 1=Sponsored notes", "default": 0, "example": 0 }, "note_type": { "type": "integer", "enum": [ 1, 2, 3 ], "title": "Note Type", "description": "Note type: 3=Image & text + Video (default), 1=Image & text, 2=Video", "default": 3, "example": 3 }, "date_type": { "type": "integer", "enum": [ 1, 2 ], "title": "Date Type", "description": "Date range: 1=last 30 days (default), 2=last 90 days", "default": 1, "example": 1 }, "advertise_switch": { "type": "integer", "enum": [ 0, 1 ], "title": "Advertise Switch", "description": "Traffic type: 1=All (including sponsored), 0=Organic only", "default": 1, "example": 1 } }, "additionalProperties": false, "type": "object", "required": [ "user_id" ], "title": "CoreDataReq" }, "Body_get_top_contents_list_api_v1_tiktok_ads_get_top_contents_list_post": { "properties": { "period_end_timestamp": { "type": "integer", "title": "Period End Timestamp", "description": "The caller must generate this 10-digit Unix timestamp in seconds from the target ranking date, for example 1785024000; do not pass 0 because it returns an empty result", "example": 1785024000 }, "period_dimension": { "type": "integer", "title": "Period Dimension", "description": "Period dimension: 1/3/5", "default": 3, "example": 1 }, "country_code": { "type": "string", "title": "Country Code", "description": "Country/region code", "default": "US" }, "content_label_ids": { "type": "string", "title": "Content Label Ids", "description": "Content label IDs, comma separated", "default": "" }, "order_by_metric": { "type": "integer", "title": "Order By Metric", "description": "Order by metric: 1=Views, 2=Engagement rate, 3=6-second completion rate", "default": 1, "example": 1 }, "organic_only": { "type": "boolean", "title": "Organic Only", "description": "Organic content only", "default": false }, "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "limit": { "type": "integer", "title": "Limit", "description": "Items per page, max 100", "default": 20 }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "required": [ "period_end_timestamp" ], "title": "Body_get_top_contents_list_api_v1_tiktok_ads_get_top_contents_list_post" }, "XingtuContentSearchTimeRange": { "type": "integer", "enum": [ 30, 90, 180 ], "title": "XingtuContentSearchTimeRange" }, "Body_get_item_report_th_analysis_api_v1_douyin_xingtu_v2_get_item_report_th_analysis_post": { "properties": { "item_id": { "type": "string", "title": "Item Id", "description": "Video (item) ID" } }, "type": "object", "required": [ "item_id" ], "title": "Body_get_item_report_th_analysis_api_v1_douyin_xingtu_v2_get_item_report_th_analysis_post" }, "Body_get_creators_card_api_v1_tiktok_ads_get_creators_card_post": { "properties": { "tt_uids": { "items": { "type": "string" }, "type": "array", "title": "Tt Uids", "description": "Creator ID list", "default": [ "103641138313531392" ] }, "need_loader_list": { "items": { "type": "integer" }, "type": "array", "title": "Need Loader List", "description": "Data module IDs, empty for all", "example": [ 101, 102, 103, 104, 105, 106, 107, 125 ] }, "creator_type": { "type": "integer", "title": "Creator Type", "description": "Creator type", "default": 2 }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "title": "Body_get_creators_card_api_v1_tiktok_ads_get_creators_card_post" }, "GiftQuery": { "properties": { "gift_id": { "type": "string", "title": "Gift Id", "description": "Gift ID", "example": "10001" } }, "type": "object", "required": [ "gift_id" ], "title": "GiftQuery", "description": "Single Gift ID query model\n\nArgs:\n gift_id (str): Gift ID, e.g. \"10001\"" }, "Body_fetch_hot_total_low_fan_list_api_v1_douyin_billboard_fetch_hot_total_low_fan_list_post": { "properties": { "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 1=last 1 hour, 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword for filtering the leaderboard; empty=all", "default": "" }, "tags": { "items": { "$ref": "#/components/schemas/BillboardTag" }, "type": "array", "title": "Tags", "description": "Vertical tag filter; leave empty for all. Tag IDs are obtained from the fetch_content_tag endpoint.", "example": [ { "children": [ { "value": 62808 }, { "value": 62804 } ], "value": 628 } ] } }, "type": "object", "title": "Body_fetch_hot_total_low_fan_list_api_v1_douyin_billboard_fetch_hot_total_low_fan_list_post" }, "AnalyseStatsRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User www.douyin.com web Cookie", "example": "Your_Cookie_Here" }, "query": { "additionalProperties": true, "type": "object", "title": "Query", "description": "Analysis query object. Key fields: startTime, endTime (second timestamp string); analysisType (1=account, 2=video, 3=live); authorSecIdList (account sec_uid list); statusList (delivery status filter); metrics (metric list, e.g. stat_cost, total_play, total_like, dy_comment, dy_share, dy_follow); SecondaryTargetIds; CollectWayIds. graph extra: dimension; detail extra: page, limit, orderByMetric, orderByType; video/live extra: liveRoomIdList", "example": { "CollectWayIds": [], "SecondaryTargetIds": [], "analysisType": 1, "authorSecIdList": [], "endTime": "1781625599", "metrics": [ "stat_cost", "total_play", "play_duration_5s_rate", "total_like", "dy_comment", "dy_share", "dy_home_visited", "dy_follow" ], "startTime": "1780934400", "statusList": [] } } }, "type": "object", "required": [ "cookie", "query" ], "title": "AnalyseStatsRequest", "description": "Delivery Analysis Request Model (overview / graph / detail, query passthrough)" }, "GetProductRelatedVideosRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "start_date": { "type": "string", "title": "Start Date", "description": "Query Start Date, e.g. '04-01-2025'", "default": "04-01-2025" }, "item_id": { "type": "string", "title": "Item Id", "description": "Video ID" }, "product_id": { "type": "string", "title": "Product Id", "description": "Product ID" } }, "type": "object", "required": [ "item_id", "product_id" ], "title": "GetProductRelatedVideosRequest" }, "Body_get_ad_keyframe_analysis_api_v1_tiktok_ads_get_ad_keyframe_analysis_post": { "properties": { "material_id": { "type": "string", "title": "Material Id", "description": "Ad material ID" }, "metric": { "type": "string", "title": "Metric", "description": "Analysis metric (retain_ctr, retain_cvr, click_cnt, convert_cnt, play_retain_cnt)", "default": "retain_ctr" }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "required": [ "material_id" ], "title": "Body_get_ad_keyframe_analysis_api_v1_tiktok_ads_get_ad_keyframe_analysis_post" }, "TikTok_APP_V3_Home_Feed": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User's own cookie, optional parameter, used for personalized recommendations of interface return data.", "default": "" } }, "type": "object", "title": "TikTok_APP_V3_Home_Feed" }, "GetLiveOverviewRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "start_date": { "type": "string", "title": "Start Date", "description": "Query Start Date, e.g. '04-01-2025'", "default": "04-01-2025" } }, "type": "object", "title": "GetLiveOverviewRequest" }, "Body_get_query_suggestions_api_v1_tiktok_ads_get_query_suggestions_post": { "properties": { "query": { "type": "string", "title": "Query", "description": "Leave empty for scenario 1 (popular suggestions); input a keyword for scenario 2" }, "count": { "type": "integer", "title": "Count", "description": "Suggestion count", "default": 50 }, "scenario": { "type": "integer", "title": "Scenario", "description": "Scene type: 1=Popular suggestions, 2=Related keyword suggestions", "default": 1 }, "country_code": { "type": "string", "title": "Country Code", "description": "Optional country/region code" }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "title": "Body_get_query_suggestions_api_v1_tiktok_ads_get_query_suggestions_post" }, "XingtuCreatorSearchType": { "type": "integer", "enum": [ 2, 3 ], "title": "XingtuCreatorSearchType" }, "SecTokenRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User www.douyin.com web Cookie", "example": "Your_Cookie_Here" } }, "type": "object", "required": [ "cookie" ], "title": "SecTokenRequest", "description": "Sec Token Request Model (cookie only)" }, "NoteDetailReq": { "properties": { "note_id": { "type": "string", "title": "Note Id", "description": "Note ID", "example": "6a20edfa0000000021020951" } }, "additionalProperties": false, "type": "object", "required": [ "note_id" ], "title": "NoteDetailReq" }, "ItemListRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "count": { "type": "integer", "title": "Count", "description": "Count per page (max 100)", "default": 10, "example": 10 }, "order_by": { "type": "integer", "title": "Order By", "description": "Order by (1-26): 1=Publish time (newest first), 2=Publish time (oldest first), 3=Views (desc), 4=Views (asc), 5=Likes (desc), 6=Likes (asc), 7=Comments (desc), 8=Comments (asc), 9=Shares (desc), 10=Shares (asc), 11=Favorites (desc), 12=Favorites (asc), 13=2s bounce rate (desc), 14=2s bounce rate (asc), 15=5s completion rate (desc), 16=5s completion rate (asc), 17=Completion rate (desc), 18=Completion rate (asc), 19=Cover CTR (desc), 20=Cover CTR (asc), 21=Avg watch duration (desc), 22=Avg watch duration (asc), 23=Profile visits (desc), 24=Profile visits (asc), 25=Follower growth (desc), 26=Follower growth (asc)", "default": 1, "example": 1 }, "fields": { "type": "string", "title": "Fields", "description": "Fields to return", "default": "metrics,review,visibility", "example": "metrics,review,visibility" }, "need_cooperation": { "type": "boolean", "title": "Need Cooperation", "description": "Need cooperation info", "default": true, "example": true }, "start_time": { "type": "integer", "title": "Start Time", "description": "Start timestamp (milliseconds)", "example": 1758988800000 }, "end_time": { "type": "integer", "title": "End Time", "description": "End time timestamp (milliseconds)", "example": 1760198399000 }, "need_long_article": { "type": "boolean", "title": "Need Long Article", "description": "Include long articles", "default": true, "example": true }, "cursor": { "title": "Cursor", "description": "Pagination cursor (optional)", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "cookie", "start_time", "end_time" ], "title": "ItemListRequest", "description": "Item List Request Model" }, "UserPostsRequest": { "properties": { "cookie": { "title": "Cookie", "description": "User www.douyin.com web Cookie", "nullable": true, "type": "string" }, "sec_uid": { "type": "string", "title": "Sec Uid", "description": "User sec_uid", "example": "MS4wLjABAAAA9fe7vGjwyiaOjL6REhX8rvmSb32VzA_XsKca9F3_YSHRXlEqgT2cpX54WGbtgnsA" }, "cursor": { "title": "Cursor", "description": "Pagination cursor (string), \"0\" for first page, then pass the cursor from the previous response", "default": "0", "example": "0", "nullable": true, "type": "string" }, "count": { "title": "Count", "description": "Page size", "default": 10, "example": 10, "nullable": true, "type": "integer" } }, "type": "object", "required": [ "sec_uid" ], "title": "UserPostsRequest", "description": "User Homepage Posts Request Model" }, "Body_get_ad_percentile_api_v1_tiktok_ads_get_ad_percentile_post": { "properties": { "material_id": { "type": "string", "title": "Material Id", "description": "Ad material ID" }, "metric": { "type": "string", "title": "Metric", "description": "Analysis metric (ctr_percentile, time_attr_conversion_rate_percentile, click_cnt_percentile, time_attr_convert_cnt_percentile, show_cnt_percentile)", "default": "ctr_percentile" }, "period_type": { "type": "integer", "title": "Period Type", "description": "Time period (days)", "default": 180 }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "required": [ "material_id" ], "title": "Body_get_ad_percentile_api_v1_tiktok_ads_get_ad_percentile_post" }, "GetAccountHealthRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" } }, "type": "object", "title": "GetAccountHealthRequest" }, "GeneralSearchV3Request": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword", "default": "Cat" }, "offset": { "type": "integer", "title": "Offset", "description": "Offset cursor for pagination, obtained from data.pagination.offset of the last response, 0 for the first request", "default": 0 }, "page": { "type": "integer", "title": "Page", "description": "Page number, 1-200, start with 1 and increment by 1 each time", "default": 1 }, "search_id": { "type": "string", "title": "Search Id", "description": "Search ID, obtained from data.pagination.search_id of the last response, empty for the first request", "default": "" }, "backtrace": { "type": "string", "title": "Backtrace", "description": "Backtrace, obtained from data.pagination.backtrace of the last response, empty for the first request", "default": "" } }, "type": "object", "title": "GeneralSearchV3Request" }, "Body_fetch_hot_account_list_api_v1_douyin_billboard_fetch_hot_account_list_post": { "properties": { "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "page_num": { "type": "integer", "title": "Page Num", "description": "Page number, default 1", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page, default 10", "default": 10 }, "query_tag": { "$ref": "#/components/schemas/BillboardTag", "description": "Vertical tag filter; leave empty for all. Tag IDs are obtained from the fetch_content_tag endpoint.", "example": { "children": [ { "value": 62808 }, { "value": 62804 } ], "value": 628 } } }, "type": "object", "title": "Body_fetch_hot_account_list_api_v1_douyin_billboard_fetch_hot_account_list_post" }, "Body_get_recommended_ads_api_v1_tiktok_ads_get_recommended_ads_post": { "properties": { "material_id": { "type": "string", "title": "Material Id", "description": "Ad material ID" }, "industry": { "type": "string", "title": "Industry", "description": "Industry ID", "default": "25308000000" }, "country_code": { "type": "string", "title": "Country Code", "description": "Country code", "default": "US" }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "required": [ "material_id" ], "title": "Body_get_recommended_ads_api_v1_tiktok_ads_get_recommended_ads_post" }, "Body_fetch_hot_total_high_topic_list_api_v1_douyin_billboard_fetch_hot_total_high_topic_list_post": { "properties": { "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 1=last 1 hour, 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword for filtering the leaderboard; empty=all", "default": "" }, "tags": { "items": { "$ref": "#/components/schemas/BillboardTag" }, "type": "array", "title": "Tags", "description": "Vertical tag filter; leave empty for all. Tag IDs are obtained from the fetch_content_tag endpoint.", "example": [ { "children": [ { "value": 62808 }, { "value": 62804 } ], "value": 628 } ] } }, "type": "object", "title": "Body_fetch_hot_total_high_topic_list_api_v1_douyin_billboard_fetch_hot_total_high_topic_list_post" }, "ChallengeSuggestRequest": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Keyword, e.g., 'game'", "default": "Gaming" } }, "type": "object", "title": "ChallengeSuggestRequest" }, "GetShowcaseProductListRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "count": { "type": "integer", "title": "Count", "description": "Page Size", "default": 20 }, "offset": { "type": "integer", "title": "Offset", "description": "Offset", "default": 0 } }, "type": "object", "title": "GetShowcaseProductListRequest" }, "Body_fetch_hot_total_video_list_api_v1_douyin_billboard_fetch_hot_total_video_list_post": { "properties": { "page": { "type": "integer", "title": "Page", "description": "Page number, default 1", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page, default 10", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 1=last 1 hour, 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "sub_type": { "type": "integer", "title": "Sub Type", "description": "Ranking category: 1001 Overall Video, 1002 Low-follower Viral, 1003 High Completion Rate, 1004 High Follower Growth Rate, 1005 High Like Rate", "default": 1001 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword for filtering the leaderboard; empty=all", "default": "" }, "tags": { "items": { "$ref": "#/components/schemas/BillboardTag" }, "type": "array", "title": "Tags", "description": "Vertical tag filter; leave empty for all. Tag IDs are obtained from the fetch_content_tag endpoint.", "example": [ { "children": [ { "value": 62808 }, { "value": 62804 } ], "value": 628 } ] } }, "type": "object", "title": "Body_fetch_hot_total_video_list_api_v1_douyin_billboard_fetch_hot_total_video_list_post" }, "ExperienceSearchRequest": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Keyword", "default": "Cat" }, "cursor": { "type": "integer", "title": "Cursor", "description": "Offset cursor for pagination, obtained from the last response", "default": 0 }, "sort_type": { "type": "string", "title": "Sort Type", "description": "Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest", "default": "0" }, "publish_time": { "type": "string", "title": "Publish Time", "description": "Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year", "default": "0" }, "filter_duration": { "type": "string", "title": "Filter Duration", "description": "Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes", "default": "0" }, "content_type": { "type": "string", "title": "Content Type", "description": "Content type: 0=All, 1=Video, 2=Picture, 3=Article", "default": "0" }, "search_id": { "type": "string", "title": "Search Id", "description": "Search ID for pagination, obtained from the last response", "default": "" }, "backtrace": { "type": "string", "title": "Backtrace", "description": "Backtrace for pagination, obtained from the last response", "default": "" } }, "type": "object", "title": "ExperienceSearchRequest" }, "BatchGiftQuery": { "properties": { "gift_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 1000, "minItems": 1, "title": "Gift Ids", "description": "Gift ID list, recommend 50/call for best value ($0.025), auto-process first 50 if more than 50", "example": [ "10001", "10002", "10003" ] } }, "type": "object", "required": [ "gift_ids" ], "title": "BatchGiftQuery", "description": "Batch Gift ID query model\nBilling: $0.025 per call; recommended 50 IDs per request for best value\n\nArgs:\n gift_ids (list[str]): List of gift IDs, recommended 50 per request, e.g. [\"10001\", \"10002\", \"10003\"]" }, "CostEstimateRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User www.douyin.com web Cookie", "example": "Your_Cookie_Here" }, "sec_uid": { "type": "string", "title": "Sec Uid", "description": "Delivery account sec_uid", "example": "MS4wLjABAAAA9fe7vGjwyiaOjL6REhX8rvmSb32VzA_XsKca9F3_YSHRXlEqgT2cpX54WGbtgnsA" }, "item_ids": { "type": "string", "title": "Item Ids", "description": "Item ID(s), comma separated", "example": "7651166972160446949" }, "target_id": { "title": "Target Id", "description": "Promotion target ID. 31=Likes & Comments, 32=Followers, 33=Profile visits, 37=Video views, 45=Comment link clicks, 78=High-quality engagement", "default": 31, "example": 31, "nullable": true, "type": "integer" } }, "type": "object", "required": [ "cookie", "sec_uid", "item_ids" ], "title": "CostEstimateRequest", "description": "DOU+ Cost Estimation Request Model" }, "XingtuToutiaoPriceType": { "type": "integer", "enum": [ 11 ], "title": "XingtuToutiaoPriceType" }, "Body_fetch_hot_total_search_list_api_v1_douyin_billboard_fetch_hot_total_search_list_post": { "properties": { "page_num": { "type": "integer", "title": "Page Num", "description": "Page number", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 1=last 1 hour, 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword", "default": "Douyin" } }, "type": "object", "title": "Body_fetch_hot_total_search_list_api_v1_douyin_billboard_fetch_hot_total_search_list_post" }, "Body_fetch_user_collects_api_v1_douyin_web_fetch_user_collects_post": { "properties": { "max_cursor": { "type": "integer", "title": "Max Cursor", "description": "Maximum cursor", "default": 0 }, "counts": { "type": "integer", "title": "Counts", "description": "Number per page", "default": 20 }, "cookie": { "type": "string", "title": "Cookie", "description": "Your web version of Douyin Cookie" } }, "type": "object", "required": [ "cookie" ], "title": "Body_fetch_user_collects_api_v1_douyin_web_fetch_user_collects_post" }, "TalentByCategoryRequest": { "properties": { "cookie": { "title": "Cookie", "description": "User www.douyin.com web Cookie", "nullable": true, "type": "string" }, "name": { "title": "Name", "description": "Category name or keyword (from the talent category endpoint); empty for all", "default": "", "example": "Music", "nullable": true, "type": "string" }, "page": { "title": "Page", "description": "Page index from 0", "default": 0, "example": 0, "nullable": true, "type": "integer" }, "limit": { "title": "Limit", "description": "Page size", "default": 20, "example": 20, "nullable": true, "type": "integer" } }, "type": "object", "title": "TalentByCategoryRequest", "description": "Search Talents By Category Request Model" }, "Body_fetch_hot_calendar_list_api_v1_douyin_billboard_fetch_hot_calendar_list_post": { "properties": { "city_code": { "type": "string", "title": "City Code", "description": "City code from city list; leave empty for all", "default": "" }, "category_code": { "type": "string", "title": "Category Code", "description": "Hot-spot ranking category code; obtained from the hot-spot ranking categories; leave empty for all", "default": "" }, "end_date": { "type": "integer", "title": "End Date", "description": "Snapshot end time, 10-digit Unix timestamp format", "default": 1735488000 }, "start_date": { "type": "integer", "title": "Start Date", "description": "Snapshot start time, 10-digit timestamp format", "default": 1734902400 } }, "type": "object", "title": "Body_fetch_hot_calendar_list_api_v1_douyin_billboard_fetch_hot_calendar_list_post" }, "Body_get_trends_hashtag_detail_api_v1_tiktok_ads_get_trends_hashtag_detail_post": { "properties": { "hashtag_id": { "type": "string", "title": "Hashtag Id", "description": "Hashtag ID" }, "time_range": { "type": "integer", "title": "Time Range", "description": "Time range in days: 7/30/90", "default": 90 }, "country_code": { "type": "string", "title": "Country Code", "description": "Country/region code", "default": "US" }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "required": [ "hashtag_id" ], "title": "Body_get_trends_hashtag_detail_api_v1_tiktok_ads_get_trends_hashtag_detail_post" }, "ItemWatchTrendRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "item_id": { "type": "string", "title": "Item Id", "description": "Item ID", "example": "7559536212910853422" }, "analysis_type": { "type": "integer", "title": "Analysis Type", "description": "Analysis type: 1=Retention, 2=Like, 7=Bounce", "default": 1, "example": 1 } }, "type": "object", "required": [ "cookie", "item_id" ], "title": "ItemWatchTrendRequest", "description": "Item Watch Trend Analysis Request Model" }, "ItemPlaySourceRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "item_id": { "type": "string", "title": "Item Id", "description": "Item ID", "example": "7559536212910853422" } }, "type": "object", "required": [ "cookie", "item_id" ], "title": "ItemPlaySourceRequest", "description": "Item Play Source Statistics Request Model" }, "ItemAnalysisItemPerformanceRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "start_date": { "type": "string", "title": "Start Date", "description": "Start date (format YYYYMMDD)", "example": "20250713" }, "end_date": { "type": "string", "title": "End Date", "description": "End date (format YYYYMMDD)", "example": "20251011" }, "genres": { "items": { "type": "integer" }, "type": "array", "title": "Genres", "description": "Genres list: 1=video under 1 min, 2=1-3 min video, 3=3-5 min video, 4=video over 5 min, 5=image+text, 8=long-form article", "default": [ 1, 2, 3, 4, 5, 8 ], "example": [ 2, 3, 4, 5, 8 ] }, "primary_verticals": { "items": { "type": "string" }, "type": "array", "title": "Primary Verticals", "description": "Primary verticals list (obtained from the involved_vertical endpoint)", "example": [ "Animal" ] }, "metric_type": { "type": "integer", "title": "Metric Type", "description": "Metric type: 1=Views, 2=Likes, 3=Comments, 4=Shares", "default": 1, "example": 1 } }, "type": "object", "required": [ "cookie", "start_date", "end_date", "primary_verticals" ], "title": "ItemAnalysisItemPerformanceRequest", "description": "Item Analysis Item Performance Request Model" }, "Body_fetch_user_collection_videos_api_v1_douyin_web_fetch_user_collection_videos_post": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "Your web version of Douyin Cookie" }, "max_cursor": { "type": "integer", "title": "Max Cursor", "description": "Maximum cursor", "default": 0 }, "counts": { "type": "integer", "title": "Counts", "description": "Number per page", "default": 20 } }, "type": "object", "required": [ "cookie" ], "title": "Body_fetch_user_collection_videos_api_v1_douyin_web_fetch_user_collection_videos_post" }, "Body_get_top_contents_item_detail_api_v1_tiktok_ads_get_top_contents_item_detail_post": { "properties": { "item_id": { "type": "string", "title": "Item Id", "description": "Video item ID" }, "period_end_timestamp": { "type": "integer", "title": "Period End Timestamp", "description": "The caller must generate this 10-digit Unix timestamp in seconds from the target ranking date, for example 1785024000; do not pass 0 because it returns an empty result", "example": 1785024000 }, "period_dimension": { "type": "integer", "title": "Period Dimension", "description": "Period dimension: 1/3/5", "default": 3, "example": 1 }, "country_code": { "type": "string", "title": "Country Code", "description": "Country code of the ranking", "default": "US" }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "required": [ "item_id", "period_end_timestamp" ], "title": "Body_get_top_contents_item_detail_api_v1_tiktok_ads_get_top_contents_item_detail_post" }, "MultiSearchRequest": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Keyword", "default": "Cat" }, "cursor": { "type": "integer", "title": "Cursor", "description": "Offset cursor for pagination, obtained from the last response", "default": 0 }, "sort_type": { "type": "string", "title": "Sort Type", "description": "Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest", "default": "0" }, "publish_time": { "type": "string", "title": "Publish Time", "description": "Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year", "default": "0" }, "filter_duration": { "type": "string", "title": "Filter Duration", "description": "Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes", "default": "0" }, "content_type": { "type": "string", "title": "Content Type", "description": "Content type: 0=All, 1=Video, 2=Picture, 3=Article", "default": "0" }, "search_id": { "type": "string", "title": "Search Id", "description": "Search ID for pagination, obtained from the last response", "default": "" }, "backtrace": { "type": "string", "title": "Backtrace", "description": "Backtrace for pagination, obtained from the last response", "default": "" } }, "type": "object", "title": "MultiSearchRequest" }, "ChallengePostRequest": { "properties": { "challenge_id": { "type": "string", "title": "Challenge Id", "description": "Challenge ID", "default": "1608846127610893" }, "sort_type": { "type": "integer", "title": "Sort Type", "description": "Sort type", "default": 0 }, "cursor": { "type": "integer", "title": "Cursor", "description": "Cursor", "default": 0 }, "count": { "type": "integer", "title": "Count", "description": "Count", "default": 20 }, "cookie": { "type": "string", "title": "Cookie", "description": "User provided Cookie", "default": "" } }, "type": "object", "title": "ChallengePostRequest" }, "Body_multi_get_item_stats_api_v1_douyin_xingtu_v2_multi_get_item_stats_post": { "properties": { "item_ids": { "items": { "type": "string" }, "type": "array", "title": "Item Ids", "description": "Video (item) ID list, up to 20 per call" }, "platform_source": { "type": "integer", "title": "Platform Source", "description": "Platform source", "default": 1 }, "need_cover_url": { "type": "boolean", "title": "Need Cover Url", "description": "Whether to return cover URL", "default": true } }, "type": "object", "required": [ "item_ids" ], "title": "Body_multi_get_item_stats_api_v1_douyin_xingtu_v2_multi_get_item_stats_post" }, "GetVideoListRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "start_date": { "type": "string", "title": "Start Date", "description": "Query Start Date, e.g. '04-01-2025'", "default": "04-01-2025" }, "page": { "type": "integer", "title": "Page", "description": "Page Number", "default": 0 }, "rules": { "type": "string", "title": "Rules", "description": "List sorting rule, default is by publish time", "default": "VIDEO_LIST_PUBLISH_TIME" } }, "type": "object", "title": "GetVideoListRequest" }, "Body_fetch_hot_total_high_like_list_api_v1_douyin_billboard_fetch_hot_total_high_like_list_post": { "properties": { "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 1=last 1 hour, 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword for filtering the leaderboard; empty=all", "default": "" }, "tags": { "items": { "$ref": "#/components/schemas/BillboardTag" }, "type": "array", "title": "Tags", "description": "Vertical tag filter; leave empty for all. Tag IDs are obtained from the fetch_content_tag endpoint.", "example": [ { "children": [ { "value": 62808 }, { "value": 62804 } ], "value": 628 } ] } }, "type": "object", "title": "Body_fetch_hot_total_high_like_list_api_v1_douyin_billboard_fetch_hot_total_high_like_list_post" }, "Body_fetch_hot_total_topic_list_api_v1_douyin_billboard_fetch_hot_total_topic_list_post": { "properties": { "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 1=last 1 hour, 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword for filtering the leaderboard; empty=all", "default": "" }, "tags": { "items": { "$ref": "#/components/schemas/BillboardTag" }, "type": "array", "title": "Tags", "description": "Vertical tag filter; leave empty for all. Tag IDs are obtained from the fetch_content_tag endpoint.", "example": [ { "children": [ { "value": 62808 }, { "value": 62804 } ], "value": 628 } ] } }, "type": "object", "title": "Body_fetch_hot_total_topic_list_api_v1_douyin_billboard_fetch_hot_total_topic_list_post" }, "Body_fetch_hot_total_high_search_list_api_v1_douyin_billboard_fetch_hot_total_high_search_list_post": { "properties": { "page_num": { "type": "integer", "title": "Page Num", "description": "Page number", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 1=last 1 hour, 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword", "default": "Douyin" } }, "type": "object", "title": "Body_fetch_hot_total_high_search_list_api_v1_douyin_billboard_fetch_hot_total_high_search_list_post" }, "XingtuAnchorPriceType": { "type": "integer", "enum": [ 9 ], "title": "XingtuAnchorPriceType" }, "ItemListDownloadRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "min_cursor": { "type": "integer", "title": "Min Cursor", "description": "Min cursor (start timestamp in milliseconds)", "example": 1752336000000 }, "max_cursor": { "type": "integer", "title": "Max Cursor", "description": "Max cursor (end timestamp in milliseconds)", "example": 1760198399000 }, "type_filters": { "items": { "type": "integer" }, "type": "array", "title": "Type Filters", "description": "Type filters: 1=video under 1 min, 2=1-3 min video, 3=3-5 min video, 4=video over 5 min, 5=image+text, 8=long-form article", "default": [ 1, 2, 3, 4, 5, 8 ], "example": [ 2, 3, 4, 5, 1, 8 ] }, "need_long_article": { "type": "boolean", "title": "Need Long Article", "description": "Include long articles", "default": true, "example": true } }, "type": "object", "required": [ "cookie", "min_cursor", "max_cursor" ], "title": "ItemListDownloadRequest", "description": "Item List Download Request Model" }, "MusicSearchRequest": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Keyword", "default": "Cat" }, "cursor": { "type": "integer", "title": "Cursor", "description": "Offset cursor for pagination, obtained from the last response", "default": 0 }, "sort_type": { "type": "string", "title": "Sort Type", "description": "Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest", "default": "0" }, "publish_time": { "type": "string", "title": "Publish Time", "description": "Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year", "default": "0" }, "filter_duration": { "type": "string", "title": "Filter Duration", "description": "Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes", "default": "0" }, "content_type": { "type": "string", "title": "Content Type", "description": "Content type: 0=All, 1=Video, 2=Picture, 3=Article", "default": "0" }, "search_id": { "type": "string", "title": "Search Id", "description": "Search ID for pagination, obtained from the last response", "default": "" }, "backtrace": { "type": "string", "title": "Backtrace", "description": "Backtrace for pagination, obtained from the last response", "default": "" } }, "type": "object", "title": "MusicSearchRequest" }, "ResponseModel": { "properties": { "code": { "type": "integer", "title": "Code", "description": "HTTP status code", "default": 200 }, "request_id": { "title": "Request Id", "description": "Unique request identifier", "nullable": true, "type": "string" }, "message": { "type": "string", "title": "Message", "description": "Response message (EN-US)", "default": "Request successful. This request will incur a charge." }, "message_zh": { "type": "string", "title": "Message Zh", "description": "Response message (ZH-CN)", "default": "Request successful; this request will be billed." }, "support": { "type": "string", "title": "Support", "description": "Support message", "default": "Discord: https://discord.gg/aMEAS8Xsvz" }, "time": { "type": "string", "title": "Time", "description": "The time the response was generated" }, "time_stamp": { "type": "integer", "title": "Time Stamp", "description": "The timestamp the response was generated" }, "time_zone": { "type": "string", "title": "Time Zone", "description": "The timezone of the response time", "default": "America/Los_Angeles" }, "docs": { "title": "Docs", "description": "Link to the API Swagger documentation for this endpoint", "nullable": true, "type": "string" }, "cache_message": { "title": "Cache Message", "description": "Cache message (EN-US)", "default": "This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again.", "nullable": true, "type": "string" }, "cache_message_zh": { "title": "Cache Message Zh", "description": "Cache message (ZH-CN)", "default": "This response has been cached and can be viewed directly via the URL below; it is valid for 24 hours and accessing the cached link incurs no additional charge. The cache is for request tracing only and does not affect the freshness of the API data, nor will it be returned again through the API.", "nullable": true, "type": "string" }, "cache_url": { "title": "Cache Url", "description": "The URL to access the cached result", "nullable": true, "type": "string" }, "router": { "type": "string", "title": "Router", "description": "The endpoint that generated this response", "default": "" }, "params": { "title": "Params", "description": "The parameters used in the request", "default": {} }, "data": { "title": "Data", "description": "The response data", "nullable": true } }, "type": "object", "title": "ResponseModel" }, "Body_get_item_report_trend_api_v1_douyin_xingtu_v2_get_item_report_trend_post": { "properties": { "item_id": { "type": "string", "title": "Item Id", "description": "Video (item) ID" } }, "type": "object", "required": [ "item_id" ], "title": "Body_get_item_report_trend_api_v1_douyin_xingtu_v2_get_item_report_trend_post" }, "TikTok_APP_V3_Content_Translate": { "properties": { "trg_lang": { "type": "string", "title": "Trg Lang", "description": "Target language ISO639-1 code, e.g. zh-Hans", "default": "zh-Hans" }, "src_content": { "type": "string", "title": "Src Content", "description": "Source language content, i.e. the content to be translated", "default": "Hello, welcome to TikHub!" } }, "type": "object", "title": "TikTok_APP_V3_Content_Translate" }, "ImageSearchV3Request": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword" }, "cursor": { "type": "integer", "title": "Cursor", "description": "Pagination cursor", "default": 0 }, "search_id": { "type": "string", "title": "Search Id", "description": "Search ID for pagination", "default": "" } }, "type": "object", "required": [ "keyword" ], "title": "ImageSearchV3Request" }, "GetAccountOverviewRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "start_date": { "type": "string", "title": "Start Date", "description": "Query Start Date, e.g. '04-01-2025'", "default": "04-01-2025" } }, "type": "object", "title": "GetAccountOverviewRequest" }, "GetVideoDetailedStatsRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "start_date": { "type": "string", "title": "Start Date", "description": "Query Start Date, e.g. '04-01-2025'", "default": "04-01-2025" }, "item_id": { "type": "string", "title": "Item Id", "description": "Video ID" } }, "type": "object", "required": [ "item_id" ], "title": "GetVideoDetailedStatsRequest" }, "LiveSearchV2Request": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Douyin ID or nickname", "default": "Xiao Erduo" }, "cursor": { "type": "integer", "title": "Cursor", "description": "Pagination cursor, 0 for the first request, then the cursor from the last response", "default": 0 } }, "type": "object", "title": "LiveSearchV2Request" }, "TalentCategoryRequest": { "properties": { "cookie": { "title": "Cookie", "description": "User www.douyin.com web Cookie", "nullable": true, "type": "string" } }, "type": "object", "title": "TalentCategoryRequest", "description": "Talent Category List Request Model" }, "BloggerListReq": { "properties": { "page_num": { "type": "integer", "maximum": 250.0, "minimum": 1.0, "title": "Page Num", "description": "Page, 1-250", "default": 1, "example": 1 }, "page_size": { "type": "integer", "maximum": 20.0, "minimum": 1.0, "title": "Page Size", "description": "Page size, 1-20 (web fixed at 20; recommended: keep at 20)", "default": 20, "example": 20 }, "keyword": { "type": "string", "maxLength": 50, "title": "Keyword", "description": "Keyword; empty=filter only, no search", "default": "", "example": "Coffee" }, "search_type": { "type": "integer", "enum": [ 0, 1 ], "title": "Search Type", "description": "1=search bloggers by note keyword (default), 0=search by nickname", "default": 1, "example": 1 }, "column": { "type": "string", "enum": [ "comprehensiverank", "fansCount", "price", "clickNum", "mEngagementNum", "accumCommonImpMedinNum30d", "accumPicCommonImpMedinNum30d", "accumVideoCommonImpMedinNum30d", "pictureClickMidNum", "videoClickMidNum", "pictureInterMidNum", "videoInterMidNum", "thousandLikePercent30", "pictureThousandLikePercent30", "videoThousandLikePercent30", "hundredLikePercent30", "pictureHundredLikePercent30", "videoHundredLikePercent30", "videoFinishRate", "accumCoopImpMedinNum30d", "readMidCoop30", "interMidCoop30", "mCpuvNum30d", "picturePrice", "videoPrice", "pictureReadCost", "videoReadCost", "inviteReply48hNumRatio", "fans30GrowthRate", "fansActiveIn28dLv", "fansEngageNum30dLv", "kliveCnt30d", "avgLiveViewerNum", "avgAgmv90d" ], "title": "Column", "description": "Sort column, 34 options, see endpoint docs", "default": "comprehensiverank", "example": "comprehensiverank" }, "sort": { "type": "string", "enum": [ "desc", "asc" ], "title": "Sort", "description": "Sort direction: desc/asc", "default": "desc", "example": "desc" }, "brand_user_id": { "title": "Brand User Id", "description": "Brand/advertiser user ID, optional", "example": "5dcfa5370000000001006030", "nullable": true, "type": "string" }, "similar_user_id": { "title": "Similar User Id", "description": "Find similar bloggers; unlike /get_blogger_similar it can be combined with all filters below", "example": "5c668b3e0000000012021605", "nullable": true, "type": "string" }, "similar_word": { "title": "Similar Word", "description": "Nickname echo for similar_user_id; does not affect results", "nullable": true, "type": "string", "maxLength": 64 }, "goal": { "description": "Cooperation goal filters", "nullable": true, "$ref": "#/components/schemas/GoalFilter" }, "blogger": { "description": "Blogger attribute filters", "nullable": true, "$ref": "#/components/schemas/BloggerAttrFilter" }, "fans": { "description": "Fans profile filters", "nullable": true, "$ref": "#/components/schemas/FansFilter" }, "note": { "description": "Organic note metric filters", "nullable": true, "$ref": "#/components/schemas/NoteFilter" }, "coop": { "description": "Sponsored note metric filters", "nullable": true, "$ref": "#/components/schemas/CoopFilter" }, "live": { "description": "Live metric filters", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_filters__LiveFilter" }, "flags": { "description": "Boolean flag filters", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_filters__FlagFilter" } }, "additionalProperties": false, "type": "object", "title": "BloggerListReq" }, "Body_get_recommend_for_star_authors_api_v1_douyin_xingtu_v2_get_recommend_for_star_authors_post": { "properties": { "author_ids": { "items": { "type": "string" }, "type": "array", "title": "Author Ids", "description": "List of creator author IDs" }, "similar_type": { "type": "string", "title": "Similar Type", "description": "Similarity type", "default": "content" }, "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 } }, "type": "object", "required": [ "author_ids" ], "title": "Body_get_recommend_for_star_authors_api_v1_douyin_xingtu_v2_get_recommend_for_star_authors_post" }, "Body_fetch_hot_total_high_fan_list_api_v1_douyin_billboard_fetch_hot_total_high_fan_list_post": { "properties": { "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 1=last 1 hour, 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword for filtering the leaderboard; empty=all", "default": "" }, "tags": { "items": { "$ref": "#/components/schemas/BillboardTag" }, "type": "array", "title": "Tags", "description": "Vertical tag filter; leave empty for all. Tag IDs are obtained from the fetch_content_tag endpoint.", "example": [ { "children": [ { "value": 62808 }, { "value": 62804 } ], "value": 628 } ] } }, "type": "object", "title": "Body_fetch_hot_total_high_fan_list_api_v1_douyin_billboard_fetch_hot_total_high_fan_list_post" }, "UpperSearchBody": { "properties": { "nickname_or_mids": { "title": "Nickname Or Mids", "description": "Creator nickname or UID query; separate multiple terms with commas", "nullable": true, "type": "string" }, "main_search": { "title": "Main Search", "description": "Content-keyword query; matched videos are included in the result", "nullable": true, "type": "string" }, "mids": { "title": "Mids", "description": "List of creator UIDs to match exactly", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "upper_mid": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Upper Mid", "description": "Single creator UID for an exact match", "nullable": true }, "folder_id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Folder Id", "description": "Saved-creator folder ID used to limit the search", "nullable": true }, "marketing_target": { "title": "Marketing Target", "description": "Marketing objective: 1=brand awareness, 2=consideration, 3=conversion", "nullable": true, "type": "integer" }, "panel_type": { "title": "Panel Type", "description": "Strategy panel: 0=general, 1=gaming, 2=beauty, 3=digital, 4=automotive, 5=performance, 6=food, 8=internet", "nullable": true, "type": "integer" }, "order_by": { "title": "Order By", "description": "Sort field, such as fans_num, play_median, or interactive_rate", "nullable": true, "type": "string" }, "sort": { "title": "Sort", "description": "Sort direction: desc=descending, asc=ascending", "nullable": true, "type": "string" }, "page": { "title": "Page", "description": "One-based page number; each page returns 20 records", "nullable": true, "type": "integer", "minimum": 1.0 }, "request_id": { "title": "Request Id", "description": "Search-session ID; reuse it across pages of the same filter set", "nullable": true, "type": "string" }, "gender": { "title": "Gender", "description": "Creator gender from gender_info returned by /api/v1/bilibili/huahuo/square_static_info", "nullable": true, "type": "string" }, "min_fans_num": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Min Fans Num", "description": "Minimum follower count, inclusive", "nullable": true }, "max_fans_num": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Max Fans Num", "description": "Maximum follower count, inclusive", "nullable": true }, "region_id": { "title": "Region Id", "description": "Call /api/v1/bilibili/huahuo/region_drop first, then put selected primary-region values in this array", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "second_region_id": { "title": "Second Region Id", "description": "Call /api/v1/bilibili/huahuo/region_drop first, then put selected child-region values in this array", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "partition_id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Partition Id", "description": "Primary content-category ID from /api/v1/bilibili/huahuo/partition_drop", "nullable": true }, "second_partition_id": { "title": "Second Partition Id", "description": "Secondary content-category IDs from /api/v1/bilibili/huahuo/partition_drop", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "mcn_ids": { "title": "Mcn Ids", "description": "MCN organization IDs from /api/v1/bilibili/huahuo/mcn_drop", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "provider_id": { "title": "Provider Id", "description": "Service-provider IDs using values offered by the Huahuo filter", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "upper_types": { "title": "Upper Types", "description": "Creator type: 1 or 4=MCN-affiliated, 3=independent", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "only_contract": { "title": "Only Contract", "description": "Contract-eligible filter: 1=only eligible creators, 0=all", "nullable": true, "type": "integer" }, "is_painter_order": { "title": "Is Painter Order", "description": "Whether to require illustration-commission capability", "nullable": true, "type": "boolean" }, "fans_age_tag": { "title": "Fans Age Tag", "description": "Audience age-affinity tags from /api/v1/bilibili/huahuo/square_static_info", "nullable": true, "items": { "type": "string" }, "type": "array" }, "fans_gender_tag": { "title": "Fans Gender Tag", "description": "Audience gender-affinity tags from /api/v1/bilibili/huahuo/square_static_info", "nullable": true, "items": { "type": "string" }, "type": "array" }, "fans_region_tag": { "title": "Fans Region Tag", "description": "Audience region-affinity tags from /api/v1/bilibili/huahuo/square_static_info", "nullable": true, "items": { "type": "string" }, "type": "array" }, "fans_stick": { "title": "Fans Stick", "description": "Follower-loyalty filter; 0=all, otherwise use a static-option value", "nullable": true, "type": "integer" }, "av_active": { "title": "Av Active", "description": "Recent-publishing activity switch: 1=enabled, 0=all", "nullable": true, "type": "integer" }, "av_active_tag": { "title": "Av Active Tag", "description": "Recent-publishing activity tier from av_active_tag returned by /api/v1/bilibili/huahuo/square_static_info", "nullable": true, "type": "string" }, "dmp_group_id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Dmp Group Id", "description": "DMP custom audience-package ID from /api/v1/bilibili/huahuo/dmp_pkg_list", "nullable": true }, "category_dmp_group_id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Category Dmp Group Id", "description": "Content-category DMP audience-package ID", "nullable": true }, "category_dmp_label": { "title": "Category Dmp Label", "description": "Display label for the content-category DMP audience package", "nullable": true, "type": "string" }, "dmp_pkg_name": { "title": "Dmp Pkg Name", "description": "DMP special-audience package name query", "nullable": true, "type": "string" }, "dmp_pkg_vertical_rate_gte": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Dmp Pkg Vertical Rate Gte", "description": "Minimum DMP verticality: matching videos divided by all videos", "nullable": true }, "dmp_pkg_vertical_rate_lte": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Dmp Pkg Vertical Rate Lte", "description": "Maximum DMP verticality: matching videos divided by all videos", "nullable": true }, "dmp_pkg_effect_rate_gte": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Dmp Pkg Effect Rate Gte", "description": "Minimum DMP influence: recent matching viewers divided by the audience population", "nullable": true }, "dmp_pkg_effect_rate_lte": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Dmp Pkg Effect Rate Lte", "description": "Maximum DMP influence: recent matching viewers divided by the audience population", "nullable": true }, "dmp_pkg_fan_rate_gte": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Dmp Pkg Fan Rate Gte", "description": "Minimum DMP attention: matching audience members divided by all followers", "nullable": true }, "dmp_pkg_fan_rate_lte": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Dmp Pkg Fan Rate Lte", "description": "Maximum DMP attention: matching audience members divided by all followers", "nullable": true }, "min_task_price": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Min Task Price", "description": "Minimum standard cooperation quote in RMB", "nullable": true }, "max_task_price": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Max Task Price", "description": "Maximum standard cooperation quote in RMB", "nullable": true }, "price_info": { "title": "Price Info", "description": "Cooperation-pricing filters from price_info_options returned by /api/v1/bilibili/huahuo/square_static_info; send one type per search, include all six fields, and use [] for unavailable arrays", "nullable": true, "items": { "$ref": "#/components/schemas/UpperPriceFilter" }, "type": "array" }, "last_7_days_set_price": { "title": "Last 7 Days Set Price", "description": "Quote-updated-in-7-days filter: 1=yes, 0=all", "nullable": true, "type": "integer" }, "last_14_days_set_price": { "title": "Last 14 Days Set Price", "description": "Quote-updated-in-14-days filter: 1=yes, 0=all", "nullable": true, "type": "integer" }, "last_30_days_set_price": { "title": "Last 30 Days Set Price", "description": "Quote-updated-in-30-days filter: 1=yes, 0=all", "nullable": true, "type": "integer" }, "min_interact_rate": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Min Interact Rate", "description": "Minimum engagement rate for eligible original videos in the last 180 days", "nullable": true }, "max_interact_rate": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Max Interact Rate", "description": "Maximum engagement rate for eligible original videos in the last 180 days", "nullable": true }, "blue_url_ctr_gte": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Blue Url Ctr Gte", "description": "Minimum blue-link CTR, blue-link clicks divided by video views", "nullable": true }, "blue_url_ctr_lt": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Blue Url Ctr Lt", "description": "Maximum blue-link CTR, blue-link clicks divided by video views", "nullable": true }, "blue_url_click_cost_gte": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Blue Url Click Cost Gte", "description": "Minimum blue-link click cost, cooperation and promotion spend divided by clicks", "nullable": true }, "blue_url_click_cost_lt": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Blue Url Click Cost Lt", "description": "Maximum blue-link click cost, cooperation and promotion spend divided by clicks", "nullable": true }, "min_play_median": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Min Play Median", "description": "Minimum median views for eligible original videos published at least seven days ago", "nullable": true }, "max_play_median": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Max Play Median", "description": "Maximum median views for eligible original videos published at least seven days ago", "nullable": true }, "play_median_traffic_type": { "title": "Play Median Traffic Type", "description": "Median-view traffic scope: 1=all traffic, 2=organic traffic", "nullable": true, "type": "integer" }, "play_median_cycle": { "title": "Play Median Cycle", "description": "Median-view window: 1=7 days, 2=15 days, 3=30 days", "nullable": true, "type": "integer" }, "min_cpm": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Min Cpm", "description": "Minimum CPM, calculated as spend divided by views times 1,000", "nullable": true }, "max_cpm": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Max Cpm", "description": "Maximum CPM, calculated as spend divided by views times 1,000", "nullable": true }, "cpm_type": { "title": "Cpm Type", "description": "CPM traffic scope: 1=all traffic, 2=organic traffic", "nullable": true, "type": "integer" }, "cpm_cycle": { "title": "Cpm Cycle", "description": "CPM window: 1=7 days, 2=15 days, 3=30 days", "nullable": true, "type": "integer" }, "min_cpc": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Min Cpc", "description": "Minimum CPC, calculated as spend divided by component clicks", "nullable": true }, "max_cpc": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Max Cpc", "description": "Maximum CPC, calculated as spend divided by component clicks", "nullable": true }, "cpc_traffic_type": { "title": "Cpc Traffic Type", "description": "CPC traffic scope: 1=all traffic, 2=organic traffic", "nullable": true, "type": "integer" }, "cpc_cycle": { "title": "Cpc Cycle", "description": "CPC window: 1=7 days, 2=15 days, 3=30 days", "nullable": true, "type": "integer" }, "cpe_gte": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Cpe Gte", "description": "Minimum CPE, calculated as spend divided by valid engagements", "nullable": true }, "cpe_lt": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Cpe Lt", "description": "Maximum CPE, calculated as spend divided by valid engagements", "nullable": true }, "cpe_traffic_type": { "title": "Cpe Traffic Type", "description": "CPE traffic scope: 1=all traffic, 2=organic traffic", "nullable": true, "type": "integer" }, "cpe_cycle": { "title": "Cpe Cycle", "description": "CPE window: 1=7 days, 3=30 days", "nullable": true, "type": "integer" }, "draft_duration": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Draft Duration", "description": "Dominant video duration: 1=0-30s, 2=30-60s, 3=1-3min, 4=3-5min, 5=5-10min, 6=over 10min", "nullable": true }, "min_avid_cnt": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Min Avid Cnt", "description": "Minimum eligible original-video count in the last 90 days", "nullable": true }, "max_avid_cnt": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Max Avid Cnt", "description": "Maximum eligible original-video count in the last 90 days", "nullable": true }, "min_hot_avid_rate": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Min Hot Avid Rate", "description": "Minimum viral-video ratio in the last 90 days", "nullable": true }, "max_hot_avid_rate": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Max Hot Avid Rate", "description": "Maximum viral-video ratio in the last 90 days", "nullable": true }, "half_min_hot_avid_cnt": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Half Min Hot Avid Cnt", "description": "Minimum viral-video count in the last six months", "nullable": true }, "half_max_hot_avid_cnt": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Half Max Hot Avid Cnt", "description": "Maximum viral-video count in the last six months", "nullable": true }, "entry_cost_min": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Entry Cost Min", "description": "Minimum store-entry cost for relevant cooperation in the last year", "nullable": true }, "entry_cost_max": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Entry Cost Max", "description": "Maximum store-entry cost for relevant cooperation in the last year", "nullable": true }, "av_honor": { "description": "Video honors have no separate options endpoint; use the search_upper documentation and always send honor_type as an array", "nullable": true, "$ref": "#/components/schemas/UpperHonorFilter" }, "cooperate_experience_industry_ids": { "title": "Cooperate Experience Industry Ids", "description": "For non-general panels, call /api/v1/bilibili/huahuo/cooperate_experience_industry first and put selected IDs here; unused by the general panel", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "cooperate_experience_type": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Cooperate Experience Type", "description": "Experience type for non-general strategy panels: 1=experienced, 2=extensive, 3=none in current industry, 4=experience in other industries; use 1 or 2 with selected industries, while the general panel uses spark_tag", "nullable": true }, "special_tags": { "title": "Special Tags", "description": "Feature-tag values from /api/v1/bilibili/huahuo/square_static_info", "nullable": true, "items": { "type": "string" }, "type": "array" }, "spark_tag": { "title": "Spark Tag", "description": "Huahuo capability tags; general-panel cooperation count uses cooperate or coo_frequent together with industry-tree values from /api/v1/bilibili/huahuo/square_static_info", "nullable": true, "items": { "type": "string" }, "type": "array" }, "square_tag_in": { "title": "Square Tag In", "description": "Marketplace scenario tags such as ad_partner_experienced", "nullable": true, "items": { "type": "string" }, "type": "array" }, "label_array": { "title": "Label Array", "description": "Call /api/v1/bilibili/huahuo/upper_label_tree first, then put all selected content-type values in one inner array", "nullable": true, "items": { "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "type": "array" }, "bdata_tag_lv5": { "title": "Bdata Tag Lv5", "description": "Bilibili level-five content-tag filter values", "nullable": true, "items": {}, "type": "array" }, "huahuo_first_industry_ids": { "title": "Huahuo First Industry Ids", "description": "For the general panel, call /api/v1/bilibili/huahuo/square_static_info and put selected primary industry_tree IDs here", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "huahuo_second_industry_ids": { "title": "Huahuo Second Industry Ids", "description": "For the general panel, call /api/v1/bilibili/huahuo/square_static_info and put selected secondary industry_tree IDs here", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "huahuo_third_industry_ids": { "title": "Huahuo Third Industry Ids", "description": "For the general panel, call /api/v1/bilibili/huahuo/square_static_info and put selected tertiary industry_tree IDs here", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "goods_permission": { "title": "Goods Permission", "description": "Commerce permission filter: 1=required, 0=all", "nullable": true, "type": "integer" }, "goods_up_levels": { "title": "Goods Up Levels", "description": "Commerce-creator level values", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "goods_category_first_ids": { "title": "Goods Category First Ids", "description": "Primary commerce-category IDs from /api/v1/bilibili/huahuo/effect_goods_drop", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "goods_category_second_ids": { "title": "Goods Category Second Ids", "description": "Secondary commerce-category IDs from /api/v1/bilibili/huahuo/effect_goods_drop", "nullable": true, "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, "goods_gpm_min": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Goods Gpm Min", "description": "Minimum 30-day GPM, paid GMV per 1,000 commerce-video views", "nullable": true }, "goods_gpm_max": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Goods Gpm Max", "description": "Maximum 30-day GPM, paid GMV per 1,000 commerce-video views", "nullable": true }, "goods_ctr_min": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Goods Ctr Min", "description": "Minimum commerce-component CTR, clicks divided by impressions", "nullable": true }, "goods_ctr_max": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Goods Ctr Max", "description": "Maximum commerce-component CTR, clicks divided by impressions", "nullable": true }, "goods_ctr_type": { "title": "Goods Ctr Type", "description": "Commerce CTR component scope: 1=all components, 2=comment component", "nullable": true, "type": "integer" }, "goods_avg_price_min": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Goods Avg Price Min", "description": "Minimum average product price in the last 30 days, in RMB", "nullable": true }, "goods_avg_price_max": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Goods Avg Price Max", "description": "Maximum average product price in the last 30 days, in RMB", "nullable": true }, "goods_is_high_video_play_permeate": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Goods Is High Video Play Permeate", "description": "High video-view penetration filter, top 20% by recent viewers per follower", "nullable": true }, "goods_is_high_fans_play_permeate": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Goods Is High Fans Play Permeate", "description": "High follower-view penetration filter", "nullable": true }, "is_boosting": { "title": "Is Boosting", "description": "Boosting-status filter: 1=currently boosting, 0=all", "nullable": true, "type": "integer" }, "is_treasure_up": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Is Treasure Up", "description": "Whether to filter for treasure creators", "nullable": true }, "is_timely_response": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Is Timely Response", "description": "Whether to require timely-response creators", "nullable": true }, "is_new_enter": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Is New Enter", "description": "Whether to filter for newly onboarded creators", "nullable": true }, "custom_video_pricing_set": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Custom Video Pricing Set", "description": "Whether custom-video pricing has been configured", "nullable": true }, "is_x_plan_better_up": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Is X Plan Better Up", "description": "Whether to filter for X Plan preferred creators", "nullable": true }, "high_potential_type": { "title": "High Potential Type", "description": "High-potential type: 0=all, 1=onboarded, 2=not onboarded", "nullable": true, "type": "integer" } }, "additionalProperties": true, "type": "object", "title": "UpperSearchBody", "description": "### Search modes:\n- `nickname_or_mids`: Search by creator nickname or UID; separate multiple\n terms with commas.\n- `main_search`: Search by content keyword and include matched videos in\n the response.\n- `mids` / `upper_mid`: Match one or more creator UIDs exactly.\n\n### Filter groups:\n- **Profile and affiliation**: gender, followers, region, content category,\n MCN, service provider, and account type.\n- **Audience profile**: age, gender, region affinity, and follower loyalty.\n- **Pricing and performance**: quote, engagement rate, median views, CPM,\n CPC, CPE, and store-entry cost.\n- **Content and cooperation**: post count, viral-post ratio, video duration,\n honors, industries, and cooperation experience.\n- **Commerce**: permission, level, categories, GPM, component CTR, and\n average product price.\n- **Audience packages and labels**: DMP packages, feature tags, content-type\n trees, and high-potential tags.\n\nEvery field is optional. Send ratio fields as decimal values (for example,\n`0.05` for 5%) and monetary fields as the RMB values displayed by Huahuo.\nDynamic IDs are available from `square_static_info`, `upper_label_tree`,\nand the corresponding dropdown endpoints.\n\n# [Example]\n```json\n{\n \"nickname_or_mids\": \"2233,xiaodianshi\",\n \"marketing_target\": 1,\n \"panel_type\": 0,\n \"min_fans_num\": 100000,\n \"max_fans_num\": 1000000,\n \"min_interact_rate\": 0.03,\n \"play_median_traffic_type\": 1,\n \"play_median_cycle\": 3,\n \"price_info\": [{\n \"cooperation_type\": 1,\n \"creative_skill\": [],\n \"include_content\": [],\n \"price_min\": 1000,\n \"price_max\": 10000,\n \"price_right\": []\n }],\n \"goods_ctr_type\": 1,\n \"page\": 1\n}\n```" }, "SchoolSearchRequest": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Keyword, such as school name or location", "default": "Beijing" } }, "type": "object", "title": "SchoolSearchRequest" }, "GetVideoOverviewRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" } }, "type": "object", "title": "GetVideoOverviewRequest" }, "ItemMgetRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "ids": { "type": "string", "title": "Ids", "description": "Item IDs, separated by comma", "example": "7559536212910853422,7559536212910853423" }, "fields": { "title": "Fields", "description": "Fields to return, separated by comma. Optional values: metrics, review, play_info, dou_plus, integrated_incentive, incentive_life, content_analysis", "default": "metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis", "nullable": true, "type": "string" } }, "type": "object", "required": [ "cookie", "ids" ], "title": "ItemMgetRequest", "description": "Item Overview Data Request Model" }, "Body_get_item_report_comments_api_v1_douyin_xingtu_v2_get_item_report_comments_post": { "properties": { "item_id": { "type": "string", "title": "Item Id", "description": "Video (item) ID" } }, "type": "object", "required": [ "item_id" ], "title": "Body_get_item_report_comments_api_v1_douyin_xingtu_v2_get_item_report_comments_post" }, "crawlers__xiaohongshu__pgy__pgy_filters__LiveFilter": { "properties": { "live_count": { "description": "Number of live streams in the last 30 days", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "avg_viewer": { "description": "Average viewers per live stream over the last 90 days (live_count uses a 30-day window instead).", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "avg_gmv": { "description": "Average GMV per live stream over the last 90 days (live_count uses a 30-day window instead).", "nullable": true, "$ref": "#/components/schemas/RangeFilter" } }, "additionalProperties": false, "type": "object", "title": "LiveFilter", "description": "Live data — the \"Live Data\" section of the web page." }, "AuthorDiagnosisRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" } }, "type": "object", "required": [ "cookie" ], "title": "AuthorDiagnosisRequest", "description": "Author Diagnosis Request Model\n\nThis API requires no additional parameters, automatically fetches diagnosis data for the past 7 days" }, "LiveRoomBatchCheckRequest": { "properties": { "room_ids": { "items": { "type": "string" }, "type": "array", "title": "Room Ids", "description": "List of TikTok live room IDs", "default": [ "7494491933781003054", "7494514925034113835", "7494520590523517739" ] } }, "type": "object", "title": "LiveRoomBatchCheckRequest" }, "ItemBulletAnalysisRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "item_id": { "type": "string", "title": "Item Id", "description": "Item ID", "example": "7559536212910853422" } }, "type": "object", "required": [ "cookie", "item_id" ], "title": "ItemBulletAnalysisRequest", "description": "Item Bullet Analysis Request Model" }, "Body_get_ads_detail_api_v1_tiktok_ads_get_ads_detail_post": { "properties": { "ads_id": { "type": "string", "title": "Ads Id", "description": "Ad ID" }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "required": [ "ads_id" ], "title": "Body_get_ads_detail_api_v1_tiktok_ads_get_ads_detail_post" }, "TikTok_APP_Encrypt_Request": { "properties": { "url": { "type": "string", "title": "Url", "description": "URL to be encrypted", "default": "https://api16-normal-useast5.tiktokv.us/tiktok/v1/upvote/item/list?user_id=6726034365602628610&offset=0&count=21&scene=0&iid=7425045478163400491&device_id=7349721034012280362&ac=WIFI&channel=googleplay&aid=1233&app_name=musical_ly&version_code=360704&version_name=36.7.4&device_platform=android&os=android&ab_version=36.7.4&ssmix=a&device_type=Pixel+6+Pro&device_brand=google&language=zh&os_api=33&os_version=13&openudid=711192517a8bbf03&manifest_version_code=2023607040&resolution=1440*2891&dpi=560&update_version_code=2023607040&_rticket=1728977220468&is_pad=0&app_type=normal&sys_region=CN&last_install_time=1728977141&timezone_name=America%2FLos_Angeles&app_language=zh-Hans&ac2=wifi5g&uoo=0&op_region=CN&timezone_offset=-28800&build_number=36.7.4&host_abi=arm64-v8a&locale=zh-Hans®ion=CN&content_language=en%2C&ts=1728977220&cdid=aa21524b-8633-49ca-8e6e-3275fe1672db" }, "data": { "type": "string", "title": "Data", "description": "If there is a POST request, please fill in the POST request data to participate in the encryption calculation", "default": "" }, "device_info": { "additionalProperties": true, "type": "object", "title": "Device Info", "description": "Device information, optional parameter; if not provided, default device information is used", "default": { "aid": "1233", "cdid": "b820f79c-c74a-47b0-912f-ee3002ce60dc", "channel": "googleplay", "cookies": {}, "device_brand": "HONOR", "device_id": "7423364899755607598", "device_manufacturer": "HUAWEI", "device_model": "HONOR V30", "device_platform": "android", "device_type": "OXF-AN00", "dpi": 480, "host_abi": "arm64-v8a", "iid": "7423365134775469866", "lanusk": "", "manifest_version_code": "2023604040", "mc": "7E:EE:BA:BC:5E:40", "mssdk_token": "", "openudid": "63401ab5140125d1", "os_api": 29, "os_version": "10", "resolution": "2400*1080", "rom": "11.0.0.185C00", "rom_version": "OXF-AN00-user 11.0.0 HUAWEIOXF-AN00 185-CHN-LGRP3 release-keys", "server_time": 1728386909, "ua": "com.zhiliaoapp.musically/2023604040 (Linux; U; Android 10; zh_CN; OXF-AN00; Build/185-CHN-LGRP3;tt-ok/3.12.13.4-tiktok)", "update_version_code": "2023604040", "uuid": "350244698061054", "version_code": "360404", "version_name": "36.4.4" } } }, "type": "object", "title": "TikTok_APP_Encrypt_Request" }, "GetVideoAssociatedProductListRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "start_date": { "type": "string", "title": "Start Date", "description": "Query Start Date, e.g. '04-01-2025'", "default": "04-01-2025" }, "item_ids": { "items": { "type": "string" }, "type": "array", "title": "Item Ids", "description": "Video ID List" } }, "type": "object", "required": [ "item_ids" ], "title": "GetVideoAssociatedProductListRequest" }, "LiveBloggerReq": { "properties": { "page_num": { "type": "integer", "maximum": 250.0, "minimum": 1.0, "title": "Page Num", "description": "Page, 1-250", "default": 1, "example": 1 }, "page_size": { "type": "integer", "maximum": 20.0, "minimum": 1.0, "title": "Page Size", "description": "Page size, 1-20 (web fixed at 20)", "default": 20, "example": 20 }, "seed": { "type": "integer", "minimum": 0.0, "title": "Seed", "description": "Paging seed, echo back from previous page", "default": 0, "example": 0 }, "nick_name": { "type": "string", "maxLength": 50, "title": "Nick Name", "description": "Search by nickname", "default": "", "example": "Li" }, "category": { "description": "Cooperation category filters", "nullable": true, "$ref": "#/components/schemas/CategoryFilter" }, "buyer": { "description": "Buyer group & persona filters", "nullable": true, "$ref": "#/components/schemas/BuyerFilter" }, "ecom": { "description": "E-commerce conversion filters", "nullable": true, "$ref": "#/components/schemas/EcomFilter" }, "live": { "description": "Live activity & performance filters", "nullable": true, "$ref": "#/components/schemas/LiveFilter" }, "fans": { "description": "Fans purchasing power filters", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_live_filters__FansFilter" }, "flags": { "description": "Platform recommendation flags", "nullable": true, "$ref": "#/components/schemas/FlagFilter" } }, "additionalProperties": false, "type": "object", "title": "LiveBloggerReq" }, "LiveRoomSearchRequest": { "properties": { "cookie": { "title": "Cookie", "description": "User www.douyin.com web Cookie", "nullable": true, "type": "string" }, "keyword": { "type": "string", "title": "Keyword", "description": "Douyin ID or nickname", "example": "Xiao Erduo" }, "cursor": { "title": "Cursor", "description": "Pagination cursor, 0 for first page", "default": 0, "example": 0, "nullable": true, "type": "integer" }, "count": { "title": "Count", "description": "Page size", "default": 10, "example": 10, "nullable": true, "type": "integer" } }, "type": "object", "required": [ "keyword" ], "title": "LiveRoomSearchRequest", "description": "Live Room Search Request Model (by Douyin ID or nickname)" }, "GetVideoAudienceStatsRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie String", "default": "Your_Cookie_String" }, "proxy": { "title": "Proxy", "description": "Optional HTTP Proxy Address", "default": "", "nullable": true, "type": "string" }, "start_date": { "type": "string", "title": "Start Date", "description": "Query Start Date, e.g. '04-01-2025'", "default": "04-01-2025" }, "item_id": { "type": "string", "title": "Item Id", "description": "Video ID" } }, "type": "object", "required": [ "item_id" ], "title": "GetVideoAudienceStatsRequest" }, "XBogusModel": { "properties": { "url": { "type": "string", "title": "Url", "description": "The requested API URL, no need to encode", "example": "https://www.douyin.com/aweme/v1/web/aweme/detail/?aweme_id=7148736076176215311&device_platform=webapp&aid=6383&channel=channel_pc_web&pc_client_type=1&version_code=170400&version_name=17.4.0&cookie_enabled=true&screen_width=1920&screen_height=1080&browser_language=zh-CN&browser_platform=Win32&browser_name=Edge&browser_version=117.0.2045.47&browser_online=true&engine_name=Blink&engine_version=117.0.0.0&os_name=Windows&os_version=10&cpu_core_num=128&device_memory=10240&platform=PC&downlink=10&effective_type=4g&round_trip_time=100" }, "user_agent": { "type": "string", "title": "User Agent", "description": "User-Agent when requesting the API", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36" } }, "type": "object", "required": [ "url", "user_agent" ], "title": "XBogusModel" }, "ItemAudienceOthersRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "item_id": { "type": "string", "title": "Item Id", "description": "Item ID", "example": "7559536212910853422" } }, "type": "object", "required": [ "cookie", "item_id" ], "title": "ItemAudienceOthersRequest", "description": "Item Audience Others Request Model" }, "LiveFilter": { "properties": { "has_plan": { "title": "Has Plan", "description": "Has live-stream plan", "nullable": true, "type": "boolean" }, "plan_days": { "title": "Plan Days", "description": "Planned live stream date in YYYYMMDD; used with has_plan; leave empty for all dates", "nullable": true, "items": { "type": "string", "pattern": "^\\d{8}$" }, "type": "array", "maxItems": 60 }, "avg_viewer": { "description": "Average viewers per session", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_live_filters__RangeFilter" }, "max_online": { "description": "Peak concurrent viewers", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_live_filters__RangeFilter" } }, "additionalProperties": false, "type": "object", "title": "LiveFilter", "description": "Web page \"Live Stream Engagement\" + \"Live Stream Performance\" section." }, "Body_fetch_hot_total_high_play_list_api_v1_douyin_billboard_fetch_hot_total_high_play_list_post": { "properties": { "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 1=last 1 hour, 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword for filtering the leaderboard; empty=all", "default": "" }, "tags": { "items": { "$ref": "#/components/schemas/BillboardTag" }, "type": "array", "title": "Tags", "description": "Vertical tag filter; leave empty for all. Tag IDs are obtained from the fetch_content_tag endpoint.", "example": [ { "children": [ { "value": 62808 }, { "value": 62804 } ], "value": 628 } ] } }, "type": "object", "title": "Body_fetch_hot_total_high_play_list_api_v1_douyin_billboard_fetch_hot_total_high_play_list_post" }, "FansHistoryReq": { "properties": { "user_id": { "type": "string", "title": "User Id", "description": "Blogger user ID", "example": "5c668b3e0000000012021605" }, "increase_type": { "type": "integer", "enum": [ 1, 2 ], "title": "Increase Type", "description": "Curve: 1=total followers (default, cumulative), 2=daily follower increment", "default": 1, "example": 1 }, "date_type": { "type": "integer", "enum": [ 1, 2 ], "title": "Date Type", "description": "Date range: 1=last 30 days (default), 2=last 60 days", "default": 1, "example": 1 } }, "additionalProperties": false, "type": "object", "required": [ "user_id" ], "title": "FansHistoryReq" }, "PromotableItemListRequest": { "properties": { "sec_uid": { "type": "string", "title": "Sec Uid", "description": "Delivery account sec_uid", "example": "MS4wLjABAAAA9fe7vGjwyiaOjL6REhX8rvmSb32VzA_XsKca9F3_YSHRXlEqgT2cpX54WGbtgnsA" }, "count": { "title": "Count", "description": "Number of items", "default": 30, "example": 30, "nullable": true, "type": "integer" }, "target_id": { "title": "Target Id", "description": "Promotion target ID (the goal card on the DOU+ page). 31=Likes & Comments, 32=Followers, 33=Profile visits, 37=Video views, 40=Live room popularity, 45=Comment link clicks, 63=Shown to followers, 78=High-quality engagement. Only filters promotable items by goal; keep 31 for a plain video list", "default": 31, "example": 31, "nullable": true, "type": "integer" }, "aim_ids": { "title": "Aim Ids", "description": "Optional advanced param: optimization objective code(s), comma separated; leave empty (auto-matched by target_id), usually no need to set", "nullable": true, "type": "string" } }, "type": "object", "required": [ "sec_uid" ], "title": "PromotableItemListRequest", "description": "Promotable Item List Request Model" }, "ContentSquareReq": { "properties": { "biz_type": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "title": "Biz Type", "description": "Leaderboard: 1=Xiaohongshu Popular, 2=Product Seeding, 3=E-commerce Promotion, 4=Dandelion Collaboration, 5=Lead Collection, 6=E-commerce Hot, 7=Direct Seeding, 8=App Promotion", "example": 1 }, "page_num": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Page Num", "description": "Page; each board has only 100 items", "default": 1, "example": 1 }, "page_size": { "type": "integer", "maximum": 34.0, "minimum": 1.0, "title": "Page Size", "description": "Page size, 1-34 (web fixed at 34)", "default": 34, "example": 34 }, "search_word": { "type": "string", "maxLength": 100, "title": "Search Word", "description": "Keyword; leave empty to view the full chart; supports comma-separated batch search", "default": "", "example": "Face Mask" }, "order_by": { "type": "string", "maxLength": 64, "title": "Order By", "description": "Sort field, empty=board default", "default": "", "example": "premium_imp_num" }, "date_range": { "type": "integer", "enum": [ 3, 7, 14, 30 ], "title": "Date Range", "description": "Date window in days", "default": 7, "example": 7 }, "sub_biz_type": { "title": "Sub Biz Type", "description": "Board 8 only: 1=app download, 2=mini-program promotion, 3=app re-engagement (default)", "example": 3, "nullable": true, "type": "integer", "enum": [ 1, 2, 3 ] }, "category": { "title": "Category", "description": "Category (board 1 only), format: \"level1#level2\", e.g. \"Content Category#Beauty\"", "example": "Content category: Beauty", "nullable": true, "type": "string", "maxLength": 64 }, "industry": { "title": "Industry", "description": "Industry name (boards 2/3/4/5/6/7/8); valid values differ per board", "example": "Parenting & Baby", "nullable": true, "type": "string", "maxLength": 64 }, "note_type": { "title": "Note Type", "description": "Content type: 1=Image+text, 2=Video", "example": 2, "nullable": true, "type": "integer", "enum": [ 1, 2 ] }, "content_type": { "title": "Content Type", "description": "Content source: 1=Blogger partnership, 2=Celebrity partnership, 3=Employee, 5=Buyer, 6=Professional account, 11=Director, -1=User", "example": 1, "nullable": true, "type": "integer", "enum": [ 1, 2, 3, 5, 6, 11, -1 ] }, "theme": { "title": "Theme", "description": "Theme name (boards 2/4/5/7/8)", "example": "Unboxing", "nullable": true, "type": "string", "maxLength": 64 }, "author_type": { "title": "Author Type", "description": "Board 4 only: 1=Dandelion creator, 2=celebrity", "example": 1, "nullable": true, "type": "integer", "enum": [ 1, 2 ] }, "placement": { "title": "Placement", "description": "Traffic placement (boards 2/3/5/7/8): 1=Discover feed, 2=Search, 3=In-video traffic", "example": 1, "nullable": true, "type": "integer", "enum": [ 1, 2, 3 ] }, "marketing_target": { "title": "Marketing Target", "description": "Board 3 only: 3=product promotion, 8=live stream promotion", "example": 3, "nullable": true, "type": "integer", "enum": [ 3, 8 ] }, "price": { "description": "Creator price (board 4 only)", "nullable": true, "$ref": "#/components/schemas/PriceFilter" }, "fans": { "description": "Creator follower count range (board 4 only)", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_content_filters__RangeFilter" } }, "additionalProperties": false, "type": "object", "required": [ "biz_type" ], "title": "ContentSquareReq" }, "KeywordReq": { "properties": { "search_word": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Search Word", "description": "Keyword, e.g., face mask", "example": "Face Mask" } }, "additionalProperties": false, "type": "object", "required": [ "search_word" ], "title": "KeywordReq" }, "TikTok_APP_Login_Encrypt_Decrypt_Request": { "properties": { "username": { "type": "string", "title": "Username", "description": "Plaintext or encrypted username", "default": "example_username" }, "password": { "type": "string", "title": "Password", "description": "Plaintext or encrypted password", "default": "example_password" }, "mode": { "$ref": "#/components/schemas/ModeEnum", "description": "Encrypt or decrypt the input string", "default": "encrypt" } }, "type": "object", "title": "TikTok_APP_Login_Encrypt_Decrypt_Request", "example": { "mode": "encrypt", "password": "example_password", "username": "example_username" } }, "Body_search_ads_api_v1_tiktok_ads_search_ads_post": { "properties": { "objective": { "title": "Objective", "description": "Ad objective (optional): 1=Traffic, 2=App install, 3=Conversion, 4=Video views, 5=Reach, 6=Lead generation, 7=Product sales", "nullable": true, "type": "integer" }, "like": { "title": "Like", "description": "Performance rank (optional; 1=top 1-20%, 2=top 21-40%, 3=top 41-60%, 4=top 61-80%, 5=top 81-100%)", "nullable": true, "type": "integer" }, "period": { "type": "integer", "title": "Period", "description": "Time period (days)", "default": 180 }, "industry": { "type": "string", "title": "Industry", "description": "Industry ID" }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword" }, "page": { "type": "integer", "title": "Page", "description": "Page number", "default": 1 }, "limit": { "type": "integer", "title": "Limit", "description": "Items per page", "default": 20 }, "order_by": { "type": "string", "title": "Order By", "description": "Sort by (for_you, likes)", "default": "for_you" }, "country_code": { "type": "string", "title": "Country Code", "description": "Country code", "default": "US" }, "ad_format": { "title": "Ad Format", "description": "Ad format (optional): 1=Spark Ads, 2=Non-Spark Ads", "nullable": true, "type": "integer" }, "ad_language": { "title": "Ad Language", "description": "Ad language (optional)", "nullable": true, "type": "string" }, "duration": { "title": "Duration", "description": "Video duration filter value (optional)", "nullable": true, "type": "integer" }, "pattern_label": { "title": "Pattern Label", "description": "Creative pattern label (optional)", "nullable": true, "type": "string" }, "search_id": { "type": "string", "title": "Search Id", "description": "Search ID (optional)" }, "cookie": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } }, "type": "object", "title": "Body_search_ads_api_v1_tiktok_ads_search_ads_post" }, "VideoDetailRequest": { "properties": { "cookie": { "title": "Cookie", "description": "User www.douyin.com web Cookie", "nullable": true, "type": "string" }, "video": { "type": "string", "title": "Video", "description": "Video ID, or share link/text. e.g. \"7651708301280906538\" or a share message containing a v.douyin.com link", "example": "7651708301280906538" } }, "type": "object", "required": [ "video" ], "title": "VideoDetailRequest", "description": "Video Detail Request Model (by video ID or link)" }, "XGnarlyAndXBogusModel": { "properties": { "url": { "type": "string", "title": "Url", "description": "The requested API URL including domain and parameters, no need to URL encode", "example": "https://www.tiktok.com/api/search/user/full/?WebIdLastTime=1756087650&aid=1988&app_language=zh-Hans&app_name=tiktok_web&browser_language=zh-CN&browser_name=Mozilla&browser_online=true&browser_platform=MacIntel&browser_version=5.0%20%28Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F139.0.0.0%20Safari%2F537.36&channel=tiktok_web&cookie_enabled=true&cursor=10&data_collection_enabled=false&device_id=7542339104672111234&device_platform=web_pc&focus_state=true&from_page=search&history_len=3&is_fullscreen=true&is_page_visible=true&keyword=musk&odinId=7542338997269211234&os=mac&priority_region&referer®ion=US&screen_height=967&screen_width=1496&search_id&tz_name=America%2FLos_Angeles&user_is_login=false&web_search_code=%7B%22tiktok%22%3A%7B%22client_params_x%22%3A%7B%22search_engine%22%3A%7B%22ies_mt_user_live_video_card_use_libra%22%3A1%2C%22mt_search_general_user_live_card%22%3A1%7D%7D%2C%22search_server%22%3A%7B%7D%7D%7D&webcast_language=zh-Hans" }, "body": { "title": "Body", "description": "The API parameters of the request, applicable for POST requests", "default": "", "nullable": true, "type": "string" } }, "type": "object", "required": [ "url" ], "title": "XGnarlyAndXBogusModel" }, "VideoSearchV5Request": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword", "default": "Cat" }, "offset": { "type": "integer", "title": "Offset", "description": "Offset cursor for pagination, obtained from data.pagination.offset of the last response, 0 for the first request", "default": 0 }, "page": { "type": "integer", "title": "Page", "description": "Page number, 1-200, start with 1 and increment by 1 each time", "default": 1 }, "search_id": { "type": "string", "title": "Search Id", "description": "Search ID, obtained from data.pagination.search_id of the last response, empty for the first request", "default": "" }, "backtrace": { "type": "string", "title": "Backtrace", "description": "Backtrace, obtained from data.pagination.backtrace of the last response, empty for the first request", "default": "" } }, "type": "object", "title": "VideoSearchV5Request" }, "DiscussSearchRequest": { "properties": { "keyword": { "type": "string", "title": "Keyword", "description": "Keyword", "default": "Cat" }, "cursor": { "type": "integer", "title": "Cursor", "description": "Offset cursor for pagination, obtained from the last response", "default": 0 }, "sort_type": { "type": "string", "title": "Sort Type", "description": "Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest", "default": "0" }, "publish_time": { "type": "string", "title": "Publish Time", "description": "Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year", "default": "0" }, "filter_duration": { "type": "string", "title": "Filter Duration", "description": "Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes", "default": "0" }, "content_type": { "type": "string", "title": "Content Type", "description": "Content type: 0=All, 1=Video, 2=Picture, 3=Article", "default": "0" }, "search_id": { "type": "string", "title": "Search Id", "description": "Search ID for pagination, obtained from the last response", "default": "" }, "backtrace": { "type": "string", "title": "Backtrace", "description": "Backtrace for pagination, obtained from the last response", "default": "" } }, "type": "object", "title": "DiscussSearchRequest" }, "ItemAudiencePortraitRequest": { "properties": { "cookie": { "type": "string", "title": "Cookie", "description": "User Cookie", "example": "Your_Cookie_Here" }, "item_id": { "type": "string", "title": "Item Id", "description": "Item ID", "example": "7559536212910853422" } }, "type": "object", "required": [ "cookie", "item_id" ], "title": "ItemAudiencePortraitRequest", "description": "Item Audience Portrait Request Model" }, "Body_fetch_hot_total_hot_word_list_api_v1_douyin_billboard_fetch_hot_total_hot_word_list_post": { "properties": { "page_num": { "type": "integer", "title": "Page Num", "description": "Page number", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "description": "Items per page", "default": 10 }, "date_window": { "type": "integer", "title": "Date Window", "description": "Time window (hours): 24=last 1 day, 72=last 3 days, 168=last 7 days; default 24", "default": 24 }, "keyword": { "type": "string", "title": "Keyword", "description": "Search keyword", "default": "Douyin" } }, "type": "object", "title": "Body_fetch_hot_total_hot_word_list_api_v1_douyin_billboard_fetch_hot_total_hot_word_list_post" }, "UserIdReq": { "properties": { "user_id": { "type": "string", "title": "User Id", "description": "Blogger user ID", "example": "5c668b3e0000000012021605" } }, "additionalProperties": false, "type": "object", "required": [ "user_id" ], "title": "UserIdReq" }, "GoalFilter": { "properties": { "market_target": { "title": "Market Target", "description": "Marketing objective: on the web UI this is a three-level selector (objective -> metric -> measurement method); pass the final leaf code: `estimateAllCpm` Awareness/Impression Performance/Cost, `mAccumImpNum` Awareness/Impression Performance/Scale, `readCost` Awareness/Read Performance/Cost, `mValidRawReadFeedNum` Awareness/Read Performance/Scale, `estimateEngageCost` Consideration/Engagement Performance/Cost, `mEngagementNum90d` Consideration/Engagement Performance/Scale, `estimateCpuv` Conversion/Overflow Store-Visit Performance/Cost, `mCpuvNum` Conversion/Overflow Store-Visit Performance/Scale", "example": "mAccumImpNum", "nullable": true, "type": "string", "enum": [ "estimateAllCpm", "mAccumImpNum", "readCost", "mValidRawReadFeedNum", "estimateEngageCost", "mEngagementNum90d", "estimateCpuv", "mCpuvNum" ] } }, "additionalProperties": false, "type": "object", "title": "GoalFilter", "description": "Cooperation goal: match bloggers by marketing objective (Exposure / Seeding / Conversion).\n\nTo filter bloggers by audience segment, use `BloggerAttrFilter.audience20` (top-20 audiences)." }, "FlagFilter": { "properties": { "actively_seeking": { "title": "Actively Seeking", "description": "Actively seeking collaborations", "nullable": true, "type": "boolean" }, "high_reply_rate": { "title": "High Reply Rate", "description": "High invitation response rate", "nullable": true, "type": "boolean" }, "contact_visible": { "title": "Contact Visible", "description": "Contact information viewable", "nullable": true, "type": "boolean" }, "cooperated_before": { "title": "Cooperated Before", "description": "Has worked on commercial orders", "nullable": true, "type": "boolean" }, "following": { "title": "Following", "description": "You follow them", "nullable": true, "type": "boolean" }, "follower": { "title": "Follower", "description": "They follow you", "nullable": true, "type": "boolean" }, "live_potential_high": { "title": "Live Potential High", "description": "High live streaming potential", "nullable": true, "type": "boolean" }, "daily_buyer": { "title": "Daily Buyer", "description": "Daily live-stream buyer", "nullable": true, "type": "boolean" }, "is_star": { "title": "Is Star", "description": "Celebrity", "nullable": true, "type": "boolean" } }, "additionalProperties": false, "type": "object", "title": "FlagFilter", "description": "Web page \"Platform Recommendations -> Featured Bloggers\" section (all checkboxes)." }, "BillboardTag": { "properties": { "value": { "title": "Value", "description": "Top-level vertical category tag id, obtained from the fetch_content_tag endpoint", "nullable": true, "type": "integer" }, "children": { "title": "Children", "description": "Sub-level vertical category tags, omit for all under this top-level tag", "nullable": true, "items": { "$ref": "#/components/schemas/BillboardTagChild" }, "type": "array" } }, "type": "object", "title": "BillboardTag" }, "crawlers__xiaohongshu__pgy__pgy_live_filters__FansFilter": { "properties": { "count": { "description": "Follower count", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_live_filters__RangeFilter" }, "age": { "title": "Age", "description": "Audience age (dominant group): 0=No limit, 1=Under 18, 2=18-24, 3=25-34, 4=35-44, 5=Over 44", "nullable": true, "type": "integer", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "gender": { "title": "Gender", "description": "Audience gender: 0=No limit, 1=Predominantly male, 2=Predominantly female", "nullable": true, "type": "integer", "enum": [ 0, 1, 2 ] }, "consumption": { "title": "Consumption", "description": "Audience purchasing power: high / middle / low", "nullable": true, "items": { "type": "string", "enum": [ "high", "middle", "low" ] }, "type": "array", "maxItems": 3 } }, "additionalProperties": false, "type": "object", "title": "FansFilter", "description": "Audience purchasing power: follower count, age, gender, spending power." }, "BuyerFilter": { "properties": { "group_tag": { "title": "Group Tag", "description": "Buyer group tag, e.g. Elegant Minimalist (leaf tags under style groups: Fashion Style / Body Type / Beauty & Skincare / Sports Enthusiast). Refer to the \"Buyer Group\" dropdown on the page for valid values.", "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "persona_tag": { "title": "Persona Tag", "description": "Content persona tags, e.g. Model (leaf nodes from groups: Professional Identity / Family Role / Distinctive Background / Style / Lifestyle / Skin Type / Skincare / Body Type). Refer to the \"Content Persona\" dropdown on the page.", "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 } }, "additionalProperties": false, "type": "object", "title": "BuyerFilter", "description": "Web page \"Top Buyer Squad\" + \"Content Persona\" section." }, "BloggerAttrFilter": { "properties": { "content_tag": { "title": "Content Tag", "description": "Creator category: use the category name. There are 28 level-1 categories: Beauty / Skincare / Personal Care / Parenting / Fashion / Food / Home Decor / Film & TV & Entertainment News / Sports & Fitness / Pets / Culture & Art / Hobbies / Daily Life / Education / Workplace / Relationships / Photography / Gaming / Tech & Digital / Travel / Music / Comedy / Health & Wellness / Automotive / Wedding / Business & Finance / Stock Footage / Other. Level-2 names may also be used; **both levels can be mixed in the same array**, and multiple values are OR-ed. To select an entire category, use its level-1 name — **do not expand it to all level-2 names** (some creators are tagged at level-1 only; expanding will miss them). **If all categories are acceptable, omit this field entirely** — there is no category named \"All\", and passing one will silently return 0 results. Incorrect names also return 0 results without an error; always copy names verbatim from the contentTags dictionary. Note: this is a separate classification from \"industry\" (coop.industry).", "example": [ "Beauty", "Facial Care", "Facial Cleanser" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "personal_tags": { "title": "Personal Tags", "description": "Creator persona: use the `tagName` (bare name) from personalTagsV2 in `/get_blogger_filter_options`. This is a three-level tree (family identity / professional identity / background -> group -> leaf). **Any level can be filled in, and levels can be mixed**; multiple values are OR-ed. To select an entire group, use the group name — no need to enumerate every leaf (e.g. level-1 `Professional Identity`=91 results, level-2 `Internet`=8, leaf `Mom`=31).", "example": [ "Mother" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "feature_tags": { "title": "Feature Tags", "description": "Specialty content: use the bare name from featureTags in `/get_blogger_filter_options`. **Level-1 (format / style / lifestyle / skin type & tone / skincare) and level-2 (e.g. vlog / Korean style) can both be used and mixed**; multiple values are OR-ed. Selecting a level-1 name includes the entire group (e.g. level-1 `Format`=183 results, level-2 `vlog`=136).", "example": [ "vlog" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "content_theme": { "title": "Content Theme", "description": "Content theme: use the **level-1 label** from contentTheme in `/blogger/filter-options` (e.g. Automotive / General). Note: only level-1 is supported; using a sub-item label or ID returns no results.", "example": [ "Automotive Features" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "audience20": { "title": "Audience20", "description": "\"Top-20 Audience Segments\": **do not use bare flat names**. For level-1, provide just the name (e.g. `Outdoor Leisure`, = the entire segment); **for level-2, write `\"level1 level1-level2\"`** (e.g. `\"Outdoor Leisure Outdoor Leisure-Extreme Challengers\"`) — the level-1 name must appear twice. **Using the level-2 label directly from the dictionary (e.g. `Extreme Challengers`) silently returns 0 results**. Level-1 and composite level-2 values can be mixed in the same array; multiple values are OR-ed. Full list available from `/get_blogger_filter_options` under audience20 (19 level-1 / 121 level-2 segments).", "example": [ "Free Travel", "Outdoor Freedom - Extreme Challengers" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "industry_crowd": { "title": "Industry Crowd", "description": "Industry-specific audience profile: use the **deepest leaf value** from automotiveIndustryTag in `/blogger/filter-options` (numeric string ID, e.g. 15795914; 1,600+ available). Using a label or intermediate-level ID returns no results.", "example": [ "15795914" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "consumer_behavior": { "title": "Consumer Behavior", "description": "Estimated consumer behavior: **must use the full space-separated path including the root node** (e.g. `\"Content Behavior Estimate Automotive\"`); the path can stop at any depth. See **consumerBehavior** in `/get_blogger_filter_options` (5-level tree). WARNING: Using a bare leaf name causes no error and returns no 0 results — instead the filter is silently ignored and the full unfiltered result set is returned. Only the full path form actually filters (e.g. `[\"Content Behavior Estimate Automotive\"]` returns 54 results). When using this filter, compare totals with and without it to confirm the filter is taking effect. Note: this field is rolled out per account; if the dictionary returns null, the current account does not have access.", "example": [ "Content behavior estimate: Automotive" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "note_scene": { "title": "Note Scene", "description": "Note category: use the **full space-separated path** (Category Level1 Level2 Level3), e.g. \"Automotive Rational-Decision Car-Selection-Guide Policy\". The path can stop at any depth (deeper = narrower). **Using only the last segment (e.g. \"Car-Selection-Guide\") returns 0 results.** See **contentScenes** in `/get_blogger_filter_options` (e.g. `[\"Automotive\"]`=75, `[\"Automotive Rational-Decision\"]`=23, 4-level path=1, `[\"Car-Selection-Guide\"]`=0).", "example": [ "Automotive: Rational Decision-Making, Car Selection Guide, Policy" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "gender": { "title": "Gender", "description": "Gender: Male / Female", "example": "Female", "nullable": true, "type": "string", "enum": [ "Male", "Female" ] }, "location": { "title": "Location", "description": "Creator location: plain place names work at any level (province/city/district), and multiple values are OR-ed (e.g. [\"Shanghai\"], [\"Hangzhou\"], [\"Shangcheng District\"]). Full path format (e.g. \"China Zhejiang Hangzhou\") is also accepted and will be converted automatically. See **areas** in /get_blogger_filter_options for available place names (down to district level).", "example": [ "Shanghai" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "signed": { "title": "Signed", "description": "Contract status: -1=no filter, 0=individual creator, 1=agency-signed creator", "example": 0, "nullable": true, "type": "integer", "enum": [ -1, 0, 1 ] } }, "additionalProperties": false, "type": "object", "title": "BloggerAttrFilter", "description": "Blogger attributes: category, persona, content specialty, audience profile, gender, region, contract status, etc.\n\nFor hierarchical options (category / persona / content specialty / content theme / top-20 audiences / industry profile / estimated consumer behavior), first call `/api/v2/pgy/blogger/filter-options` to get the values — each field description specifies which level to use." }, "RangeFilter": { "properties": { "min": { "title": "Min", "description": "Minimum value (inclusive)", "example": 10000, "nullable": true, "type": "number", "maximum": 1000000000000.0, "minimum": 0.0 }, "max": { "title": "Max", "description": "Maximum value (inclusive); omit for no upper limit", "example": 50000, "nullable": true, "type": "number", "maximum": 1000000000000.0, "minimum": 0.0 } }, "additionalProperties": false, "type": "object", "title": "RangeFilter", "description": "Numeric range corresponding to the custom input box in the web filter.\n\n- Either bound may be omitted: omitting `min` defaults to 0, omitting `max` means no upper limit\n- At least one bound must be provided, otherwise 422" }, "UpperPriceFilter": { "properties": { "cooperation_type": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Cooperation Type", "description": "Cooperation type: 1=embedded video, 2=custom video, 22=deep customization, 23=custom podcast, 24=podcast brand placement, 3=direct post, 4=repost; supported fields are returned in price_info_options.cooperation_type", "nullable": true }, "creative_skill": { "title": "Creative Skill", "description": "Deep-customization skill IDs: 1=Overseas Filming, 2=Hardcore Tech Analysis, 3=Short Film or Mini-movie, 4=Reality Show Challenge, 5=Makeover or DIY, 6=Interview or Street Interview, 7=TVC Production, 8=Specialty Editing, 9=Other; options are returned in price_info_options.creative_skill via /api/v1/bilibili/huahuo/square_static_info", "nullable": true, "items": { "type": "integer" }, "type": "array" }, "include_content": { "title": "Include Content", "description": "Included-content IDs for custom video, deep customization, or custom podcast: 1=Authorized derivative/distribution, 2=Complimentary preview clip, 3=Custom content. Options are returned in price_info_options.include_content", "nullable": true, "items": { "type": "integer" }, "type": "array" }, "price_min": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Price Min", "description": "Minimum quote in RMB; presets are returned in price_info_options.price_range by /api/v1/bilibili/huahuo/square_static_info", "nullable": true }, "price_max": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" } ], "title": "Price Max", "description": "Maximum quote in RMB; presets are returned in price_info_options.price_range by /api/v1/bilibili/huahuo/square_static_info", "nullable": true }, "price_right": { "title": "Price Right", "description": "Cooperation-right codes, e.g. show_in_video_first_1p3, show_in_video_gte_30s, brand_over_30_percent, auth_secondary_creation, multi_cooperation_discount, give_preview, give_poster. Full list and applicable types are in price_info_options.price_right returned by /api/v1/bilibili/huahuo/square_static_info; send [] when unselected or unavailable.", "nullable": true, "items": { "type": "string" }, "type": "array" } }, "additionalProperties": true, "type": "object", "title": "UpperPriceFilter", "description": "Quote filter for a cooperation format." }, "FansFilter": { "properties": { "count": { "description": "Follower count range", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "age": { "title": "Age", "description": "Audience age distribution: 0=no filter, 1=under 18, 2=18-24, 3=25-34, 4=35-44, 5=over 44 (high proportion)", "example": 3, "nullable": true, "type": "integer", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "gender": { "title": "Gender", "description": "Audience gender: 0=no filter, 1=predominantly male, 2=predominantly female", "example": 2, "nullable": true, "type": "integer", "enum": [ 0, 1, 2 ] }, "marital_status": { "title": "Marital Status", "description": "Relationship status: -1=no filter, 0=single/unmarried, 1=married", "nullable": true, "type": "integer", "enum": [ -1, 0, 1 ] }, "consumption_level": { "title": "Consumption Level", "description": "Consumption level: -1=no filter, 0=low, 1=medium, 2=high", "nullable": true, "type": "integer", "enum": [ -1, 0, 1, 2 ] }, "child_age": { "title": "Child Age", "description": "Parenting stage: 0=trying to conceive, 2=0-6 months, 3=7-12 months, 4=1-3 years, 5=4-6 years, 6=7-12 years, 7=early pregnancy, 8=late pregnancy", "nullable": true, "items": { "type": "integer", "enum": [ 0, 2, 3, 4, 5, 6, 7, 8 ] }, "type": "array", "maxItems": 30 }, "device_price": { "title": "Device Price", "description": "Phone price tier, e.g. 3000-3999 / 8000+", "example": [ "3000-3999" ], "nullable": true, "items": { "type": "string", "enum": [ "0-999", "1000-1999", "2000-2999", "3000-3999", "4000-4999", "5000-5999", "6000-6999", "7000-7999", "8000+" ] }, "type": "array", "maxItems": 30 }, "device_brand": { "title": "Device Brand", "description": "Phone brand", "example": [ "Apple" ], "nullable": true, "items": { "type": "string", "enum": [ "Apple", "Huawei", "OPPO", "VIVO", "Honor", "Xiaomi", "OnePlus", "Meizu", "ZTE", "Autocomplete" ] }, "type": "array", "maxItems": 30 }, "location": { "title": "Location", "description": "Audience location: plain place names work (e.g. [\"Shanghai\"], [\"Hangzhou\"]) and the full path will be filled in automatically. Full path format (e.g. \"China Zhejiang Hangzhou\") is also accepted. Note: this tree only goes down to city level (no district). See **fansAreas** in /get_blogger_filter_options for available values.", "example": [ "Shanghai" ], "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 } }, "additionalProperties": false, "type": "object", "title": "FansFilter", "description": "Audience profile — the \"Audience Profile\" section of the web page (follower count / age / gender / region / relationship status / spending / parenting & baby / mobile device)." }, "crawlers__xiaohongshu__pgy__pgy_content_filters__RangeFilter": { "properties": { "min": { "title": "Min", "description": "Minimum value (inclusive)", "nullable": true, "type": "integer", "maximum": 9999999.0, "minimum": 0.0 }, "max": { "title": "Max", "description": "Maximum value (inclusive); omit for no upper limit", "nullable": true, "type": "integer", "maximum": 9999999.0, "minimum": 0.0 } }, "additionalProperties": false, "type": "object", "title": "RangeFilter", "description": "Numeric range. Either bound may be omitted; at least one must be provided." }, "UpperHonorFilter": { "properties": { "honor_type": { "title": "Honor Type", "description": "Multi-select honor types: HOT, MZBK, and QZPHB", "nullable": true, "items": { "type": "string" }, "type": "array" }, "time_period": { "title": "Time Period", "description": "Time period: 0=all, or the most recent 30, 90, or 180 days", "nullable": true, "type": "integer" }, "honor_count": { "title": "Honor Count", "description": "Honor count: 0=all, 1=once, 2=twice, 3=three or more", "nullable": true, "type": "integer" } }, "additionalProperties": true, "type": "object", "title": "UpperHonorFilter", "description": "Creator video-honor filter." }, "crawlers__xiaohongshu__pgy__pgy_filters__FlagFilter": { "properties": { "is_star": { "title": "Is Star", "description": "Celebrity", "nullable": true, "type": "boolean" }, "new_high_quality": { "title": "New High Quality", "description": "Rising creator", "nullable": true, "type": "boolean" }, "high_quality": { "title": "High Quality", "description": "Quality creator", "nullable": true, "type": "boolean" }, "note_and_live": { "title": "Note And Live", "description": "Both notes and live streams available for collaboration", "nullable": true, "type": "boolean" }, "filter_intention": { "title": "Filter Intention", "description": "Intended industry match", "nullable": true, "type": "boolean" }, "activity_codes": { "title": "Activity Codes", "description": "Trending activity: use the `code` value for each item in the activities list from `/blogger/filter-options`", "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "exclude_low_active": { "title": "Exclude Low Active", "description": "Exclude low-activity creators", "nullable": true, "type": "boolean" }, "exclude_fans_down": { "title": "Exclude Fans Down", "description": "Exclude creators with declining followers", "nullable": true, "type": "boolean" }, "exclude_cooperated": { "title": "Exclude Cooperated", "description": "Exclude previously collaborated creators", "nullable": true, "type": "boolean" }, "exclude_invited": { "title": "Exclude Invited", "description": "Exclude already-invited creators", "nullable": true, "type": "boolean" }, "industry_first": { "title": "Industry First", "description": "Industry-recommended creators — level-1 industry name (e.g. Beauty & Personal Care); the platform will recommend creators specializing in that industry", "example": "Beauty & Personal Care", "nullable": true, "type": "string", "maxLength": 64 }, "industry_second": { "title": "Industry Second", "description": "Industry-recommended creators — level-2 industry name (used together with industry_first; values from taxonomy2Tags in industryTags in `/blogger/filter-options`)", "nullable": true, "type": "string", "maxLength": 64 } }, "additionalProperties": false, "type": "object", "title": "FlagFilter", "description": "Boolean flags — controls the \"Platform Recommendations\" (featured bloggers / trending campaigns) and \"Standard Exclusions\" (one-click exclude) sections on the web page." }, "CategoryFilter": { "properties": { "first": { "title": "First", "description": "Primary cooperation category, e.g. Women's Apparel / Women's Premium. Refer to the \"Cooperation Category\" on the Pugongying \"Live Blogger Plaza\" page. Passing only the primary level is sufficient.", "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 30 }, "second": { "title": "Second", "description": "Secondary cooperation category, e.g. Dress. May be left empty; filtering by primary level alone is also effective.", "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 200 } }, "additionalProperties": false, "type": "object", "title": "CategoryFilter", "description": "Web page \"Cooperation Category\" section (primary + secondary; secondary must match the selected primary)." }, "crawlers__xiaohongshu__pgy__pgy_live_filters__RangeFilter": { "properties": { "min": { "title": "Min", "description": "Minimum value (inclusive)", "nullable": true, "type": "number", "maximum": 1000000000000.0, "minimum": 0.0 }, "max": { "title": "Max", "description": "Maximum value (inclusive); omit for no upper limit", "nullable": true, "type": "number", "maximum": 1000000000000.0, "minimum": 0.0 } }, "additionalProperties": false, "type": "object", "title": "RangeFilter", "description": "Numeric range corresponding to the web filter tier or custom input box. Either bound may be omitted; at least one must be provided." }, "NoteFilter": { "properties": { "imp_median": { "description": "Median impressions", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "read_median": { "description": "Median reads", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "inter_median": { "description": "Median engagement count", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "thousand_like_percent": { "description": "1,000-like note ratio: fill 0-100 percent points (20 means 20%, not 0.2)", "nullable": true, "$ref": "#/components/schemas/PercentRange" }, "note_type": { "title": "Note Type", "description": "Note type: 0=no filter, 1=primarily image+text notes, 2=primarily video notes", "example": 2, "nullable": true, "type": "integer", "enum": [ 0, 1, 2 ] } }, "additionalProperties": false, "type": "object", "title": "NoteFilter", "description": "Organic note data — the 'Daily Notes' section on the web page (organic traffic performance over the last 30 days)." }, "CoopFilter": { "properties": { "pic_price": { "description": "Cooperation quote — fixed price for image+text notes (RMB)", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "video_price": { "description": "Cooperation quote — fixed price for video notes (RMB)", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "order_count": { "description": "Open orders (accepted but not yet completed), NOT lifetime collaboration count. This reflects current in-progress orders; do not use this field to find experienced creators.", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "reply_48h_ratio": { "description": "Cooperation credit — 48h invitation reply rate: fill 0-100 percent points (80 means 80%)", "nullable": true, "$ref": "#/components/schemas/PercentRange" }, "industry": { "title": "Industry", "description": "Recent collaboration industries", "example": "Beauty & Personal Care", "nullable": true, "type": "string", "enum": [ "No filter", "Beauty & Personal Care", "Food & Beverages", "Parenting & Baby", "Consumer Electronics & Appliances", "Daily necessities", "Clothing and accessories", "Internet", "Lifestyle Services", "Home & Building Materials", "Automotive" ] }, "brand_ids": { "title": "Brand Ids", "description": "Recent collaboration brands: list of brand userIds", "nullable": true, "items": { "type": "string", "maxLength": 64 }, "type": "array", "maxItems": 20 }, "exclude_brands": { "title": "Exclude Brands", "description": "Used with brand_ids: true=exclude bloggers who have cooperated with these brands", "nullable": true, "type": "boolean" }, "imp_median": { "description": "Reach scale — median impressions (collaboration notes)", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "read_median": { "description": "Reach scale — median reads (collaboration notes)", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "inter_median": { "description": "Reach scale — median engagement count (collaboration notes)", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "cpuv": { "description": "Reach scale — median store-visit UV count (not cost): median store-visit UV count for cross-domain collaboration notes in the last 30 days. **This is a visit count, not a monetary amount** (web tiers: 500-1000 / 1000-2000 / 2000-5000 / 5000-10000 / 10000+). To filter by cost per store visit, use estimate_cpuv instead.", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "pic_cpm": { "description": "Estimated CPM — image+text notes", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "video_cpm": { "description": "Estimated CPM — video notes", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "pic_read_price": { "description": "Estimated cost per read — image+text notes", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "video_read_price": { "description": "Estimated cost per read — video notes", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "pic_engage_cost": { "description": "Estimated cost per engagement — image+text notes", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "video_engage_cost": { "description": "Estimated cost per engagement — video notes", "nullable": true, "$ref": "#/components/schemas/RangeFilter" }, "estimate_cpuv": { "description": "Overflow store-visit cost per visit", "nullable": true, "$ref": "#/components/schemas/RangeFilter" } }, "additionalProperties": false, "type": "object", "title": "CoopFilter", "description": "Sponsored notes — the \"Sponsored Notes\" section on the web page (cooperation performance + data performance)." }, "PriceFilter": { "properties": { "kind": { "type": "integer", "enum": [ 1, 2 ], "title": "Kind", "description": "Quote type: 1=image-text note, 2=video note" }, "range": { "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_content_filters__RangeFilter", "description": "Quote range (CNY)" } }, "additionalProperties": false, "type": "object", "required": [ "kind", "range" ], "title": "PriceFilter", "description": "Web page \"Creator Pricing\": image-text and video are two independent channels; one must be selected first." }, "EcomFilter": { "properties": { "avg_gmv": { "description": "Average sales per session (CNY)", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_live_filters__RangeFilter" }, "brand_avg_gmv": { "description": "Average sales per session for partnered brands (CNY)", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_live_filters__RangeFilter" }, "atv": { "description": "Average order value (CNY). Matched by tier (0-100 / 100-200 / 200-500 ...). Any tier overlapping with the specified range will be included — e.g. passing 100-300 will also return buyers in the 200-500 tier.", "nullable": true, "$ref": "#/components/schemas/crawlers__xiaohongshu__pgy__pgy_live_filters__RangeFilter" } }, "additionalProperties": false, "type": "object", "title": "EcomFilter", "description": "Web page \"E-commerce Conversion Power\" section." }, "ModeEnum": { "type": "string", "enum": [ "encrypt", "decrypt" ], "title": "ModeEnum" }, "BillboardTagChild": { "properties": { "value": { "title": "Value", "description": "Sub-level vertical category tag id, obtained from the fetch_content_tag endpoint", "nullable": true, "type": "integer" } }, "type": "object", "title": "BillboardTagChild" }, "PercentRange": { "properties": { "min": { "title": "Min", "description": "Minimum value (inclusive), percentile 0-100", "example": 20, "nullable": true, "type": "number", "maximum": 100.0, "minimum": 0.0 }, "max": { "title": "Max", "description": "Maximum value (inclusive), percentile 0-100", "example": 80, "nullable": true, "type": "number", "maximum": 100.0, "minimum": 0.0 } }, "additionalProperties": false, "type": "object", "title": "PercentRange", "description": "Percentage range: enter a value between 0 and 100 as a percentile, e.g. `40` means 40% (**not 0.4**).\n\nThis convention follows the PGY web interface: the tier for notes-per-thousand-likes is written as `{\"40% and above\": [40, null]}` or `{\"below 10%\": [null, 10]}` — the value sent upstream is simply 40 or 10.\n\n**What is and is not validated — stated clearly to avoid confusion**:\n* Caught: values with the wrong order of magnitude — entering 200 or 9500 (as if using parts-per-ten-thousand or raw counts) will return a 422 error, whereas the generic RangeFilter allows up to 1e12 and previously passed such values through.\n* **Not caught: values that are too small** — entering 0.4 is still valid because 0.4% is a legitimate value; the type system cannot distinguish \"meant 40% but wrote 0.4\" from \"genuinely filtering for 0.4%\". This ambiguity can only be resolved through field documentation." }, "Body_fetch_home_feed_api_v1_tiktok_web_fetch_home_feed_post": { "properties": { "count": { "type": "integer", "title": "Count", "description": "Number per page", "default": 15 }, "cookie": { "type": "string", "title": "Cookie", "description": "User's own cookie, optional parameter, used for personalized recommendations of interface return data." }, "region": { "type": "string", "title": "Region", "description": "SG, default US.", "default": "US" } }, "type": "object", "title": "Body_fetch_home_feed_api_v1_tiktok_web_fetch_home_feed_post" }, "Body_fetch_user_like_videos_api_v1_douyin_web_fetch_user_like_videos_post": { "properties": { "sec_user_id": { "type": "string", "title": "Sec User Id", "description": "User sec_user_id" }, "max_cursor": { "type": "integer", "title": "Max Cursor", "description": "Maximum cursor", "default": 0 }, "counts": { "type": "integer", "title": "Counts", "description": "Number per page", "default": 20 }, "cookie": { "type": "string", "title": "Cookie", "description": "Your web version of Douyin Cookie" } }, "type": "object", "required": [ "sec_user_id" ], "title": "Body_fetch_user_like_videos_api_v1_douyin_web_fetch_user_like_videos_post" }, "CommentSortByAPI": { "type": "string", "enum": [ "top", "newest" ], "title": "CommentSortByAPI", "description": "See API documentation" }, "DeliveryEffectEstimateRequest": { "properties": { "item_ids": { "type": "string", "minLength": 1, "title": "Item Ids", "description": "Item id(s), comma separated; normally use schema=0 for one item and schema=3 for multiple items", "example": "7677202522116819185" }, "external_action": { "type": "integer", "title": "External Action", "description": "Optimization action code; must match target_id, default 44 (NativeAction). Common values: 45=like, 46=follow, 47=comment, 51=link click, 102=multiple native actions, 181=homepage visit", "default": 44, "example": 44 }, "target_id": { "type": "integer", "title": "Target Id", "description": "Promotion target id, default 31 (likes and comments). Common values: 32=followers, 33=homepage visits, 37=video plays, 40=live popularity, 45=comment-link clicks, 63=show to followers, 78=natural promotion, 81=high interaction frequency", "default": 31, "example": 31 }, "schema": { "type": "integer", "title": "Schema", "description": "Delivery schema: 0=single-item Default, 3=multi-item BatchDelivery; the official client selects it from the item count", "default": 0, "example": 0 }, "is_max_cv": { "type": "boolean", "title": "Is Max Cv", "description": "Whether to estimate in MaxCV (maximum-conversion-volume) mode; the official client derives it from target capability, item count, budget and manual-bid state, default true", "default": true, "example": true }, "pay_type": { "type": "integer", "maximum": 3.0, "minimum": 0.0, "title": "Pay Type", "description": "Payment channel: 0=CashDesk, 1=IAP, 2=Caijing, 3=CgTradeCash; the official estimate request uses 1", "default": 1, "example": 1 }, "cost_int": { "type": "integer", "exclusiveMinimum": true, "title": "Cost Int", "description": "1000), default 30000 (CNY 30", "default": 30000, "example": 30000, "minimum": 0.0 }, "duration_seconds": { "type": "integer", "exclusiveMinimum": true, "title": "Duration Seconds", "description": "Delivery duration in seconds, default 21600 (6 hours", "default": 21600, "example": 21600, "minimum": 0.0 } }, "type": "object", "required": [ "item_ids" ], "title": "DeliveryEffectEstimateRequest", "description": "DOU+ Delivery Effect Estimate Request Model" }, "FetchAccountArticlesRequest": { "properties": { "username": { "type": "string", "maxLength": 80, "pattern": "^[0-9A-Za-z][-_0-9A-Za-z]{1,63}(@[0-9A-Za-z]{1,16})?$", "title": "Username", "description": "Official account username. Three forms are supported: `gh_…`, `gh_…@app` (mini-program-linked accounts) and custom WeChat IDs (e.g. `nikejdi`). Taken from `$.data.content.user_name` of the article detail endpoints", "example": "gh_363b924965e9" }, "page_size": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Page Size", "description": "next_offset/Articles per page (default 20). NOTE: WeChat currently ignores this parameter — the count is decided by the account itself; paginate with offset / next_offset", "default": 20 }, "offset": { "title": "Offset", "description": "Pagination cursor (base64), leave empty for first page; for the next page pass next_offset from the previous response", "default": "", "nullable": true, "type": "string", "maxLength": 8192, "pattern": "^[A-Za-z0-9+/=_-]*$" }, "item_show_type": { "title": "Item Show Type", "description": "0=articles (default), 5=videos, 7=audios, 8=image-text posts", "nullable": true, "type": "integer" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "username" ], "title": "FetchAccountArticlesRequest" }, "FetchAccountRequest": { "properties": { "username": { "type": "string", "maxLength": 80, "pattern": "^[0-9A-Za-z][-_0-9A-Za-z]{1,63}(@[0-9A-Za-z]{1,16})?$", "title": "Username", "description": "Official account username. Three forms are supported: `gh_…`, `gh_…@app` (mini-program-linked accounts) and custom WeChat IDs (e.g. `nikejdi`). Taken from `$.data.content.user_name` of the article detail endpoints", "example": "gh_363b924965e9" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "username" ], "title": "FetchAccountRequest" }, "FetchArticleCommentsRequest": { "properties": { "url": { "type": "string", "maxLength": 2048, "pattern": "^https?://mp\\.weixin\\.qq\\.com/s([/?].+)?$", "title": "Url", "description": "…", "example": "https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw" }, "buffer": { "title": "Buffer", "description": "Pagination cursor, leave empty for first page; pass buffer from the previous response", "default": "", "nullable": true, "type": "string", "maxLength": 8192 }, "comment_id": { "title": "Comment Id", "description": "Article comment id (optional, performance shortcut): when omitted, upstream must fetch and parse the whole article HTML to obtain it, which accounts for about half of this endpoint's latency", "nullable": true, "type": "string", "maxLength": 32, "pattern": "^[0-9]*$" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "url" ], "title": "FetchArticleCommentsRequest" }, "FetchArticleDetailRequest": { "properties": { "url": { "type": "string", "maxLength": 2048, "pattern": "^https?://mp\\.weixin\\.qq\\.com/s([/?].+)?$", "title": "Url", "description": "… or long URL with __biz", "example": "https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "url" ], "title": "FetchArticleDetailRequest" }, "FetchArticleStatsH5Request": { "properties": { "url": { "type": "string", "maxLength": 2048, "pattern": "^https?://mp\\.weixin\\.qq\\.com/s([/?].+)?$", "title": "Url", "description": "… or long URL with __biz", "example": "https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true }, "comment_id": { "title": "Comment Id", "description": "Article comment id (optional, performance shortcut): when omitted, upstream must fetch and parse the whole article HTML to obtain it, which accounts for about half of this endpoint's latency", "nullable": true, "type": "string", "maxLength": 32, "pattern": "^[0-9]*$" } }, "type": "object", "required": [ "url" ], "title": "FetchArticleStatsH5Request", "description": "`/fetch_article_stats_h5` FetchArticleDetailRequest comment_id" }, "FetchChannelIdToUsernameRequest": { "properties": { "channel_id": { "type": "string", "maxLength": 64, "pattern": "^sph[A-Za-z0-9_-]+$", "title": "Channel Id", "description": "WeChat Channels ID (short ID starting with sph", "example": "sphi9BjV8GK0Zsl" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": false } }, "type": "object", "required": [ "channel_id" ], "title": "FetchChannelIdToUsernameRequest" }, "FetchChannelInfoRequest": { "properties": { "username": { "type": "string", "maxLength": 256, "minLength": 10, "pattern": "^v2_[0-9a-fA-F]+@finder$", "title": "Username", "description": "WeChat Channels finder username (v2_…@finder format", "example": "v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "username" ], "title": "FetchChannelInfoRequest" }, "FetchCollectionVideosRequest": { "properties": { "topic_id": { "type": "string", "maxLength": 32, "pattern": "^[0-9]+$", "title": "Topic Id", "description": "Collection ID (numeric, from topic_id of fetch_user_collections", "example": "14616794565351966924" }, "topic": { "title": "Topic", "description": "Collection name (optional, improves hit rate", "default": "", "example": "See API documentation", "nullable": true, "type": "string", "maxLength": 100 }, "username": { "title": "Username", "description": "Creator finder username (optional, improves hit rate", "default": "", "example": "v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder", "nullable": true, "type": "string", "maxLength": 256, "pattern": "^(v2_[0-9a-fA-F]+@finder)?$" }, "last_buffer": { "title": "Last Buffer", "description": "Pagination cursor (base64), leave empty for first page", "default": "", "nullable": true, "type": "string", "pattern": "^[A-Za-z0-9+/=_-]*$" }, "topic_type": { "type": "integer", "maximum": 1000.0, "minimum": 0.0, "title": "Topic Type", "description": "Collection type, default 16 (align with topic_type from fetch_user_collections", "default": 16 }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure (recommended for media download", "default": true } }, "type": "object", "required": [ "topic_id" ], "title": "FetchCollectionVideosRequest" }, "FetchCommentRepliesRequest": { "properties": { "url": { "type": "string", "maxLength": 2048, "pattern": "^https?://mp\\.weixin\\.qq\\.com/s([/?].+)?$", "title": "Url", "description": "…", "example": "http://mp.weixin.qq.com/s?__biz=Mzk3NTA0MzM5NA==&mid=2247483745&idx=1&sn=3f34e768cf457a501038991ed30be1f4#rd" }, "content_id": { "title": "Content Id", "description": "content_id (numeric) of the target first-level comment; defaults to the first comment that has replies", "default": "", "example": "12109128638545265979", "nullable": true, "type": "string", "maxLength": 32, "pattern": "^[0-9]*$" }, "offset": { "type": "integer", "minimum": 0.0, "title": "Offset", "description": "Reply pagination offset, 0 for first page; pass next_offset from the previous response when has_more=true", "default": 0 }, "comment_id": { "title": "Comment Id", "description": "Article comment id (optional, performance shortcut): when omitted, upstream must fetch and parse the whole article HTML to obtain it, which accounts for about half of this endpoint's latency", "nullable": true, "type": "string", "maxLength": 32, "pattern": "^[0-9]*$" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "url" ], "title": "FetchCommentRepliesRequest" }, "FetchLiveDetailRequest": { "properties": { "live_id": { "type": "string", "maxLength": 32, "pattern": "^[0-9]+$", "title": "Live Id", "description": "Live ID (numeric", "example": "2078950291205875194" }, "scene": { "type": "integer", "maximum": 1000.0, "minimum": 0.0, "title": "Scene", "description": "Entry scene, default 5", "default": 5 }, "finder_username": { "title": "Finder Username", "description": "Anchor finder username (optional, improves hit rate", "default": "", "example": "v2_060000231003b20faec8cae1811ac4d5c702ea32b0771737aa785454f7f8177114cc4d248d66@finder", "nullable": true, "type": "string", "maxLength": 256, "pattern": "^(v2_[0-9a-fA-F]+@finder)?$" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "live_id" ], "title": "FetchLiveDetailRequest" }, "FetchLiveHistoryRequest": { "properties": { "username": { "type": "string", "maxLength": 256, "minLength": 10, "pattern": "^v2_[0-9a-fA-F]+@finder$", "title": "Username", "description": "WeChat Channels finder username (v2_…@finder format", "example": "v2_060000231003b20faec8cae1811ac4d5c702ea32b0771737aa785454f7f8177114cc4d248d66@finder" }, "last_buffer": { "title": "Last Buffer", "description": "Pagination cursor (base64), leave empty for first page", "default": "", "nullable": true, "type": "string", "pattern": "^[A-Za-z0-9+/=_-]*$" }, "flag": { "type": "integer", "maximum": 1000.0, "minimum": 0.0, "title": "Flag", "description": "Fetch flag, default 12", "default": 12 }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure (recommended for media download", "default": true } }, "type": "object", "required": [ "username" ], "title": "FetchLiveHistoryRequest" }, "FetchSearchChannelVideosRequest": { "properties": { "username": { "type": "string", "maxLength": 256, "minLength": 10, "pattern": "^v2_[0-9a-fA-F]+@finder$", "title": "Username", "description": "Creator finder username (v2_…@finder format", "example": "v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder" }, "keyword": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Keyword", "description": "Keyword to search within this channel (1-100 chars", "example": "See API documentation" }, "cursor": { "title": "Cursor", "description": "Pagination cursor: leave empty for the first page; pass back the previous response's next_cursor verbatim (opaque string, do not parse or concatenate", "nullable": true, "type": "string", "maxLength": 4096 }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "username", "keyword" ], "title": "FetchSearchChannelVideosRequest" }, "FetchSearchRequest": { "properties": { "keyword": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Keyword", "description": "Search keyword (1-100 chars", "example": "See API documentation" }, "business_type": { "type": "string", "enum": [ "all", "account", "article", "video", "sticker", "underline", "encyclopedia", "live_stream", "comment", "listen", "news", "photos", "book", "moments", "image", "mini_game", "weixin_index", "ai_search" ], "title": "Business Type", "description": "ai_search) are gated server-side per account & region and currently always come back empty (count=0 plus a no_more message — still billed as a normal call). Use the `categories` field of an `all` search for the authoritative per-account tab list. Values outside this list are rejected (422", "default": "all", "example": "account" }, "sort": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Sort", "description": "hot/2 (most liked); string key or integer", "default": "default", "example": "hot" }, "publish_time": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Publish Time", "description": "half_year/3; string key or integer", "default": "all", "example": "week" }, "offset": { "type": "integer", "minimum": 0.0, "title": "Offset", "description": "Pass 0 for the first page; use cursor to paginate (offset alone does not work — it returns the first page every time", "default": 0 }, "cursor": { "title": "Cursor", "description": "Pagination cursor: leave empty for the first page; for the next page pass back the cursor returned in the previous response", "nullable": true, "type": "string" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw search response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "keyword" ], "title": "FetchSearchRequest" }, "FetchSearchVideosRequest": { "properties": { "keyword": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Keyword", "description": "Search keyword (1-100 chars", "example": "See API documentation" }, "duration": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Duration", "description": "long/3 (20min+); string key or integer", "default": "all", "example": "short" }, "sort": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Sort", "description": "hot/2 (most liked); string key or integer", "default": "default", "example": "hot" }, "publish_time": { "anyOf": [ { "type": "integer" }, { "type": "string" } ], "title": "Publish Time", "description": "half_year/3; string key or integer", "default": "all", "example": "week" }, "offset": { "type": "integer", "minimum": 0.0, "title": "Offset", "description": "Pass 0 for the first page; use cursor to paginate (offset alone does not work", "default": 0 }, "cursor": { "title": "Cursor", "description": "Pagination cursor, same as universal search: leave empty for the first page; pass back the cursor from the previous response", "nullable": true, "type": "string" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw search response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "keyword" ], "title": "FetchSearchVideosRequest" }, "FetchUserCollectionsRequest": { "properties": { "username": { "type": "string", "maxLength": 256, "minLength": 10, "pattern": "^v2_[0-9a-fA-F]+@finder$", "title": "Username", "description": "WeChat Channels finder username (v2_…@finder format", "example": "v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "username" ], "title": "FetchUserCollectionsRequest" }, "FetchUserProfileRequest": { "properties": { "username": { "type": "string", "maxLength": 256, "minLength": 10, "pattern": "^v2_[0-9a-fA-F]+@finder$", "title": "Username", "description": "WeChat Channels finder username (v2_…@finder format", "example": "v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "username" ], "title": "FetchUserProfileRequest" }, "FetchUserVideosRequest": { "properties": { "username": { "type": "string", "maxLength": 256, "minLength": 10, "pattern": "^v2_[0-9a-fA-F]+@finder$", "title": "Username", "description": "WeChat Channels finder username (v2_…@finder format", "example": "v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder" }, "last_buffer": { "title": "Last Buffer", "description": "Pagination cursor (base64), leave empty for first page", "default": "", "nullable": true, "type": "string", "pattern": "^[A-Za-z0-9+/=_-]*$" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure (recommended for media download", "default": true } }, "type": "object", "required": [ "username" ], "title": "FetchUserVideosRequest" }, "FetchVideoCommentsRequest": { "properties": { "object_id": { "type": "string", "maxLength": 32, "pattern": "^[0-9]+$", "title": "Object Id", "description": "Video objectId (numeric", "example": "14941130915890399732" }, "last_buffer": { "title": "Last Buffer", "description": "Pagination cursor (base64), leave empty for first page", "default": "", "nullable": true, "type": "string", "pattern": "^[A-Za-z0-9+/=_-]*$" }, "comment_id": { "title": "Comment Id", "description": "Pass a commentId (numeric) to expand its replies, leave empty for first-level comments", "default": "", "nullable": true, "type": "string", "maxLength": 32, "pattern": "^[0-9]*$" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "object_id" ], "title": "FetchVideoCommentsRequest" }, "FetchVideoDetailRequest": { "properties": { "object_id": { "title": "Object Id", "description": "Video objectId (numeric, highest priority", "default": "", "example": "14941130915890399732", "nullable": true, "type": "string", "maxLength": 32, "pattern": "^[0-9]*$" }, "export_id": { "title": "Export Id", "description": "expires soon", "default": "", "nullable": true, "type": "string", "maxLength": 2048, "pattern": "^(export/.+)?$" }, "object_nonce_id": { "title": "Object Nonce Id", "description": "Optional objectNonceId (numeric, improves hit rate", "default": "", "nullable": true, "type": "string", "maxLength": 32, "pattern": "^[0-9]*$" }, "share_url": { "title": "Share Url", "description": "…), used only when object_id and export_id are empty", "default": "", "nullable": true, "type": "string", "maxLength": 256, "pattern": "^(https?://weixin\\.qq\\.com/sph/[A-Za-z0-9]+/?)?$" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure (recommended for media download", "default": true } }, "type": "object", "title": "FetchVideoDetailRequest" }, "FetchVideoShareUrlRequest": { "properties": { "object_id": { "type": "string", "maxLength": 32, "pattern": "^[0-9]+$", "title": "Object Id", "description": "Video objectId (numeric", "example": "14941130915890399732" }, "raw": { "type": "boolean", "title": "Raw", "description": "True=raw response; False=simplified parsed structure", "default": true } }, "type": "object", "required": [ "object_id" ], "title": "FetchVideoShareUrlRequest" }, "YouTubeContentTypeAPI": { "type": "string", "enum": [ "video", "channel", "playlist", "movie" ], "title": "YouTubeContentTypeAPI", "description": "YouTube - API" }, "YouTubeDurationAPI": { "type": "string", "enum": [ "short", "medium", "long" ], "title": "YouTubeDurationAPI", "description": "YouTube - API" }, "YouTubeFeatureAPI": { "type": "string", "enum": [ "live", "4k", "hd", "subtitles", "creative_commons", "360", "vr180", "3d", "hdr", "location", "purchased" ], "title": "YouTubeFeatureAPI", "description": "YouTube - API" }, "YouTubeSearchSortAPI": { "type": "string", "enum": [ "relevance", "upload_date", "view_count", "rating" ], "title": "YouTubeSearchSortAPI", "description": "YouTube - API" }, "YouTubeUploadTimeAPI": { "type": "string", "enum": [ "hour", "today", "week", "month", "year" ], "title": "YouTubeUploadTimeAPI", "description": "YouTube - API" } } }, "paths": { "/tikhub/bilibili/web/bv_to_aid": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_bv_to_aid", "summary": "Generate aid by bvid", "description": "Generate aid by bvid", "parameters": [ { "name": "bv_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Bv Id" }, "description": "Video ID", "example": "BV1M1421t7hT" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_all_live_areas": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_all_live_areas", "summary": "Get a list of all live areas", "description": "Get a list of all live areas", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_bangumi_tab": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_bangumi_tab", "summary": "Get bangumi tab", "description": "Get bangumi tab", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_cinema_tab": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_cinema_tab", "summary": "Get cinema tab", "description": "Get cinema tab", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_collect_folders": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_collect_folders", "summary": "Get user collection folders", "description": "Get user collection folders", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User UID", "title": "Uid" }, "description": "User UID", "example": "178360345" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_com_popular": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_com_popular", "summary": "Get comprehensive popular video information", "description": "Get comprehensive popular video information", "parameters": [ { "name": "pn", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Pn" }, "description": "Page number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_comment_reply": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_comment_reply", "summary": "Get reply to the specified comment", "description": "Get reply to the specified comment", "parameters": [ { "name": "bv_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Bv Id" }, "description": "Video ID", "example": "BV1M1421t7hT" }, { "name": "pn", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Pn" }, "description": "Page number" }, { "name": "rpid", "in": "query", "required": true, "schema": { "type": "string", "description": "Reply id", "title": "Rpid" }, "description": "Reply id", "example": "237109455120" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_dynamic_detail_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_dynamic_detail_v2", "summary": "Get dynamic detail v2", "description": "Get dynamic detail v2", "parameters": [ { "name": "dynamic_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Dynamic id", "title": "Dynamic Id" }, "description": "Dynamic id", "example": "1172584638000922630" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_general_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_general_search", "summary": "Get general search data", "description": "Get general search data", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "Naruto" }, { "name": "order", "in": "query", "required": true, "schema": { "type": "string", "description": "Order method", "title": "Order" }, "description": "Order method", "example": "totalrank" }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "description": "Page number", "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "page_size", "in": "query", "required": true, "schema": { "type": "integer", "description": "Number per page", "title": "Page Size" }, "description": "Number per page", "example": 42 }, { "name": "duration", "in": "query", "required": false, "schema": { "type": "integer", "description": "Duration filter", "default": 0, "title": "Duration" }, "description": "Duration filter" }, { "name": "pubtime_begin_s", "in": "query", "required": false, "schema": { "type": "integer", "description": "Start date (10-digit timestamp)", "default": 0, "title": "Pubtime Begin S" }, "description": "Start date (10-digit timestamp)" }, { "name": "pubtime_end_s", "in": "query", "required": false, "schema": { "type": "integer", "description": "End date (10-digit timestamp)", "default": 0, "title": "Pubtime End S" }, "description": "End date (10-digit timestamp)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_get_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_get_user_id", "summary": "Extract user ID", "description": "Extract user ID", "parameters": [ { "name": "share_link", "in": "query", "required": true, "schema": { "type": "string", "description": "User share link", "title": "Share Link" }, "description": "User share link", "example": "https://b23.tv/1ZuB5NC" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_home_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_home_feed", "summary": "Get home feed", "description": "Get home feed", "parameters": [ { "name": "idx", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page index", "title": "Idx" }, "description": "Page index" }, { "name": "flush", "in": "query", "required": false, "schema": { "type": "integer", "description": "Flush flag (0=normal load, 1=refresh)", "default": 0, "title": "Flush" }, "description": "Flush flag (0=normal load, 1=refresh)" }, { "name": "pull", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Pull to refresh", "default": true, "title": "Pull" }, "description": "Pull to refresh" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_hot_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_hot_search", "summary": "Get hot search data", "description": "Get hot search data", "parameters": [ { "name": "limit", "in": "query", "required": true, "schema": { "description": "Return number", "title": "Limit" }, "description": "Return number", "example": 10 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_live_room_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_live_room_detail", "summary": "Get information of specified live room", "description": "Get information of specified live room", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room ID", "title": "Room Id" }, "description": "Live room ID", "example": "22816111" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_live_streamers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_live_streamers", "summary": "Get live streamers of specified live area", "description": "Get live streamers of specified live area", "parameters": [ { "name": "area_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live area ID", "title": "Area Id" }, "description": "Live area ID", "example": "9" }, { "name": "pn", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Pn" }, "description": "Page number" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/bilibili/web/fetch_live_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_live_videos", "summary": "Get live video data of specified room", "description": "Get live video data of specified room", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room ID", "title": "Room Id" }, "description": "Live room ID", "example": "1815229528" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_one_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_one_video", "summary": "Get single video data", "description": "Get single video data", "parameters": [ { "name": "av_id", "in": "query", "required": false, "schema": { "type": "string", "description": "AV ID", "title": "Av Id" }, "description": "AV ID", "example": "115568241811221" }, { "name": "bv_id", "in": "query", "required": false, "schema": { "type": "string", "description": "BV ID", "title": "Bv Id" }, "description": "BV ID", "example": "BV18SCrBGE9E" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_popular_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_popular_feed", "summary": "Get popular feed", "description": "Get popular feed", "parameters": [ { "name": "idx", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page index", "default": 1, "title": "Idx" }, "description": "Page index" }, { "name": "last_param", "in": "query", "required": false, "schema": { "type": "string", "description": "Last video ID from the previous page", "title": "Last Param" }, "description": "Last video ID from the previous page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_reply_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_reply_detail", "summary": "Get reply detail", "description": "Get reply detail", "parameters": [ { "name": "root", "in": "query", "required": true, "schema": { "type": "string", "description": "Root comment ID", "title": "Root" }, "description": "Root comment ID", "example": "241743663521" }, { "name": "av_id", "in": "query", "required": false, "schema": { "type": "string", "description": "AV ID", "title": "Av Id" }, "description": "AV ID", "example": "113100682434775" }, { "name": "bv_id", "in": "query", "required": false, "schema": { "type": "string", "description": "BV ID", "title": "Bv Id" }, "description": "BV ID", "example": "BV18SCrBGE9E" }, { "name": "next_offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Next page cursor", "default": 0, "title": "Next Offset" }, "description": "Next page cursor" }, { "name": "ps", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page size", "default": 20, "title": "Ps" }, "description": "Page size" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_search_all": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_search_all", "summary": "search all", "description": "search all", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "Genshin Impact" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for the first page; for the next page pass back data.pagination.next from the previous response", "default": "", "title": "Cursor" }, "description": "Pagination cursor, leave empty for the first page; for the next page pass back data.pagination.next from the previous response" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page size", "default": 20, "title": "Page Size" }, "description": "Page size" }, { "name": "order", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort order: 0=Comprehensive", "default": 0, "title": "Order" }, "description": "Sort order: 0=Comprehensive" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_search_by_type": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_search_by_type", "summary": "search by type", "description": "search by type", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "Genshin Impact" }, { "name": "search_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Search type: video/bangumi/pgc/live/article/user", "default": "video", "title": "Search Type" }, "description": "Search type: video/bangumi/pgc/live/article/user" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for the first page; for the next page pass back data.pagination.next from the previous response", "default": "", "title": "Cursor" }, "description": "Pagination cursor, leave empty for the first page; for the next page pass back data.pagination.next from the previous response" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page size", "default": 20, "title": "Page Size" }, "description": "Page size" }, { "name": "order", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort order: 0=Comprehensive, 1=Latest, 2=Views, 3=Bullet comment count", "default": 0, "title": "Order" }, "description": "Sort order: 0=Comprehensive, 1=Latest, 2=Views, 3=Bullet comment count" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_user_collection_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_user_collection_videos", "summary": "Gets video data from a collection folder", "description": "Gets video data from a collection folder", "parameters": [ { "name": "folder_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Collection folder id", "title": "Folder Id" }, "description": "Collection folder id", "example": "1756059545" }, { "name": "pn", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Pn" }, "description": "Page number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_user_dynamic": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_user_dynamic", "summary": "Get dynamic information of specified user", "description": "Get dynamic information of specified user", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User UID", "title": "Uid" }, "description": "User UID", "example": "16015678" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Start index / offset", "default": "", "title": "Offset" }, "description": "Start index / offset", "example": "953154282154098691" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_user_info", "summary": "Get user info", "description": "Get user info", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "203680252" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_user_post_videos_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_user_post_videos_v2", "summary": "Get user homepage video data V2", "description": "Get user homepage video data V2", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User UID", "title": "Uid" }, "description": "User UID", "example": "178360345" }, { "name": "pn", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number, no cap", "default": 1, "title": "Pn" }, "description": "Page number, no cap" }, { "name": "ps", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Page size, max 100", "default": 30, "title": "Ps" }, "description": "Page size, max 100" }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string", "description": "Keyword; leave empty to return all", "default": "", "title": "Keyword" }, "description": "Keyword; leave empty to return all" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_user_profile", "summary": "Get information of specified user", "description": "Get information of specified user", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User UID", "title": "Uid" }, "description": "User UID", "example": "178360345" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_user_relation_stat": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_user_relation_stat", "summary": "Get user relation stat (following and followers)", "description": "Get user relation stat (following and followers)", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User UID", "title": "Uid" }, "description": "User UID", "example": "178360345" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_user_up_stat": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_user_up_stat", "summary": "Get UP stat (total views and likes)", "description": "Get UP stat (total views and likes)", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User UID", "title": "Uid" }, "description": "User UID", "example": "178360345" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_user_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_user_videos", "summary": "Get user videos", "description": "Get user videos", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "203680252" }, { "name": "post_filter", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter type (archive/season/contribute)", "default": "archive", "title": "Post Filter" }, "description": "Filter type (archive/season/contribute)" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number" }, { "name": "ps", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page size", "default": 20, "title": "Ps" }, "description": "Page size" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/app/fetch_video_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_app_fetch_video_comments", "summary": "Get video comments", "description": "Get video comments", "parameters": [ { "name": "av_id", "in": "query", "required": false, "schema": { "type": "string", "description": "AV ID", "title": "Av Id" }, "description": "AV ID", "example": "115568241811221" }, { "name": "bv_id", "in": "query", "required": false, "schema": { "type": "string", "description": "BV ID", "title": "Bv Id" }, "description": "BV ID", "example": "BV18SCrBGE9E" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort mode: 3=hot, 2=time", "default": 3, "title": "Mode" }, "description": "Sort mode: 3=hot, 2=time" }, { "name": "next_offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Pagination cursor", "default": 1, "title": "Next Offset" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_video_danmaku": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_video_danmaku", "summary": "Get Video Danmaku", "description": "Get Video Danmaku", "parameters": [ { "name": "cid", "in": "query", "required": true, "schema": { "type": "string", "description": "Video cid", "title": "Cid" }, "description": "Video cid", "example": "1639235405" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_video_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_video_detail", "summary": "Get single video detail", "description": "Get single video detail", "parameters": [ { "name": "aid", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aid" }, "description": "Video ID", "example": "114902186396822" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_video_parts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_video_parts", "summary": "Get Video Parts By bvid", "description": "Get Video Parts By bvid", "parameters": [ { "name": "bv_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Bv Id" }, "description": "Video ID", "example": "BV1vf421i7hV" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_video_play_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_video_play_info", "summary": "Get single video play info", "description": "Get single video play info", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Video URL", "title": "Url" }, "description": "Video URL", "example": "https://www.bilibili.com/video/BV1S5uKzzE4r" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_video_playurl": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_video_playurl", "summary": "Get video playurl", "description": "Get video playurl", "parameters": [ { "name": "bv_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Bv Id" }, "description": "Video ID", "example": "BV1y7411Q7Eq" }, { "name": "cid", "in": "query", "required": true, "schema": { "type": "string", "description": "Video cid", "title": "Cid" }, "description": "Video cid", "example": "171776208" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_video_subtitle": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_video_subtitle", "summary": "Get video subtitle info", "description": "Get video subtitle info", "parameters": [ { "name": "a_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "A Id" }, "description": "Video ID", "example": "114006081739452" }, { "name": "c_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video cid", "title": "C Id" }, "description": "Video cid", "example": "28400484458" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/web/fetch_vip_video_playurl": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "post_tikhub_bilibili_web_fetch_vip_video_playurl", "summary": "Get VIP video playurl", "description": "Get VIP video playurl", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VIPVideoModel" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/encrypt_uid_to_sec_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_encrypt_uid_to_sec_user_id", "summary": "Encrypt user uid to sec_user_id", "description": "Encrypt user uid to sec_user_id", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User uid (short_id)", "title": "Uid" }, "description": "User uid (short_id)", "example": "1673937488185292" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_batch_user_profile_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.2175, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_batch_user_profile_v2", "summary": "Get batch user profile (up to 50)", "description": "Get batch user profile (up to 50)", "parameters": [ { "name": "sec_user_ids", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_user_id list, separated by commas", "title": "Sec User Ids" }, "description": "User sec_user_id list, separated by commas", "example": "MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE,MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_brand_hot_search_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_brand_hot_search_list", "summary": "Get Douyin brand hot search list data", "description": "Get Douyin brand hot search list data", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_brand_hot_search_list_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_brand_hot_search_list_detail", "summary": "Get Douyin brand hot search list detail data", "description": "Get Douyin brand hot search list detail data", "parameters": [ { "name": "category_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Category id", "title": "Category Id" }, "description": "Category id", "example": 10 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_cartoon_aweme": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_cartoon_aweme", "summary": "Anime Video", "description": "Anime Video", "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "integer", "description": "Number per page", "title": "Count" }, "description": "Number per page", "example": 16 }, { "name": "refresh_index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Paging index", "default": 1, "title": "Refresh Index" }, "description": "Paging index" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User provided Cookie", "title": "Cookie" }, "description": "User provided Cookie" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_challenge_posts": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_fetch_challenge_posts", "summary": "Challenge Posts", "description": "Challenge Posts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChallengePostRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_douyin_web_guest_cookie": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_douyin_web_guest_cookie", "summary": "Get the guest Cookie of Douyin Web", "description": "Get the guest Cookie of Douyin Web", "parameters": [ { "name": "user_agent", "in": "query", "required": true, "schema": { "type": "string", "description": "User browser agent", "title": "User Agent" }, "description": "User browser agent", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_food_aweme": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_food_aweme", "summary": "Food Video", "description": "Food Video", "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "integer", "description": "Number per page", "title": "Count" }, "description": "Number per page", "example": 16 }, { "name": "refresh_index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Paging index", "default": 1, "title": "Refresh Index" }, "description": "Paging index" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User provided Cookie", "title": "Cookie" }, "description": "User provided Cookie" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_game_aweme": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_game_aweme", "summary": "Game Video", "description": "Game Video", "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "integer", "description": "Number per page", "title": "Count" }, "description": "Number per page", "example": 16 }, { "name": "refresh_index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Paging index", "default": 1, "title": "Refresh Index" }, "description": "Paging index" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User provided Cookie", "title": "Cookie" }, "description": "User provided Cookie" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_hashtag_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_hashtag_detail", "summary": "Get details of specified hashtag", "description": "Get details of specified hashtag", "parameters": [ { "name": "ch_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Hashtag id", "title": "Ch Id" }, "description": "Hashtag id", "example": 1575791821492238 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_hashtag_video_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_hashtag_video_list", "summary": "Get video list of specified hashtag", "description": "Get video list of specified hashtag", "parameters": [ { "name": "ch_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Hashtag id", "title": "Ch Id" }, "description": "Hashtag id", "example": "1575791821492238" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type", "default": 0, "title": "Sort Type" }, "description": "Sort type" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 10, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_home_feed": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_fetch_home_feed", "summary": "Get home feed data", "description": "Get home feed data", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_home_feed_api_v1_douyin_web_fetch_home_feed_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_hot_search_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_hot_search_list", "summary": "Get Douyin hot search list data", "description": "Get Douyin hot search list data", "parameters": [ { "name": "board_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Board type", "default": "0", "title": "Board Type" }, "description": "Board type" }, { "name": "board_sub_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Board sub type", "default": "", "title": "Board Sub Type" }, "description": "Board sub type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_hot_search_result": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_hot_search_result", "summary": "Get Douyin hot search results", "description": "Get Douyin hot search results", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_knowledge_aweme": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_knowledge_aweme", "summary": "Knowledge Video", "description": "Knowledge Video", "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "integer", "description": "Number per page", "title": "Count" }, "description": "Number per page", "example": 16 }, { "name": "refresh_index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Paging index", "default": 1, "title": "Refresh Index" }, "description": "Paging index" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User provided Cookie", "title": "Cookie" }, "description": "User provided Cookie" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_live_gift_ranking": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_live_gift_ranking", "summary": "Get live room gift user ranking", "description": "Get live room gift user ranking", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Room room_id", "title": "Room Id" }, "description": "Room room_id", "example": "7356585666190461731" }, { "name": "rank_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Leaderboard type", "default": 30, "title": "Rank Type" }, "description": "Leaderboard type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_live_hot_search_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_live_hot_search_list", "summary": "Get Douyin live hot search list data", "description": "Get Douyin live hot search list data", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_live_im_fetch": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_live_im_fetch", "summary": "Douyin live room danmaku parameters", "description": "Douyin live room danmaku parameters", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room id", "title": "Room Id" }, "description": "Live room id", "example": "7382517534467115826" }, { "name": "user_unique_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User unique ID", "title": "User Unique Id" }, "description": "User unique ID", "example": "7382524529011246630" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_multi_video": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_app_v3_fetch_multi_video", "summary": "Batch Get Video Information V1", "description": "Batch Get Video Information V1", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Aweme Ids" }, "example": [ "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/app/v3/fetch_multi_video_high_quality_play_url": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.3625, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_app_v3_fetch_multi_video_high_quality_play_url", "summary": "Batch get the highest quality play URL of videos", "description": "Batch get the highest quality play URL of videos", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchMultiVideoHighQualityPlayUrlRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_multi_video_statistics": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.03625, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_multi_video_statistics", "summary": "Get the statistical data of the Post according to the video ID (like count, download count, play count, share count)", "description": "Get the statistical data of the Post according to the video ID (like count, download count, play count, share count)", "parameters": [ { "name": "aweme_ids", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Ids" }, "description": "Video ID", "example": "7448118827402972455,7126745726494821640" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_music_aweme": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_music_aweme", "summary": "Music Video", "description": "Music Video", "parameters": [ { "name": "count", "in": "query", "required": true, "schema": { "type": "integer", "description": "Number per page", "title": "Count" }, "description": "Number per page", "example": 16 }, { "name": "refresh_index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Paging index", "default": 1, "title": "Refresh Index" }, "description": "Paging index" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User provided Cookie", "title": "Cookie" }, "description": "User provided Cookie" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_music_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_music_detail", "summary": "Get details of specified music", "description": "Get details of specified music", "parameters": [ { "name": "music_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Music id", "title": "Music Id" }, "description": "Music id", "example": "7136850194742315016" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_music_hot_search_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_music_hot_search_list", "summary": "Get Douyin music hot search list data", "description": "Get Douyin music hot search list data", "parameters": [ { "name": "chart_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Chart type", "default": "hot", "title": "Chart Type" }, "description": "Chart type", "example": "hot" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "default": "0", "title": "Cursor" }, "description": "Cursor", "example": "0" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_music_video_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_music_video_list", "summary": "Get video list of specified music", "description": "Get video list of specified music", "parameters": [ { "name": "music_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Music id", "title": "Music Id" }, "description": "Music id", "example": "7136850194742315016" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 10, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_one_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_one_video", "summary": "Get single video data", "description": "Get single video data", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Id" }, "description": "Video ID", "example": "7448118827402972455" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_one_video_by_share_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_one_video_by_share_url", "summary": "Get single video data by sharing link", "description": "Get single video data by sharing link", "parameters": [ { "name": "share_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Share link", "title": "Share Url" }, "description": "Share link", "example": "https://v.douyin.com/e3x2fjE/" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_one_video_danmaku": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_one_video_danmaku", "summary": "Get single video danmaku data", "description": "Get single video danmaku data", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Item Id" }, "description": "Video ID", "example": "7355433624046472498" }, { "name": "duration", "in": "query", "required": true, "schema": { "type": "integer", "description": "Video total duration", "title": "Duration" }, "description": "Video total duration", "example": 15134 }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "integer", "description": "End time", "title": "End Time" }, "description": "End time", "example": 15133 }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "integer", "description": "Start time", "title": "Start Time" }, "description": "Start time", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_query_user": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_fetch_query_user", "summary": "Query Douyin user basic information", "description": "Query Douyin user basic information", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "title": "Cookie", "description": "User ttwid Cookie, acquisition method: call `/api/v1/douyin/web/generate_ttwid` interface to get.", "default": "ttwid=1%7CNBG4pKnnBr32xpXszWA57PAooMT-02MTYJCyYl0fayI%7C1746172842%7Ce2aa988d355d220eb2fe8fb7e7bb22a51a46a933f969f768c5315fa73e372d5f;" }, "example": "ttwid=1%7CNBG4pKnnBr32xpXszWA57PAooMT-02MTYJCyYl0fayI%7C1746172842%7Ce2aa988d355d220eb2fe8fb7e7bb22a51a46a933f969f768c5315fa73e372d5f;" } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_related_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_related_posts", "summary": "Get related posts recommendation data", "description": "Get related posts recommendation data", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Id" }, "description": "Video ID", "example": "7393365489105358132" }, { "name": "refresh_index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Paging index", "default": 1, "title": "Refresh Index" }, "description": "Paging index" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_series_aweme": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_series_aweme", "summary": "Series Video", "description": "Series Video", "parameters": [ { "name": "offset", "in": "query", "required": true, "schema": { "type": "integer", "description": "Page number", "title": "Offset" }, "description": "Page number", "example": 0 }, { "name": "count", "in": "query", "required": true, "schema": { "type": "integer", "description": "Number per page", "title": "Count" }, "description": "Number per page", "example": 16 }, { "name": "content_type", "in": "query", "required": true, "schema": { "type": "integer", "description": "Subtype", "title": "Content Type" }, "description": "Subtype", "example": 0 }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User provided Cookie", "title": "Cookie" }, "description": "User provided Cookie" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_series_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_series_detail", "summary": "Get series detail", "description": "Get series detail", "parameters": [ { "name": "series_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Series id", "title": "Series Id" }, "description": "Series id", "example": "7592054624643713067" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_series_video_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_series_video_list", "summary": "Get series video list", "description": "Get series video list", "parameters": [ { "name": "series_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Series id", "title": "Series Id" }, "description": "Series id", "example": "7592054624643713067" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_share_info_by_share_code": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_share_info_by_share_code", "summary": "Get share info by share code", "description": "Get share info by share code", "parameters": [ { "name": "share_code", "in": "query", "required": true, "schema": { "type": "string", "description": "Share code", "title": "Share Code" }, "description": "Share code", "example": "8:/ h@O.kP 05/21 [In business, putting on a show saves communication costs] Long-press to copy, open Douyin to read the article ︽︽2QnCB9aIZZ29︽︽" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_user_collection_videos": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_fetch_user_collection_videos", "summary": "Get user collection video data", "description": "Get user collection video data", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_user_collection_videos_api_v1_douyin_web_fetch_user_collection_videos_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_user_collects": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_fetch_user_collects", "summary": "Get user collection", "description": "Get user collection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_user_collects_api_v1_douyin_web_fetch_user_collects_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_user_collects_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_collects_videos", "summary": "Get user collection data", "description": "Get user collection data", "parameters": [ { "name": "collects_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Collection id", "title": "Collects Id" }, "description": "Collection id", "example": "" }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum cursor", "default": 0, "title": "Max Cursor" }, "description": "Maximum cursor" }, { "name": "counts", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Counts" }, "description": "Number per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_user_fans_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_user_fans_list", "summary": "Get user fans list", "description": "Get user fans list", "parameters": [ { "name": "sec_user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User sec_user_id", "default": "MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70", "title": "Sec User Id" }, "description": "User sec_user_id" }, { "name": "max_time", "in": "query", "required": false, "schema": { "type": "string", "description": "Maximum timestamp", "default": "0", "title": "Max Time" }, "description": "Maximum timestamp" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_user_following_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_following_list", "summary": "Get user following list", "description": "Get user following list", "parameters": [ { "name": "sec_user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User sec_user_id", "default": "MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70", "title": "Sec User Id" }, "description": "User sec_user_id" }, { "name": "max_time", "in": "query", "required": false, "schema": { "type": "string", "description": "Maximum timestamp", "default": "0", "title": "Max Time" }, "description": "Maximum timestamp" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" }, { "name": "source_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Source type", "default": 1, "title": "Source Type" }, "description": "Source type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_user_like_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_user_like_videos", "summary": "Get user like video data", "description": "Get user like video data", "parameters": [ { "name": "sec_user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_user_id", "title": "Sec User Id" }, "description": "User sec_user_id", "example": "MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y" }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum cursor", "default": 0, "title": "Max Cursor" }, "description": "Maximum cursor" }, { "name": "counts", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Counts" }, "description": "Number per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_user_live_info_by_uid": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_live_info_by_uid", "summary": "Get user live information by UID", "description": "Get user live information by UID", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User UID", "title": "Uid" }, "description": "User UID", "example": "3081254195702747" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_user_live_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_live_videos", "summary": "Get user live video data", "description": "Get user live video data", "parameters": [ { "name": "webcast_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Room webcast_id", "title": "Webcast Id" }, "description": "Room webcast_id", "example": "376034101029" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_user_live_videos_by_room_id_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_live_videos_by_room_id_v2", "summary": "Gets the live stream data of the specified user by room_id V2", "description": "Gets the live stream data of the specified user by room_id V2", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Room room_id", "title": "Room Id" }, "description": "Room room_id", "example": "7462723839303093032" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_user_live_videos_by_sec_uid": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_live_videos_by_sec_uid", "summary": "Get live video data of specified user by sec_uid", "description": "Get live video data of specified user by sec_uid", "parameters": [ { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_uid", "title": "Sec Uid" }, "description": "User sec_uid", "example": "MS4wLjABAAAAAIKOBr_x6p2fPVKOAhqG8LrC1lwwdWChifKEsl-TXFS-kGSGqpMBRexJdzoAfvUF" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_user_mix_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_mix_videos", "summary": "Get user mix video data", "description": "Get user mix video data", "parameters": [ { "name": "mix_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Mix id", "title": "Mix Id" }, "description": "Mix id", "example": "7348687990509553679" }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum cursor", "default": 0, "title": "Max Cursor" }, "description": "Maximum cursor" }, { "name": "counts", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Counts" }, "description": "Number per page" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/app/v3/fetch_user_post_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_user_post_videos", "summary": "Get user homepage video data", "description": "Get user homepage video data", "parameters": [ { "name": "sec_user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_user_id", "title": "Sec User Id" }, "description": "User sec_user_id", "example": "MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE" }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum cursor", "default": 0, "title": "Max Cursor" }, "description": "Maximum cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type", "default": 0, "title": "Sort Type" }, "description": "Sort type" }, { "name": "channel", "in": "query", "required": false, "schema": { "type": "string", "description": "Douyin channel: normal (standard version, default), lite (speed version)", "default": "normal", "title": "Channel" }, "description": "Douyin channel: normal (standard version, default), lite (speed version)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_user_profile_by_short_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_profile_by_short_id", "summary": "Get user information by Short ID", "description": "Get user information by Short ID", "parameters": [ { "name": "short_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User Short ID", "title": "Short Id" }, "description": "User Short ID", "example": "114131058" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_user_profile_by_uid": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_profile_by_uid", "summary": "Get user information by UID", "description": "Get user information by UID", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User UID", "title": "Uid" }, "description": "User UID", "example": "68141954464" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_user_series_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_user_series_list", "summary": "Get user series list", "description": "Get user series list", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User id", "default": "", "title": "User Id" }, "description": "User id", "example": "3010877781453635" }, { "name": "sec_user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User sec id", "default": "", "title": "Sec User Id" }, "description": "User sec id", "example": "MS4wLjABAAAAfAU5kMk-W4569G1z2iRsy8t6-kOxO17Eaz6yte4NQokeUeOpeqTGEc480e34O8lK" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/fetch_video_channel_result": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_video_channel_result", "summary": "Douyin video channel data", "description": "Douyin video channel data", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Tag id", "title": "Tag Id" }, "description": "Tag id", "example": 300203 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 10, "title": "Count" }, "description": "Number" }, { "name": "refresh_index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Refresh index", "default": 1, "title": "Refresh Index" }, "description": "Refresh index" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_video_comment_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_video_comment_replies", "summary": "Get comment replies data of specified video", "description": "Get comment replies data of specified video", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Item Id" }, "description": "Video ID", "example": "7354666303006723354" }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Comment id", "title": "Comment Id" }, "description": "Comment id", "example": "7354669356632638218" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_video_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_video_comments", "summary": "Get single video comments data", "description": "Get single video comments data", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Id" }, "description": "Video ID", "example": "7448118827402972455" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_video_high_quality_play_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_video_high_quality_play_url", "summary": "Get the highest quality play URL of the video", "description": "Get the highest quality play URL of the video", "parameters": [ { "name": "aweme_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Id" }, "description": "Video ID", "example": "7512756548356492544" }, { "name": "share_url", "in": "query", "required": false, "schema": { "type": "string", "description": "Optional, share link", "title": "Share Url" }, "description": "Optional, share link", "example": "https://www.douyin.com/video/7512756548356492544" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Optional, ISO country code (e.g. CN/US/HK). Pass CN to get China-region CDN URLs for faster download in mainland China.", "title": "Region" }, "description": "Optional, ISO country code (e.g. CN/US/HK). Pass CN to get China-region CDN URLs for faster download in mainland China.", "example": "CN" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_video_mix_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_video_mix_detail", "summary": "Get Douyin video mix detail data", "description": "Get Douyin video mix detail data", "parameters": [ { "name": "mix_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Mix id", "title": "Mix Id" }, "description": "Mix id", "example": "7302011174286002217" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_video_mix_post_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_video_mix_post_list", "summary": "Get Douyin video mix post list data", "description": "Get Douyin video mix post list data", "parameters": [ { "name": "mix_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Mix id", "title": "Mix Id" }, "description": "Mix id", "example": "7302011174286002217" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/fetch_video_statistics": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_fetch_video_statistics", "summary": "Get the statistical data of the Post according to the video ID (like count, download count, play count, share count)", "description": "Get the statistical data of the Post according to the video ID (like count, download count, play count, share count)", "parameters": [ { "name": "aweme_ids", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Ids" }, "description": "Video ID", "example": "7448118827402972455,7126745726494821640" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/generate_douyin_short_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_generate_douyin_short_url", "summary": "Generate Douyin short link", "description": "Generate Douyin short link", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin link", "title": "Url" }, "description": "Douyin link", "example": "https://www.douyin.com/passport/web/logout/" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/generate_douyin_video_share_qrcode": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_generate_douyin_video_share_qrcode", "summary": "Generate Douyin video share QR code", "description": "Generate Douyin video share QR code", "parameters": [ { "name": "object_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Object Id" }, "description": "Video ID", "example": "7348044435755846962" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/generate_ttwid": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_generate_ttwid", "summary": "Generate ttwid", "description": "Generate ttwid", "parameters": [ { "name": "user_agent", "in": "query", "required": false, "schema": { "type": "string", "default": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:125.0) Gecko/20100101 Firefox/125.0", "title": "User Agent" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/generate_wss_xb_signature": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_generate_wss_xb_signature", "summary": "Generate barrage xb signature", "description": "Generate barrage xb signature", "parameters": [ { "name": "user_agent", "in": "query", "required": true, "schema": { "type": "string", "description": "User browser agent", "title": "User Agent" }, "description": "User browser agent", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36 Edg/130.0.0.0" }, { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Room ID", "title": "Room Id" }, "description": "Room ID", "example": "7382517534467115826" }, { "name": "user_unique_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User unique ID", "title": "User Unique Id" }, "description": "User unique ID", "example": "7382524529011246630" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/get_all_aweme_id": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_get_all_aweme_id", "summary": "Extract list video id", "description": "Extract list video id", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Url", "description": "Video link list" }, "example": [ "0.53 02/26 I@v.sE Fus:/ You are way too handsome, Zheng Runze # live # music festival # Zheng Runze https://v.douyin.com/iRNBho6u/ Copy this link, open Douyin search, and watch the video directly!", "https://v.douyin.com/iRNBho6u/", "https://www.iesdouyin.com/share/video/7298145681699622182/?region=CN&mid=7298145762238565171&u_code=l1j9bkbd&did=MS4wLjABAAAAtqpCx0hpOERbdSzQdjRZw-wFPxaqdbAzsKDmbJMUI3KWlMGQHC-n6dXAqa-dM2EP&iid=MS4wLjABAAAANwkJuWIRFOzg5uCpDRpMj4OX-QryoDgn-yYlXQnRwQQ&with_sec_did=1&titleType=title&share_sign=05kGlqGmR4_IwCX.ZGk6xuL0osNA..5ur7b0jbOx6cc-&share_version=170400&ts=1699262937&from_aid=6383&from_ssr=1&from=web_code_link", "https://www.douyin.com/video/7298145681699622182?previous_page=web_code_link", "https://www.douyin.com/video/7298145681699622182" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/get_all_sec_user_id": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_get_all_sec_user_id", "summary": "Extract list user id", "description": "Extract list user id", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Url", "description": "User homepage link list" }, "example": [ "https://www.douyin.com/user/MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE?vid=7285950278132616463", "https://www.douyin.com/user/MS4wLjABAAAAVsneOf144eGDFf8Xp9QNb1VW6ovXnNT5SqJBhJfe8KQBKWKDTWK5Hh-_i9mJzb8C", "Long press to copy this message, open Douyin and search to see more of their work. https://v.douyin.com/idFqvUms/", "https://v.douyin.com/idFqvUms/" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/get_all_webcast_id": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_get_all_webcast_id", "summary": "Extract list webcast id", "description": "Extract list webcast id", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Url", "description": "Room link list" }, "example": [ "https://live.douyin.com/775841227732", "https://live.douyin.com/775841227732?room_id=7318296342189919011&enter_from_merge=web_share_link&enter_method=web_share_link&previous_page=app_code_link", "https://webcast.amemv.com/douyin/webcast/reflow/7318296342189919011?u_code=l1j9bkbd&did=MS4wLjABAAAAEs86TBQPNwAo-RGrcxWyCdwKhI66AK3Pqf3ieo6HaxI&iid=MS4wLjABAAAA0ptpM-zzoliLEeyvWOCUt-_dQza4uSjlIvbtIazXnCY&with_sec_did=1&use_link_command=1&ecom_share_track_params=&extra_params={\"from_request_id\":\"20231230162057EC005772A8EAA0199906\",\"im_channel_invite_id\":\"0\"}&user_id=3644207898042206&liveId=7318296342189919011&from=share&style=share&enter_method=click_share&roomId=7318296342189919011&activity_info={}", "6i- Q@x.Sl 03/23 [Xingzi8ke's Live Room] Click to open 👉https://v.douyin.com/i8tBR7hX/ or long-press to copy this message, open Douyin, and watch the live stream", "https://v.douyin.com/i8tBR7hX/" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/get_aweme_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_get_aweme_id", "summary": "Extract single video id", "description": "Extract single video id", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" }, "example": "https://www.douyin.com/video/7298145681699622182" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/get_sec_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_get_sec_user_id", "summary": "Extract single user id", "description": "Extract single user id", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" }, "example": "https://www.douyin.com/user/MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/get_webcast_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_get_webcast_id", "summary": "Extract webcast id", "description": "Extract webcast id", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" }, "example": "https://live.douyin.com/775841227732" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/handler_shorten_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_handler_shorten_url", "summary": "Handler Shorten Url", "description": "Handler Shorten Url", "parameters": [ { "name": "target_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Target URL to be converted", "title": "Target Url" }, "description": "Target URL to be converted", "example": "https://www.douyin.com/video/7575136499386720761" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/handler_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_handler_user_profile", "summary": "Get information of specified user", "description": "Get information of specified user", "parameters": [ { "name": "sec_user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_user_id", "title": "Sec User Id" }, "description": "User sec_user_id", "example": "MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/open_douyin_app_to_keyword_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_open_douyin_app_to_keyword_search", "summary": "Generate Douyin share link, call Douyin APP, and jump to the specified keyword search result", "description": "Generate Douyin share link, call Douyin APP, and jump to the specified keyword search result", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Lei Jun" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/open_douyin_app_to_send_private_message": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_open_douyin_app_to_send_private_message", "summary": "Generate Douyin share link, call Douyin APP, and send private messages to specified users", "description": "Generate Douyin share link, call Douyin APP, and send private messages to specified users", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "Uid" }, "description": "User id", "example": "96874812426" }, { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_uid", "title": "Sec Uid" }, "description": "User sec_uid", "example": "MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/open_douyin_app_to_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_open_douyin_app_to_user_profile", "summary": "Generate Douyin share link, call Douyin APP, and jump to the specified user profile", "description": "Generate Douyin share link, call Douyin APP, and jump to the specified user profile", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "Uid" }, "description": "User id", "example": "96874812426" }, { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_uid", "title": "Sec Uid" }, "description": "User sec_uid", "example": "MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/open_douyin_app_to_video_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_open_douyin_app_to_video_detail", "summary": "Generate Douyin share link, call Douyin APP, and jump to the specified video details page", "description": "Generate Douyin share link, call Douyin APP, and jump to the specified video details page", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Id" }, "description": "Video ID", "example": "7348044435755846962" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/app/v3/register_device": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_app_v3_register_device", "summary": "Douyin APP register device", "description": "Douyin APP register device", "parameters": [ { "name": "proxy", "in": "query", "required": false, "schema": { "type": "string", "description": "Proxy", "default": "", "title": "Proxy" }, "description": "Proxy" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/web/webcast_id_2_room_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_webcast_id_2_room_id", "summary": "Webcast id to room id", "description": "Webcast id to room id", "parameters": [ { "name": "webcast_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Webcast id", "title": "Webcast Id" }, "description": "Webcast id", "example": "775841227732" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_challenge_search_v2": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_challenge_search_v2", "summary": "Fetch hashtag search V2", "description": "Fetch hashtag search V2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChallengeSearchV2Request" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_challenge_suggest": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_challenge_suggest", "summary": "Fetch hashtag suggestions", "description": "Fetch hashtag suggestions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChallengeSuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_discuss_search": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_discuss_search", "summary": "Fetch discussion search", "description": "Fetch discussion search", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscussSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_experience_search": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_experience_search", "summary": "Fetch experience search", "description": "Fetch experience search", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_general_search_v3": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_general_search_v3", "summary": "Fetch general search V3", "description": "Fetch general search V3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralSearchV3Request" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_image_search_v3": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_image_search_v3", "summary": "Fetch image-text search V3", "description": "Fetch image-text search V3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageSearchV3Request" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/search/fetch_live_search_v2": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_live_search_v2", "summary": "Fetch live search V2", "description": "Fetch live search V2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSearchV2Request" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_multi_search": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_multi_search", "summary": "Fetch multi-type search", "description": "Fetch multi-type search", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_music_search": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_music_search", "summary": "Fetch music search", "description": "Fetch music search", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MusicSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_school_search": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_school_search", "summary": "Fetch school search", "description": "Fetch school search", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchoolSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_search_suggest": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_search_suggest", "summary": "Fetch search keyword suggestions", "description": "Fetch search keyword suggestions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchSuggestRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_user_search_v2": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_user_search_v2", "summary": "Fetch user search V2", "description": "Fetch user search V2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSearchRequestV2" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/search/fetch_video_search_v5": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_search_fetch_video_search_v5", "summary": "Fetch video search V5", "description": "Fetch video search V5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoSearchV5Request" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_brand_top_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_brand_top_list", "summary": "Kuaishou brand top list", "description": "Kuaishou brand top list", "parameters": [ { "name": "subTabId", "in": "query", "required": false, "schema": { "type": "integer", "title": "Sub tag ID", "default": 0 } }, { "name": "subTabName", "in": "query", "required": false, "schema": { "type": "string", "title": "Sub tag name", "default": "" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/web/fetch_get_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_fetch_get_user_id", "summary": "Fetch user ID", "description": "Fetch user ID", "parameters": [ { "name": "share_link", "in": "query", "required": true, "schema": { "type": "string", "title": "User Share Link" }, "example": "https://v.kuaishou.com/KcdKDwFp" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/kuaishou/app/fetch_hot_board_categories": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_hot_board_categories", "summary": "Kuaishou hot categories", "description": "Kuaishou hot categories", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_hot_board_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_hot_board_detail", "summary": "Kuaishou hot board detail", "description": "Kuaishou hot board detail", "parameters": [ { "name": "boardType", "in": "query", "required": false, "schema": { "type": "integer", "title": "Board type", "default": 1 } }, { "name": "boardId", "in": "query", "required": false, "schema": { "type": "integer", "title": "Board ID", "default": "1" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_hot_search_person": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_hot_search_person", "summary": "Kuaishou hot search person board", "description": "Kuaishou hot search person board", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/web/fetch_kuaishou_hot_list_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_fetch_kuaishou_hot_list_v2", "summary": "Fetch Kuaishou Hot List V2", "description": "Fetch Kuaishou Hot List V2", "parameters": [ { "name": "board_type", "in": "query", "required": false, "schema": { "type": "string", "title": "Board Type (board_type)", "default": "1" }, "example": "1" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_live_top_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_live_top_list", "summary": "Kuaishou live top list", "description": "Kuaishou live top list", "parameters": [ { "name": "subTabId", "in": "query", "required": false, "schema": { "type": "integer", "title": "Sub tag ID", "default": 0 } }, { "name": "subTabName", "in": "query", "required": false, "schema": { "type": "string", "title": "Sub tag name", "default": "" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_music_ranking": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_music_ranking", "summary": "Music ranking", "description": "Music ranking", "parameters": [ { "name": "tab_id", "in": "query", "required": false, "schema": { "type": "integer", "title": "Tab ID", "description": "100002=Hot Songs Chart (default), 100063=Pi Plan Recommended Chart", "default": 100002 }, "description": "100002=Hot Songs Chart (default), 100063=Pi Plan Recommended Chart" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "title": "Page size", "description": "Default 20, range 1-50", "default": 20 }, "description": "Default 20, range 1-50" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor", "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages", "default": "" }, "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_one_user_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_one_user_v2", "summary": "Get single user data V2", "description": "Get single user data V2", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User ID" }, "example": "3xz63mn6fngqtiq" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_one_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_one_video", "summary": "Video detailsV1", "description": "Video detailsV1", "parameters": [ { "name": "photo_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo ID" }, "example": "3xhpk3xcf6e4iac" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_one_video_by_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_one_video_by_url", "summary": "Fetch single video by URL", "description": "Fetch single video by URL", "parameters": [ { "name": "share_text", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo URL" }, "example": "https://v.kuaishou.com/cNYP0Z" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/web/fetch_one_video_comment": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_fetch_one_video_comment", "summary": "Fetch video comments", "description": "Fetch video comments", "parameters": [ { "name": "photo_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo ID" }, "example": "3x7gxp2zhgjv832" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Comment cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/web/fetch_one_video_sub_comment": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_fetch_one_video_sub_comment", "summary": "Fetch video sub comments", "description": "Fetch video sub comments", "parameters": [ { "name": "photo_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo ID" }, "example": "3xgarycnydawq3g" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Comment cursor", "default": "" }, "example": "909377053156" }, { "name": "root_comment_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Root comment ID" }, "example": "908850553827" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_selection_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_selection_feed", "summary": "Selection feed", "description": "Selection feed", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_shopping_top_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_shopping_top_list", "summary": "Kuaishou shopping top list", "description": "Kuaishou shopping top list", "parameters": [ { "name": "subTabId", "in": "query", "required": false, "schema": { "type": "integer", "title": "Sub tag ID", "default": 0 } }, { "name": "subTabName", "in": "query", "required": false, "schema": { "type": "string", "title": "Sub tag name", "default": "" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_tag_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_tag_feed", "summary": "Tag feed", "description": "Tag feed", "parameters": [ { "name": "general_tag_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Tag ID", "description": "Hashtag: pass the tag name or the numeric id from search_tag; audio tag: pass the encoded string" }, "description": "Hashtag: pass the tag name or the numeric id from search_tag; audio tag: pass the encoded string", "example": "Pure Sweet Girl" }, { "name": "tab", "in": "query", "required": false, "schema": { "enum": [ "hot", "latest", "image", "live" ], "type": "string", "title": "Sub tab", "description": "hot (most popular) / latest (most recently published) / image (image posts) / live (live streams)", "default": "hot" }, "description": "hot (most popular) / latest (most recently published) / image (image posts) / live (live streams)" }, { "name": "tag_name", "in": "query", "required": false, "schema": { "type": "string", "title": "Tag name", "description": "Topic tag recommended, equal to the tag name" }, "description": "Topic tag recommended, equal to the tag name" }, { "name": "tag_type", "in": "query", "required": false, "schema": { "type": "integer", "title": "Tag type", "description": "1=topic hashtag, 29=sound/music tag", "default": 1 }, "description": "1=topic hashtag, 29=sound/music tag" }, { "name": "tag_source", "in": "query", "required": false, "schema": { "type": "integer", "title": "Tag source", "description": "2=entered topic page via search, 3=sound tag on post page", "default": 2 }, "description": "2=entered topic page via search, 3=sound tag on post page" }, { "name": "from_photo_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Source photo ID", "description": "Source photoId for entering the tag page (optional)" }, "description": "Source photoId for entering the tag page (optional)" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor", "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages", "default": "" }, "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/kuaishou/web/fetch_user_collect": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_fetch_user_collect", "summary": "Fetch user collect", "description": "Fetch user collect", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User ID (eid)" }, "example": "3xz63mn6fngqtiq" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Post cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_user_hot_post": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_user_hot_post", "summary": "Get user hot post data", "description": "Get user hot post data", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User ID" }, "example": "228905802" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Post cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/web/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_fetch_user_info", "summary": "Fetch user info", "description": "Fetch user info", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User ID (eid)" }, "example": "3xz63mn6fngqtiq" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_user_live_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_user_live_info", "summary": "Get user live info", "description": "Get user live info", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User ID" }, "example": "1377082950" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/web/fetch_user_live_replay": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_fetch_user_live_replay", "summary": "Fetch user live replay", "description": "Fetch user live replay", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User ID (eid)" }, "example": "3xz63mn6fngqtiq" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Post cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_user_post_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_user_post_v2", "summary": "User video list V2", "description": "User video list V2", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User ID" }, "example": "903511772" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Video cursor", "description": "Leave empty on the first request; pass the pcursor from the previous page response for subsequent requests", "default": "" }, "description": "Leave empty on the first request; pass the pcursor from the previous page response for subsequent requests" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "latest", "hot" ], "type": "string", "title": "Sort type", "description": "latest (most recent, default) / hot (trending)", "default": "latest" }, "description": "latest (most recent, default) / hot (trending)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_video_comment": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_video_comment", "summary": "Get single video comment data", "description": "Get single video comment data", "parameters": [ { "name": "photo_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo ID" }, "example": "3x7gxp2zhgjv832" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Comment cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_video_sub_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_video_sub_comments", "summary": "Video sub comments", "description": "Video sub comments", "parameters": [ { "name": "photo_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo ID" }, "example": "5218546261880462502" }, { "name": "root_comment_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Root comment ID" }, "example": "14000000123456789" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor", "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages", "default": "" }, "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "title": "Page size", "description": "Default 8, range 1-20", "default": 8 }, "description": "Default 8, range 1-20" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/fetch_videos_batch": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.058, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_fetch_videos_batch", "summary": "Kuaishou batch video query API", "description": "Kuaishou batch video query API", "parameters": [ { "name": "photo_ids", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo ID list (comma separated)", "description": "Multiple photo IDs separated by commas, max 40 per request" }, "description": "Multiple photo IDs separated by commas, max 40 per request", "example": "5228960823332207296,5196309727975443273,5222486898325987583" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/generate_kuaishou_share_link": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_generate_kuaishou_share_link", "summary": "Generate Kuaishou share link", "description": "Generate Kuaishou share link", "parameters": [ { "name": "shareObjectId", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo ID" }, "example": "3xg5wjqdtekbb3u" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/web/generate_share_short_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_generate_share_short_url", "summary": "Generate share short URL", "description": "Generate share short URL", "parameters": [ { "name": "photo_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo ID" }, "example": "3xtdqvdnqd3psuc" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/search_comprehensive": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_search_comprehensive", "summary": "Comprehensive search", "description": "Comprehensive search", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "title": "Search keyword" }, "example": "Autohome" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor" } }, { "name": "sort_type", "in": "query", "required": false, "schema": { "enum": [ "all", "newest", "most_likes" ], "type": "string", "title": "Sort type", "description": "Options: all (comprehensive sort), newest (latest published), most_likes (most liked)", "default": "all" }, "description": "Options: all (comprehensive sort), newest (latest published), most_likes (most liked)" }, { "name": "publish_time", "in": "query", "required": false, "schema": { "enum": [ "all", "one_day", "one_week", "one_month" ], "type": "string", "title": "Publish time", "description": "Options: all (all), one_day (last 1 day), one_week (last 1 week), one_month (last 1 month)", "default": "all" }, "description": "Options: all (all), one_day (last 1 day), one_week (last 1 week), one_month (last 1 month)" }, { "name": "duration", "in": "query", "required": false, "schema": { "enum": [ "all", "under_1_min", "1_to_5_min", "over_5_min" ], "type": "string", "title": "Duration", "description": "Options: all (all), under_1_min (under 1 minute), 1_to_5_min (1-5 minutes), over_5_min (over 5 minutes)", "default": "all" }, "description": "Options: all (all), under_1_min (under 1 minute), 1_to_5_min (1-5 minutes), over_5_min (over 5 minutes)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/search_image": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_search_image", "summary": "Search image", "description": "Search image", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "title": "Search keyword" }, "example": "Scenery" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor", "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages", "default": "" }, "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/search_live": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_search_live", "summary": "Search live", "description": "Search live", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "title": "Search keyword" }, "example": "Commerce / Product promotion" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor", "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages", "default": "" }, "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/search_music": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_search_music", "summary": "Search music", "description": "Search music", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "title": "Search keyword" }, "example": "Jay Chou" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor", "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages", "default": "" }, "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/search_tag": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_search_tag", "summary": "Search tag", "description": "Search tag", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "title": "Tag keyword" }, "example": "Challenge" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor", "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages", "default": "" }, "description": "Leave empty for the first page, pass pcursor from the previous response for subsequent pages" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/kuaishou/app/search_user_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_search_user_v2", "summary": "Search user V2", "description": "Search user V2", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "title": "Search keyword" }, "example": "Artificial Intelligence" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor", "description": "Empty for first page, pass pcursor from the previous response for subsequent pages", "default": "" }, "description": "Empty for first page, pass pcursor from the previous response for subsequent pages" }, { "name": "user_relation", "in": "query", "required": false, "schema": { "enum": [ "all", "same_city", "verified", "live", "following" ], "type": "string", "title": "Relation filter", "description": "all / same_city / verified / live / following", "default": "all" }, "description": "all / same_city / verified / live / following" }, { "name": "user_gender", "in": "query", "required": false, "schema": { "enum": [ "all", "male", "female" ], "type": "string", "title": "Gender filter", "description": "all / male / female", "default": "all" }, "description": "all / male / female" }, { "name": "fans_sort", "in": "query", "required": false, "schema": { "enum": [ "default", "most_to_least", "least_to_most" ], "type": "string", "title": "Fans sort", "description": "default / most_to_least / least_to_most", "default": "default" }, "description": "default / most_to_least / least_to_most" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/kuaishou/app/search_video_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_app_search_video_v2", "summary": "Search video V2", "description": "Search video V2", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "title": "Search keyword" }, "example": "Artificial Intelligence" }, { "name": "pcursor", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination cursor", "description": "Empty for first page, pass pcursor from previous response", "default": "" }, "description": "Empty for first page, pass pcursor from previous response" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/TTencrypt_algorithm": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_app_v3_TTencrypt_algorithm", "summary": "TikTok APP encryption algorithm", "description": "TikTok APP encryption algorithm", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTok_APP_Encrypt_Request" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/app/v3/check_live_room_online": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_check_live_room_online", "summary": "Check if live room is online", "description": "Check if live room is online", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room id", "title": "Room Id" }, "description": "Live room id", "example": "7358603858249009962" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/check_live_room_online_batch": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_app_v3_check_live_room_online_batch", "summary": "Batch check if live rooms are online", "description": "Batch check if live rooms are online", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveRoomBatchCheckRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/decrypt_strData": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_decrypt_strData", "summary": "Decrypt strData", "description": "Decrypt strData", "parameters": [ { "name": "encrypted_data", "in": "query", "required": true, "schema": { "type": "string", "description": "Encrypted strData string", "title": "Encrypted Data" }, "description": "Encrypted strData string", "example": "3BvqYbNXLLOcZehvxZVbjpAu7vq82RoWmFSJHLFwzDwJIZevE0AeilQfP55LridxmdGGjknoksqIsLqlMHMif0IFK/Br7JWqxOHnYuMwVCnttFc0Y4MFvdVWM5FECiEulJC0Dc+eeVsNSrFnAc9K7fazqdglyJgGLSfXIJmgyCvvQ4pg0u5HBVVugLSWs242X42fjoWymaUCLZJQo6vi6WLyuV7l5IC3Mg+lelr5xBQD6Q7hBIFEw8zzxJ1n2DyA4xLbOHTQdKvEtsK7XzyWwjpRnojPTbBl69Zosnuru+lOBIl+tFu/+hCQ1m0jYZwTP4rVE75L3Du6+KZ5v/9TyFYjq7y3y9bGLP4d7yQueJbF90G1yrZ6htElrZ2vqZKDrIqBVbmOZr/nph12k2JKrITtN0R/pMsp0sJ4gesQnXxcD/pLOFAINHk7umgbe6LzJ7+TLUdGuO4M7xiEg/jCqhjgJX1izZ4NPoBDp35zRxj6Y6OrcstlTN/cv5sz663+Nco/mEwhGq2VwrL4gAIAPycndIsb48dPdtngmLqNDNN0ZyVRjgqVIDXXrxigXCkR9CH89Dlrrb7QQqWVgRXz9/k5ihEM43BR3sd3mMU/XgFLN1Aoxf6GzzdxP2QPBI75/ZoHoAmu54v8gTmA3ntCGlEF0zgaFGTdpkGdb+oZgyQM4pw1aAyxmFINXkpD3IKKoGev9kD9gTFnhiQMGCMemhZS7ZYdbuGu0Cb+lQKaL/QTt80FMyGmW8kzVy9xW/ja9BcdEJYRoaufuFRkBFG5ay8x4WHLR6hEapXqQial/cREbLL4sQytpjtmnndFqvT7xN5DhgsLY2Z7451MJhD6NJXKNrMafGZSbItzQWY=" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/device_register": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_device_register", "summary": "Register device for TikTok Web", "description": "Register device for TikTok Web", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/encrypt_decrypt_login_request": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_app_v3_encrypt_decrypt_login_request", "summary": "Encrypt or Decrypt TikTok APP login request body", "description": "Encrypt or Decrypt TikTok APP login request body", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTok_APP_Login_Encrypt_Decrypt_Request" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/encrypt_strData": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_encrypt_strData", "summary": "Encrypt strData", "description": "Encrypt strData", "parameters": [ { "name": "data", "in": "query", "required": true, "schema": { "type": "string", "description": "Raw fingerprint data string (JSON format or dict string)", "title": "Data" }, "description": "Raw fingerprint data string (JSON format or dict string)", "example": "{\"behavior\":{\"beResize\":[],\"beMotion\":[{\"ts\":1701069187299,\"x\":null,\"y\":null,\"z\":null},{\"ts\":1701069202902,\"x\":null,\"y\":null,\"z\":null}],\"bePaste\":[],\"beMouse\":[],\"beKeyboard\":[],\"beScroll\":[],\"beTouch\":[],\"beWheel\":[],\"windowState\":[{\"ts\":1701069186257,\"v\":1},{\"ts\":1701069186257,\"v\":1},{\"ts\":1701069186388,\"v\":2},{\"ts\":1701069186388,\"v\":2},{\"ts\":1701069186402,\"v\":1},{\"ts\":1701069186402,\"v\":1},{\"ts\":1701069200309,\"v\":2},{\"ts\":1701069200309,\"v\":2},{\"ts\":1701069201865,\"v\":1},{\"ts\":1701069201865,\"v\":1}],\"isTrusted\":1},\"wID\":{\"sdkVersion\":\"4.4.6\",\"scmVersion\":\"1.0.0.96\",\"msgType\":2,\"timestamp\":\"1701069221819\",\"aid\":368462,\"aidList\":[1988,368462],\"privacyMode\":516},\"custom\":{},\"window\":{\"location\":\"https://www.tiktok.com/@funnykittensttk/video/7293517029737352454?is_from_webapp=1&web_id=7260049563725497899\"},\"msgMeta\":{\"msgType\":2,\"msgSrcProp\":2,\"msgProtocol\":1,\"aid\":368462,\"aidList\":[1988,368462]}}" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_batch_check_live_alive": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_batch_check_live_alive", "summary": "Batch live room start status check", "description": "Batch live room start status check", "parameters": [ { "name": "room_ids", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room ID list separated by commas, up to 50 IDs", "title": "Room Ids" }, "description": "Live room ID list separated by commas, up to 50 IDs", "example": "7530611486784277278,7530633767468288782,7530636465034775310,7530604930088848142" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_check_live_alive": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_check_live_alive", "summary": "Live room start status check", "description": "Live room start status check", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room ID", "title": "Room Id" }, "description": "Live room ID", "example": "7381444193462078214" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_content_translate": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_app_v3_fetch_content_translate", "summary": "Get content translation data", "description": "Get content translation data", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTok_APP_V3_Content_Translate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_creator_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_creator_info", "summary": "Get shopping creator information", "description": "Get shopping creator information", "parameters": [ { "name": "creator_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator uid", "title": "Creator Uid" }, "description": "Creator uid", "example": "6555451606845243393" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/app/v3/fetch_creator_search_insights": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_creator_search_insights", "summary": "Creator Search Insights", "description": "Creator Search Insights", "parameters": [ { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Pagination offset", "default": 0, "title": "Offset" }, "description": "Pagination offset", "example": 0 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Limit" }, "description": "Number per page", "example": 20 }, { "name": "tab", "in": "query", "required": false, "schema": { "type": "string", "description": "Tab type (all/content_gap/follower_searched/life_style/topics/challenges/sounds/hashtags)", "default": "all", "title": "Tab" }, "description": "Tab type (all/content_gap/follower_searched/life_style/topics/challenges/sounds/hashtags)", "example": "all" }, { "name": "language_filters", "in": "query", "required": false, "schema": { "type": "string", "description": "Language filters (id/de/en/es/fr/pt/vi/tr/ar/th/ja/ko)", "default": "en", "title": "Language Filters" }, "description": "Language filters (id/de/en/es/fr/pt/vi/tr/ar/th/ja/ko)", "example": "en" }, { "name": "category_filters", "in": "query", "required": false, "schema": { "type": "string", "description": "Category filters (Gaming/Fashion/Tourism/Science/Food/Sports), comma separated", "default": "", "title": "Category Filters" }, "description": "Category filters (Gaming/Fashion/Tourism/Science/Food/Sports), comma separated", "example": "" }, { "name": "creator_source", "in": "query", "required": false, "schema": { "type": "string", "description": "Creator source", "default": "general_search", "title": "Creator Source" }, "description": "Creator source", "example": "general_search" }, { "name": "force_refresh", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Force refresh", "default": false, "title": "Force Refresh" }, "description": "Force refresh", "example": false } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_creator_search_insights_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_creator_search_insights_detail", "summary": "Creator Search Insights Detail", "description": "Creator Search Insights Detail", "parameters": [ { "name": "query_id_str", "in": "query", "required": true, "schema": { "type": "string", "description": "Query ID from fetch_creator_search_insights", "title": "Query Id Str" }, "description": "Query ID from fetch_creator_search_insights", "example": "122991006" }, { "name": "time_range", "in": "query", "required": false, "schema": { "type": "string", "description": "Time range: past_7_days/past_30_days/past_60_days/past_6_months/custom", "default": "past_30_days", "title": "Time Range" }, "description": "Time range: past_7_days/past_30_days/past_60_days/past_6_months/custom", "example": "past_30_days" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "integer", "description": "Start timestamp (seconds), only effective when time_range=custom", "title": "Start Date" }, "description": "Start timestamp (seconds), only effective when time_range=custom" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "integer", "description": "End timestamp (seconds), only for custom range", "title": "End Date" }, "description": "End timestamp (seconds), only for custom range" }, { "name": "dimension_list", "in": "query", "required": false, "schema": { "type": "string", "description": "Dimension list (gender/age/country)", "default": "gender,age,country", "title": "Dimension List" }, "description": "Dimension list (gender/age/country)", "example": "gender,age,country" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_creator_search_insights_trend": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_creator_search_insights_trend", "summary": "Creator Search Insights Trend", "description": "Creator Search Insights Trend", "parameters": [ { "name": "query_id_str", "in": "query", "required": true, "schema": { "type": "string", "description": "Query ID from fetch_creator_search_insights", "title": "Query Id Str" }, "description": "Query ID from fetch_creator_search_insights", "example": "7555720035176562699" }, { "name": "from_tab_path", "in": "query", "required": false, "schema": { "type": "string", "description": "From tab path", "default": "TRENDING,TOPICS", "title": "From Tab Path" }, "description": "From tab path", "example": "TRENDING,TOPICS" }, { "name": "query_analysis_required", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether query analysis is required", "default": true, "title": "Query Analysis Required" }, "description": "Whether query analysis is required", "example": true } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_creator_search_insights_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_creator_search_insights_videos", "summary": "Creator Search Insights Videos", "description": "Creator Search Insights Videos", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "headshots 2 2 3" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Pagination offset", "default": 0, "title": "Offset" }, "description": "Pagination offset", "example": 0 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page", "example": 20 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_explore_post": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_explore_post", "summary": "Get explore video data", "description": "Get explore video data", "parameters": [ { "name": "categoryType", "in": "query", "required": false, "schema": { "type": "string", "description": "Video category", "default": "120", "title": "Categorytype" }, "description": "Video category" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 16, "title": "Count" }, "description": "Number per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_general_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_general_search", "summary": "Get general search list", "description": "Get general search list", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "TikTok" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Offset" }, "description": "Page cursor" }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search id, need to provide when paging", "default": "", "title": "Search Id" }, "description": "Search id, need to provide when paging" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User cookie (if needed)", "title": "Cookie" }, "description": "User cookie (if needed)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_general_search_result": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_general_search_result", "summary": "Get comprehensive search results of specified keywords", "description": "Get comprehensive search results of specified keywords", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Zhonghua Niang" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset", "example": 0 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number", "example": 20 }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type", "default": 0, "title": "Sort Type" }, "description": "Sort type", "example": 0 }, { "name": "publish_time", "in": "query", "required": false, "schema": { "type": "integer", "description": "Publish time", "default": 0, "title": "Publish Time" }, "description": "Publish time", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_gift_name_by_id": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_fetch_gift_name_by_id", "summary": "Get gift name by gift ID", "description": "Get gift name by gift ID", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GiftQuery", "description": "Gift query parameters" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_gift_names_by_ids": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.03625, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_fetch_gift_names_by_ids", "summary": "call, suggest 50)", "description": "call, suggest 50)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGiftQuery", "description": "Batch gift query parameters. Recommend 50 IDs per request for best value ($0.025/call)" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_hashtag_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_hashtag_detail", "summary": "Get details of specified hashtag", "description": "Get details of specified hashtag", "parameters": [ { "name": "ch_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Hashtag id", "title": "Ch Id" }, "description": "Hashtag id", "example": "7551" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region (US, GB, FR, JP, VN, SG)", "default": "US", "title": "Region" }, "description": "Region (US, GB, FR, JP, VN, SG)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_hashtag_search_result": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_hashtag_search_result", "summary": "Get hashtag search results of specified keywords", "description": "Get hashtag search results of specified keywords", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Cat" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_hashtag_video_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_hashtag_video_list", "summary": "Get video list of specified hashtag", "description": "Get video list of specified hashtag", "parameters": [ { "name": "ch_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Hashtag id", "title": "Ch Id" }, "description": "Hashtag id", "example": "7551" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 10, "title": "Count" }, "description": "Number" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region (US, GB, FR, JP, VN, SG)", "default": "US", "title": "Region" }, "description": "Region (US, GB, FR, JP, VN, SG)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_home_feed": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_app_v3_fetch_home_feed", "summary": "Get home feed(recommend) video data", "description": "Get home feed(recommend) video data", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TikTok_APP_V3_Home_Feed" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/app/v3/fetch_live_daily_rank": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_live_daily_rank", "summary": "Get live daily rank data", "description": "Get live daily rank data", "parameters": [ { "name": "anchor_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Anchor ID", "default": "6952422426752205830", "title": "Anchor Id" }, "description": "Anchor ID" }, { "name": "room_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Live room id", "default": "7380221319910312750", "title": "Room Id" }, "description": "Live room id" }, { "name": "rank_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Rank type", "default": 8, "title": "Rank Type" }, "description": "Rank type" }, { "name": "region_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Region type", "default": 1, "title": "Region Type" }, "description": "Region type" }, { "name": "gap_interval", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time interval", "default": 0, "title": "Gap Interval" }, "description": "Time interval" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User's own cookie", "default": "", "title": "Cookie" }, "description": "User's own cookie" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_live_gift_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.03625, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_live_gift_list", "summary": "Get live room gift list", "description": "Get live room gift list", "parameters": [ { "name": "room_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Live room ID, optional parameter", "default": "", "title": "Room Id" }, "description": "Live room ID, optional parameter", "example": "7381444193462078214" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_live_im_fetch": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_live_im_fetch", "summary": "tiktok live room danmaku parameters", "description": "tiktok live room danmaku parameters", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room id", "title": "Room Id" }, "description": "Live room id", "example": "7382517534467115826" }, { "name": "user_unique_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User unique ID", "title": "User Unique Id" }, "description": "User unique ID", "example": "7382524529011246630" }, { "name": "resp_content_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Response format: protobuf or json", "default": "protobuf", "title": "Resp Content Type" }, "description": "Response format: protobuf or json", "example": "protobuf" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_live_ranking_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_live_ranking_list", "summary": "Get live room ranking list", "description": "Get live room ranking list", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room id", "title": "Room Id" }, "description": "Live room id", "example": "7358603858249009962" }, { "name": "anchor_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Anchor ID", "title": "Anchor Id" }, "description": "Anchor ID", "example": "7222941468722758702" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_live_recommend": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_live_recommend", "summary": "Get live room homepage recommendation list", "description": "Get live room homepage recommendation list", "parameters": [ { "name": "related_live_tag", "in": "query", "required": true, "schema": { "type": "string", "description": "Related live tag, call `/fetch_live_recommend_tabs` to get the available values", "title": "Related Live Tag" }, "description": "Related live tag, call `/fetch_live_recommend_tabs` to get the available values", "example": "VALORANT" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_live_recommend_tabs": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_live_recommend_tabs", "summary": "Get available tags for live room homepage recommendation", "description": "Get available tags for live room homepage recommendation", "parameters": [ { "name": "logid", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for the first page; pass the `logid` from the previous response to load more", "default": "", "title": "Logid" }, "description": "Pagination cursor, leave empty for the first page; pass the `logid` from the previous response to load more", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_live_room_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_live_room_info", "summary": "Get data of specified live room", "description": "Get data of specified live room", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room id", "title": "Room Id" }, "description": "Live room id", "example": "7358603858249009962" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_live_room_product_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_live_room_product_list", "summary": "Get live room product list data", "description": "Get live room product list data", "parameters": [ { "name": "room_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room id", "title": "Room Id" }, "description": "Live room id", "example": "7420741353250507562" }, { "name": "author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Anchor ID", "title": "Author Id" }, "description": "Anchor ID", "example": "7408859677050274859" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 15, "title": "Page Size" }, "description": "Number" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 0, "title": "Offset" }, "description": "Number" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region", "default": "US", "title": "Region" }, "description": "Region" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User's own cookie", "default": "", "title": "Cookie" }, "description": "User's own cookie" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_live_search_result": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_live_search_result", "summary": "Get live search results of specified keywords", "description": "Get live search results of specified keywords", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Cat" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset", "example": 0 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number", "example": 20 }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region", "default": "US", "title": "Region" }, "description": "Region", "example": "US" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_location_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_location_search", "summary": "Get location search results", "description": "Get location search results", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Shanghai" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_multi_video": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_app_v3_fetch_multi_video", "summary": "Batch Get Video Information", "description": "Batch Get Video Information", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Aweme Ids", "description": "Video ID list" }, "example": [ "7339393672959757570", "7339393672959757570", "7339393672959757570", "7339393672959757570", "7339393672959757570", "7339393672959757570", "7339393672959757570", "7339393672959757570", "7339393672959757570", "7339393672959757570" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/app/v3/fetch_music_chart_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_music_chart_list", "summary": "Music Chart List", "description": "Music Chart List", "parameters": [ { "name": "scene", "in": "query", "required": false, "schema": { "type": "integer", "description": "Chart type: 0=Top 50, 1=Viral 50", "default": 0, "title": "Scene" }, "description": "Chart type: 0=Top 50, 1=Viral 50", "example": 0 }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Pagination cursor", "default": 0, "title": "Cursor" }, "description": "Pagination cursor", "example": 0 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page (max 50)", "default": 50, "title": "Count" }, "description": "Number per page (max 50)", "example": 50 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_music_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_music_detail", "summary": "Get details of specified music", "description": "Get details of specified music", "parameters": [ { "name": "music_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Music id", "title": "Music Id" }, "description": "Music id", "example": "6943027371519772674" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_music_search_result": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_music_search_result", "summary": "Get music search results of specified keywords", "description": "Get music search results of specified keywords", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Cat" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset", "example": 0 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number", "example": 20 }, { "name": "filter_by", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter type", "default": 0, "title": "Filter By" }, "description": "Filter type", "example": 0 }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type", "default": 0, "title": "Sort Type" }, "description": "Sort type", "example": 0 }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region", "default": "US", "title": "Region" }, "description": "Region", "example": "US" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_music_video_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_music_video_list", "summary": "Get video list of specified music", "description": "Get video list of specified music", "parameters": [ { "name": "music_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Music id", "title": "Music Id" }, "description": "Music id", "example": "6943027371519772674" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 10, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_one_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_one_video", "summary": "Get single video data", "description": "Get single video data", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Id" }, "description": "Video ID", "example": "7350810998023949599" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_one_video_by_share_url_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_one_video_by_share_url_v2", "summary": "Get single video data by sharing link", "description": "Get single video data by sharing link", "parameters": [ { "name": "share_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Share link", "title": "Share Url" }, "description": "Share link", "example": "https://www.tiktok.com/t/ZTFNEj8Hk/" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_post_ai_article": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_post_ai_article", "summary": "Get AI-generated article of a single video", "description": "Get AI-generated article of a single video", "parameters": [ { "name": "itemId", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Itemid" }, "description": "Video ID", "example": "7651935877744168194" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_post_comment": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_post_comment", "summary": "Get video comments", "description": "Get video comments", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Id" }, "description": "Video ID", "example": "7304809083817774382" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page" }, { "name": "current_region", "in": "query", "required": false, "schema": { "type": "string", "description": "Current region", "default": "", "title": "Current Region" }, "description": "Current region" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_post_comment_reply": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_post_comment_reply", "summary": "Get video comment replies", "description": "Get video comment replies", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Item Id" }, "description": "Video ID", "example": "7304809083817774382" }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Comment id", "title": "Comment Id" }, "description": "Comment id", "example": "7304877760886588191" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page" }, { "name": "current_region", "in": "query", "required": false, "schema": { "type": "string", "description": "Current region", "default": "", "title": "Current Region" }, "description": "Current region" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/web/fetch_post_detail_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_post_detail_v2", "summary": "Get single video data V2", "description": "Get single video data V2", "parameters": [ { "name": "itemId", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Itemid" }, "description": "Video ID", "example": "7339393672959757570" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code, optional; affects content region, e.g. US/GB/JP/ID, default US.", "default": "US", "title": "Region" }, "description": "Region code, optional; affects content region, e.g. US/GB/JP/ID, default US." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_search_keyword_suggest": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_search_keyword_suggest", "summary": "Search keyword suggest", "description": "Search keyword suggest", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "TikTok" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_search_live": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_search_live", "summary": "Search live", "description": "Search live", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "TikTok" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Offset" }, "description": "Page cursor" }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search id, need to provide when paging", "default": "", "title": "Search Id" }, "description": "Search id, need to provide when paging" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User cookie (if needed)", "title": "Cookie" }, "description": "User cookie (if needed)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_search_photo": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_search_photo", "summary": "Search photo", "description": "Search photo", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "TikTok" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page offset", "default": 0, "title": "Offset" }, "description": "Page offset" }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search id, need to provide when paging", "default": "", "title": "Search Id" }, "description": "Search id, need to provide when paging" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User cookie (if needed)", "title": "Cookie" }, "description": "User cookie (if needed)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_search_user": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_search_user", "summary": "Search user", "description": "Search user", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "TikTok" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor" }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search id, need to provide when paging", "default": "", "title": "Search Id" }, "description": "Search id, need to provide when paging" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User cookie (if needed)", "title": "Cookie" }, "description": "User cookie (if needed)" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/web/fetch_search_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_search_video", "summary": "Search video", "description": "Search video", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "TikTok" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Offset" }, "description": "Page cursor" }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search id, need to provide when paging", "default": "", "title": "Search Id" }, "description": "Search id, need to provide when paging" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "User cookie (if needed)", "title": "Cookie" }, "description": "User cookie (if needed)" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/app/v3/fetch_share_qr_code": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_share_qr_code", "summary": "Get share QR code", "description": "Get share QR code", "parameters": [ { "name": "object_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Object id", "title": "Object Id" }, "description": "Object id", "example": "6762244951259661318" }, { "name": "schema_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Schema type", "default": 4, "title": "Schema Type" }, "description": "Schema type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_share_short_link": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_share_short_link", "summary": "Get share short link", "description": "Get share short link", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Share link", "title": "Url" }, "description": "Share link", "example": "https://www.tiktok.com/passport/web/logout/" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_similar_user_recommendations": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_similar_user_recommendations", "summary": "Similar User Recommendations", "description": "Similar User Recommendations", "parameters": [ { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_uid", "title": "Sec Uid" }, "description": "User sec_uid", "example": "MS4wLjABAAAA2_YTgxz3kLb2XoyC3xOXnosim3gdiqMtFHnjRvckabZJFQ40XBOVttDCiB5cwa3b" }, { "name": "page_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Page token", "default": "", "title": "Page Token" }, "description": "Page token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_tag_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_tag_detail", "summary": "Tag Detail", "description": "Tag Detail", "parameters": [ { "name": "tag_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Tag name", "title": "Tag Name" }, "description": "Tag name", "example": "tiktok" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_tag_post": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_tag_post", "summary": "Tag Post", "description": "Tag Post", "parameters": [ { "name": "challengeID", "in": "query", "required": true, "schema": { "type": "string", "description": "Tag ID", "title": "Challengeid" }, "description": "Tag ID", "example": "7551" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 30, "title": "Count" }, "description": "Number per page" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_tiktok_live_data": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_tiktok_live_data", "summary": "Get live room information via live link", "description": "Get live room information via live link", "parameters": [ { "name": "live_room_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room link", "title": "Live Room Url" }, "description": "Live room link", "example": "https://www.tiktok.com/@.caseoh_daily/live" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_tiktok_web_guest_cookie": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_tiktok_web_guest_cookie", "summary": "Get the guest Cookie", "description": "Get the guest Cookie", "parameters": [ { "name": "user_agent", "in": "query", "required": true, "schema": { "type": "string", "description": "User browser agent", "title": "User Agent" }, "description": "User browser agent", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_trending_searchwords": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_trending_searchwords", "summary": "Get daily trending search words", "description": "Get daily trending search words", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_collect": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_collect", "summary": "Get user favorites", "description": "Get user favorites", "parameters": [ { "name": "cookie", "in": "query", "required": true, "schema": { "type": "string", "description": "User cookie", "title": "Cookie" }, "description": "User cookie", "example": "Your_Cookie" }, { "name": "secUid", "in": "query", "required": true, "schema": { "type": "string", "description": "User secUid", "title": "Secuid" }, "description": "User secUid", "example": "Your_SecUid" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 30, "title": "Count" }, "description": "Number per page" }, { "name": "coverFormat", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cover format", "default": 2, "title": "Coverformat" }, "description": "Cover format" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/app/v3/fetch_user_country_by_username": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_user_country_by_username", "summary": "Get user account country by username", "description": "Get user account country by username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "tiktok" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_fans": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_fans", "summary": "Get user followers", "description": "Get user followers", "parameters": [ { "name": "secUid", "in": "query", "required": true, "schema": { "type": "string", "description": "User secUid", "title": "Secuid" }, "description": "User secUid", "example": "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 30, "title": "Count" }, "description": "Number per page" }, { "name": "maxCursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Max cursor", "default": 0, "title": "Maxcursor" }, "description": "Max cursor" }, { "name": "minCursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Min cursor", "default": 0, "title": "Mincursor" }, "description": "Min cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_follow": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_follow", "summary": "Get user followings", "description": "Get user followings", "parameters": [ { "name": "secUid", "in": "query", "required": true, "schema": { "type": "string", "description": "User secUid", "title": "Secuid" }, "description": "User secUid", "example": "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 30, "title": "Count" }, "description": "Number per page" }, { "name": "maxCursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Max cursor", "default": 0, "title": "Maxcursor" }, "description": "Max cursor" }, { "name": "minCursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Min cursor", "default": 0, "title": "Mincursor" }, "description": "Min cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/app/v3/fetch_user_follower_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_user_follower_list", "summary": "Get follower list of specified user", "description": "Get follower list of specified user", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID (One of user_id and sec_user_id)", "default": "", "title": "User Id" }, "description": "User ID (One of user_id and sec_user_id)", "example": "7486586574684881927" }, { "name": "sec_user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User sec_user_id (One of user_id and sec_user_id)", "default": "", "title": "Sec User Id" }, "description": "User sec_user_id (One of user_id and sec_user_id)", "example": "MS4wLjABAAAA0lKrE0cVLLZCnVil-n-YEZlOoik9oeO3zOYQ08dqOEOw2pRSXWJdcSFw7lZeZcSP" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number", "example": 20 }, { "name": "min_time", "in": "query", "required": false, "schema": { "type": "integer", "description": "Minimum time for paging", "default": 0, "title": "Min Time" }, "description": "Minimum time for paging", "example": 0 }, { "name": "page_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Page token", "default": "", "title": "Page Token" }, "description": "Page token", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_user_following_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_user_following_list", "summary": "Get following list of specified user", "description": "Get following list of specified user", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID (One of user_id and sec_user_id)", "default": "", "title": "User Id" }, "description": "User ID (One of user_id and sec_user_id)", "example": "7486586574684881927" }, { "name": "sec_user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User sec_user_id (One of user_id and sec_user_id)", "default": "", "title": "Sec User Id" }, "description": "User sec_user_id (One of user_id and sec_user_id)", "example": "MS4wLjABAAAA0lKrE0cVLLZCnVil-n-YEZlOoik9oeO3zOYQ08dqOEOw2pRSXWJdcSFw7lZeZcSP" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number", "example": 20 }, { "name": "min_time", "in": "query", "required": false, "schema": { "type": "integer", "description": "Minimum time for paging", "default": 0, "title": "Min Time" }, "description": "Minimum time for paging", "example": 0 }, { "name": "page_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Page token", "default": "", "title": "Page Token" }, "description": "Page token", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_like": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_like", "summary": "Get user likes", "description": "Get user likes", "parameters": [ { "name": "secUid", "in": "query", "required": true, "schema": { "type": "string", "description": "User secUid", "title": "Secuid" }, "description": "User secUid", "example": "MS4wLjABAAAAq1iRXNduFZpY301UkVpJ1eQT60_NiWS9QQSeNqmNQEDJp0pOF8cpleNEdiJx5_IU" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page" }, { "name": "coverFormat", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cover format", "default": 2, "title": "Coverformat" }, "description": "Cover format" }, { "name": "post_item_list_request_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type", "default": 0, "title": "Post Item List Request Type" }, "description": "Sort type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_user_like_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_user_like_videos", "summary": "Get user like video data", "description": "Get user like video data", "parameters": [ { "name": "sec_user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_user_id", "title": "Sec User Id" }, "description": "User sec_user_id", "example": "MS4wLjABAAAA-RkTGCGXLuLKRM5Xcuuwm7Mclg51I2ECO1RqOA7mJHuXFz99nztdi077Z2XmYHZV" }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum cursor", "default": 0, "title": "Max Cursor" }, "description": "Maximum cursor" }, { "name": "counts", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Counts" }, "description": "Number per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_live_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_live_detail", "summary": "Get user live details", "description": "Get user live details", "parameters": [ { "name": "uniqueId", "in": "query", "required": true, "schema": { "type": "string", "description": "User uniqueId", "title": "Uniqueid" }, "description": "User uniqueId", "example": "tiktok" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_mix": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_mix", "summary": "Get user mix list", "description": "Get user mix list", "parameters": [ { "name": "mixId", "in": "query", "required": true, "schema": { "type": "string", "description": "Mix id", "title": "Mixid" }, "description": "Mix id", "example": "7101538765474106158" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 30, "title": "Count" }, "description": "Number per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_user_music_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_user_music_list", "summary": "Get user music list data", "description": "Get user music list data", "parameters": [ { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_uid", "title": "Sec Uid" }, "description": "User sec_uid", "example": "MS4wLjABAAAAqB08cUbXaDWqbD6MCga2RbGTuhfO2EsHayBYx08NDrN7IE3jQuRDNNN6YwyfH6_6" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 10, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_play_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_play_list", "summary": "Get user play list", "description": "Get user play list", "parameters": [ { "name": "secUid", "in": "query", "required": true, "schema": { "type": "string", "description": "User secUid", "title": "Secuid" }, "description": "User secUid", "example": "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 30, "title": "Count" }, "description": "Number per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_post": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_post", "summary": "Get user posts", "description": "Get user posts", "parameters": [ { "name": "secUid", "in": "query", "required": true, "schema": { "type": "string", "description": "User secUid", "title": "Secuid" }, "description": "User secUid", "example": "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor", "example": 0 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page, max 15", "default": 15, "title": "Count" }, "description": "Number per page, max 15", "example": 15 }, { "name": "coverFormat", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cover format", "default": 2, "title": "Coverformat" }, "description": "Cover format", "example": 2 }, { "name": "post_item_list_request_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type (deprecated, no longer effective)", "default": 0, "title": "Post Item List Request Type" }, "description": "Sort type (deprecated, no longer effective)", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_user_post_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_user_post_videos", "summary": "Get user homepage video data V1", "description": "Get user homepage video data V1", "parameters": [ { "name": "sec_user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User sec_user_id", "default": "", "title": "Sec User Id" }, "description": "User sec_user_id", "example": "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM" }, { "name": "unique_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User unique_id", "default": "", "title": "Unique Id" }, "description": "User unique_id", "example": "" }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum cursor", "default": 0, "title": "Max Cursor" }, "description": "Maximum cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type", "default": 0, "title": "Sort Type" }, "description": "Sort type" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region, optional; defaults to US data if not provided. When specified, returns data for that country/region, e.g. US, GB, FR", "default": "", "title": "Region" }, "description": "Region, optional; defaults to US data if not provided. When specified, returns data for that country/region, e.g. US, GB, FR", "example": "US" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_profile", "summary": "Get user profile", "description": "Get user profile", "parameters": [ { "name": "uniqueId", "in": "query", "required": false, "schema": { "type": "string", "description": "User uniqueId", "default": "", "title": "Uniqueid" }, "description": "User uniqueId", "example": "tiktok" }, { "name": "secUid", "in": "query", "required": false, "schema": { "type": "string", "description": "User secUid", "default": "", "title": "Secuid" }, "description": "User secUid" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/fetch_user_repost": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_fetch_user_repost", "summary": "Get user reposts", "description": "Get user reposts", "parameters": [ { "name": "secUid", "in": "query", "required": true, "schema": { "type": "string", "description": "User secUid", "title": "Secuid" }, "description": "User secUid", "example": "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page cursor", "default": 0, "title": "Cursor" }, "description": "Page cursor", "example": 0 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page", "example": 20 }, { "name": "coverFormat", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cover format", "default": 2, "title": "Coverformat" }, "description": "Cover format", "example": 2 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_user_repost_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_user_repost_videos", "summary": "Get user repost video data", "description": "Get user repost video data", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "User id", "title": "User Id" }, "description": "User id", "example": 107955 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 21, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_user_search_result": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_user_search_result", "summary": "Get user search results of specified keywords", "description": "Get user search results of specified keywords", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Cat" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset", "example": 0 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number", "example": 20 }, { "name": "user_search_follower_count", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort by number of followers", "default": "", "title": "User Search Follower Count" }, "description": "Sort by number of followers", "example": "" }, { "name": "user_search_profile_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort by account type", "default": "", "title": "User Search Profile Type" }, "description": "Sort by account type", "example": "" }, { "name": "user_search_other_pref", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort by other preferences", "default": "", "title": "User Search Other Pref" }, "description": "Sort by other preferences", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_video_comment_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_video_comment_replies", "summary": "Get comment replies data of specified video", "description": "Get comment replies data of specified video", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Item Id" }, "description": "Video ID", "example": "7326156045968067873" }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Comment id", "title": "Comment Id" }, "description": "Comment id", "example": "7327061675382260482" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_video_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_video_comments", "summary": "Get single video comments data", "description": "Get single video comments data", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Id" }, "description": "Video ID", "example": "7326156045968067873" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_video_search_result": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_video_search_result", "summary": "Get video search results of specified keywords", "description": "Get video search results of specified keywords", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Zhonghua Niang" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset", "example": 0 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number", "example": 20 }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type", "default": 0, "title": "Sort Type" }, "description": "Sort type", "example": 0 }, { "name": "publish_time", "in": "query", "required": false, "schema": { "type": "integer", "description": "Publish time", "default": 0, "title": "Publish Time" }, "description": "Publish time", "example": 0 }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region", "default": "US", "title": "Region" }, "description": "Region", "example": "US" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/fetch_webcast_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_fetch_webcast_user_info", "summary": "Get information of specified Webcast user", "description": "Get information of specified Webcast user", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User uid (optional, numeric only)", "default": "", "title": "User Id" }, "description": "User uid (optional, numeric only)", "example": "" }, { "name": "sec_user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User sec_user_id", "default": "", "title": "Sec User Id" }, "description": "User sec_user_id", "example": "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/generate_fingerprint": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_generate_fingerprint", "summary": "Generate browser fingerprint", "description": "Generate browser fingerprint", "parameters": [ { "name": "browser_type", "in": "query", "required": false, "schema": { "type": "string", "title": "Browser Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/generate_hashed_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_generate_hashed_id", "summary": "Generate hashed ID", "description": "Generate hashed ID", "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string", "description": "Email address", "title": "Email" }, "description": "Email address", "example": "test@example.com" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/generate_real_msToken": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_generate_real_msToken", "summary": "Generate real msToken", "description": "Generate real msToken", "parameters": [ { "name": "random_strData", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Random Strdata" } }, { "name": "browser_type", "in": "query", "required": false, "schema": { "type": "string", "title": "Browser Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/generate_ttwid": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_generate_ttwid", "summary": "Generate ttwid", "description": "Generate ttwid", "parameters": [ { "name": "user_agent", "in": "query", "required": false, "schema": { "type": "string", "default": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:125.0) Gecko/20100101 Firefox/125.0", "title": "User Agent" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/generate_webid": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_generate_webid", "summary": "Generate web_id", "description": "Generate web_id", "parameters": [ { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "title": "Cookie" } }, { "name": "user_agent", "in": "query", "required": false, "schema": { "type": "string", "default": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:145.0) Gecko/20100101 Firefox/145.0", "title": "User Agent" } }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string", "default": "https://www.tiktok.com/explore", "title": "Url" } }, { "name": "referer", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Referer" } }, { "name": "user_unique_id", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "User Unique Id" } }, { "name": "app_id", "in": "query", "required": false, "schema": { "type": "integer", "default": 1988, "title": "App Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/generate_wss_xb_signature": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_generate_wss_xb_signature", "summary": "Generate TikTok WSS X-Bogus signature", "description": "Generate TikTok WSS X-Bogus signature", "parameters": [ { "name": "user_agent", "in": "query", "required": false, "schema": { "type": "string", "description": "User browser agent (optional)", "title": "User Agent" }, "description": "User browser agent (optional)", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/143.0.0.0 Safari/537.36 Edg/143.0.0.0" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/generate_x_mssdk_info": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_generate_x_mssdk_info", "summary": "Generate X-Mssdk-Info", "description": "Generate X-Mssdk-Info", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XMssdkInfoModel" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/generate_xbogus": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_generate_xbogus", "summary": "Generate XBogus", "description": "Generate XBogus", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XBogusModel" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/generate_xgnarly": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_generate_xgnarly", "summary": "Generate XGnarly", "description": "Generate XGnarly", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XGnarlyAndXBogusModel" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/web/generate_xgnarly_and_xbogus": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_generate_xgnarly_and_xbogus", "summary": "Generate XGnarly and XBogus", "description": "Generate XGnarly and XBogus", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XGnarlyAndXBogusModel" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/web/get_all_aweme_id": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_get_all_aweme_id", "summary": "Extract list video id", "description": "Extract list video id", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Url", "description": "Video link" }, "example": [ "https://www.tiktok.com/@owlcitymusic/video/7218694761253735723" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/web/get_all_sec_user_id": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_get_all_sec_user_id", "summary": "Extract list user sec_user_id", "description": "Extract list user sec_user_id", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Url", "description": "User homepage link" }, "example": [ "https://www.tiktok.com/@tiktok" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/web/get_all_unique_id": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_get_all_unique_id", "summary": "Get list unique_id", "description": "Get list unique_id", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Url", "description": "User homepage link" }, "example": [ "https://www.tiktok.com/@tiktok" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/web/get_aweme_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_get_aweme_id", "summary": "Extract single video id", "description": "Extract single video id", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Video link", "title": "Url" }, "description": "Video link", "example": "https://www.tiktok.com/@owlcitymusic/video/7218694761253735723" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/get_live_room_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_get_live_room_id", "summary": "Extract live room ID from live room link", "description": "Extract live room ID from live room link", "parameters": [ { "name": "live_room_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room link", "title": "Live Room Url" }, "description": "Live room link", "example": "https://www.tiktok.com/@maksukaracun/live" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/get_sec_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_get_sec_user_id", "summary": "Extract user sec_user_id", "description": "Extract user sec_user_id", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "User homepage link", "title": "Url" }, "description": "User homepage link", "example": "https://www.tiktok.com/@tiktok" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/get_unique_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_get_unique_id", "summary": "Get user unique_id", "description": "Get user unique_id", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "User homepage link", "title": "Url" }, "description": "User homepage link", "example": "https://www.tiktok.com/@tiktok" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/get_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_get_user_id", "summary": "Extract user user_id", "description": "Extract user user_id", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "User homepage link", "title": "Url" }, "description": "User homepage link", "example": "https://www.tiktok.com/@tiktok" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/get_user_id_and_sec_user_id_by_username": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_get_user_id_and_sec_user_id_by_username", "summary": "Get user_id and sec_user_id by Username", "description": "Get user_id and sec_user_id by Username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "tiktok" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/handler_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_handler_user_profile", "summary": "Get information of specified user", "description": "Get information of specified user", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User uid (optional, numeric only)", "default": "", "title": "User Id" }, "description": "User uid (optional, numeric only)", "example": "" }, { "name": "sec_user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User sec_user_id", "default": "", "title": "Sec User Id" }, "description": "User sec_user_id", "example": "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM" }, { "name": "unique_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User unique_id (username)", "default": "", "title": "Unique Id" }, "description": "User unique_id (username)", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/open_tiktok_app_to_keyword_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_open_tiktok_app_to_keyword_search", "summary": "Generate TikTok share link, call TikTok APP, and jump to the specified keyword search result", "description": "Generate TikTok share link, call TikTok APP, and jump to the specified keyword search result", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Evil0ctal" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/open_tiktok_app_to_send_private_message": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_open_tiktok_app_to_send_private_message", "summary": "Generate TikTok share link, call TikTok APP, and send private messages to specified users", "description": "Generate TikTok share link, call TikTok APP, and send private messages to specified users", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "Uid" }, "description": "User id", "example": "7059867056504407087" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/open_tiktok_app_to_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_open_tiktok_app_to_user_profile", "summary": "Generate TikTok share link, call TikTok APP, and jump to the specified user profile", "description": "Generate TikTok share link, call TikTok APP, and jump to the specified user profile", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "Uid" }, "description": "User id", "example": "7059867056504407087" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/open_tiktok_app_to_video_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_open_tiktok_app_to_video_detail", "summary": "Generate TikTok share link, call TikTok APP, and jump to the specified video details page", "description": "Generate TikTok share link, call TikTok APP, and jump to the specified video details page", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Aweme Id" }, "description": "Video ID", "example": "7440436579409153311" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/search_follower_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_search_follower_list", "summary": "Search follower list", "description": "Search follower list", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "7540849481009988663" }, { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "a" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/app/v3/search_following_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_app_v3_search_following_list", "summary": "Search following list", "description": "Search following list", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "7540849481009988663" }, { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "a" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/web/tiktok_live_room": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.000145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_web_tiktok_live_room", "summary": "Extract live room danmaku", "description": "Extract live room danmaku", "parameters": [ { "name": "live_room_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Live room link", "title": "Live Room Url" }, "description": "Live room link", "example": "https://www.tiktok.com/@mpl.id.official/live" }, { "name": "danmaku_type", "in": "query", "required": true, "schema": { "type": "string", "description": "Message type", "title": "Danmaku Type" }, "description": "Message type", "example": "WebcastChatMessage" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/check_allow_comment_with_pic": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_check_allow_comment_with_pic", "summary": "Check if Weibo allows image comments", "description": "Check if Weibo allows image comments", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "description": "Weibo ID", "title": "Id" }, "description": "Weibo ID", "example": "5092682368025584" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_advanced_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_advanced_search", "summary": "Weibo Advanced Search", "description": "Weibo Advanced Search", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Q" }, "description": "Search keyword", "example": "yu7" }, { "name": "search_type", "in": "query", "required": false, "schema": { "description": "Search type: all, hot, original, verified, media, viewpoint", "title": "Search Type", "nullable": true, "type": "string" }, "description": "Search type: all, hot, original, verified, media, viewpoint", "example": "hot" }, { "name": "include_type", "in": "query", "required": false, "schema": { "description": "Include type: all (all), pic (with image), video (with video), music (with music), link (with short link)", "title": "Include Type", "nullable": true, "type": "string" }, "description": "Include type: all (all), pic (with image), video (with video), music (with music), link (with short link)", "example": "pic" }, { "name": "timescope", "in": "query", "required": false, "schema": { "description": "Time scope: custom:start:end", "title": "Timescope", "nullable": true, "type": "string" }, "description": "Time scope: custom:start:end", "example": "custom:2025-09-01-0:2025-09-08-23" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_ai_related_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_ai_related_search", "summary": "Weibo AI Search Content Extension", "description": "Weibo AI Search Content Extension", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "#WeiboAdventures#" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_ai_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_ai_search", "summary": "Weibo AI Search", "description": "Weibo AI Search", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "#France#" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_ai_smart_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_ai_smart_search", "summary": "AI Smart Search", "description": "AI Smart Search", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "Artificial Intelligence" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_all_groups": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_all_groups", "summary": "Get all groups information", "description": "Get all groups information", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_city_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_city_list", "summary": "Region City List", "description": "Region City List", "parameters": [ { "name": "normalized", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to return normalized structure (province list + city array)", "default": true, "title": "Normalized" }, "description": "Whether to return normalized structure (province list + city array)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_entertainment_ranking": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_entertainment_ranking", "summary": "Get Weibo entertainment ranking", "description": "Get Weibo entertainment ranking", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_home_recommend_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_home_recommend_feed", "summary": "Get home recommend feed", "description": "Get home recommend feed", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number; omit for the first page, pass 2 for the second page", "title": "Page", "nullable": true, "type": "string" }, "description": "Page number; omit for the first page, pass 2 for the second page" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Items per page", "default": 15, "title": "Count" }, "description": "Items per page", "example": 15 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_hot_ranking_timeline": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_hot_ranking_timeline", "summary": "Get hot ranking timeline", "description": "Get hot ranking timeline", "parameters": [ { "name": "ranking_type", "in": "query", "required": true, "schema": { "type": "string", "description": "Ranking type: hour=hourly, yesterday=yesterday, day_before=day before, week=weekly, male=male ranking, female=female ranking", "title": "Ranking Type" }, "description": "Ranking type: hour=hourly, yesterday=yesterday, day_before=day before, week=weekly, male=male ranking, female=female ranking", "example": "hour" }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination identifier, default is 0", "default": "0", "title": "Since Id" }, "description": "Pagination identifier, default is 0", "example": "0" }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Max ID, default is 0", "default": "0", "title": "Max Id" }, "description": "Max ID, default is 0", "example": "0" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Count, default is 10", "default": 10, "title": "Count" }, "description": "Count, default is 10", "example": 10 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_hot_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_hot_search", "summary": "Get hot search", "description": "Get hot search", "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot search category: mineband=Mine, realtimehot=Hot Search, social=Society, fun=Entertainment, technologynav=Technology, lifenav=Lifestyle, region=Local, sportnav=Sports, gamenav=ACG", "default": "realtimehot", "title": "Category" }, "description": "Hot search category: mineband=Mine, realtimehot=Hot Search, social=Society, fun=Entertainment, technologynav=Technology, lifenav=Lifestyle, region=Local, sportnav=Sports, gamenav=ACG", "example": "realtimehot" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Items per page", "default": 20, "title": "Count" }, "description": "Items per page", "example": 20 }, { "name": "region_name", "in": "query", "required": false, "schema": { "type": "string", "description": "City name for local trending searches, only effective when category=region. Supported cities: Beijing/Shanghai/Guangzhou/Shenzhen/Hangzhou/Chengdu/Chongqing/Wuhan/Nanjing/Tianjin/Xi'an/Changsha/Zhengzhou/Suzhou/Dongguan/Qingdao/Shenyang/Hefei, etc. Default: Beijing", "title": "Region Name" }, "description": "City name for local trending searches, only effective when category=region. Supported cities: Beijing/Shanghai/Guangzhou/Shenzhen/Hangzhou/Chengdu/Chongqing/Wuhan/Nanjing/Tianjin/Xi'an/Changsha/Zhengzhou/Suzhou/Dongguan/Qingdao/Shenyang/Hefei, etc. Default: Beijing", "example": "Beijing" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_hot_search_brief": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_hot_search_brief", "summary": "Get hot search brief", "description": "Get hot search brief", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_hot_search_categories": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_hot_search_categories", "summary": "Get hot search categories", "description": "Get hot search categories", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_hot_search_index": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_hot_search_index", "summary": "Get Weibo hot search index (10 items)", "description": "Get Weibo hot search index (10 items)", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_hot_search_summary": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.002175, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_hot_search_summary", "summary": "Get Weibo complete hot search ranking (50 items)", "description": "Get Weibo complete hot search ranking (50 items)", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_life_ranking": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_life_ranking", "summary": "Get Weibo life ranking", "description": "Get Weibo life ranking", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_pic_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_pic_search", "summary": "Weibo picture search", "description": "Weibo picture search", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "yu7" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_post_comments", "summary": "Get Weibo comments", "description": "Get Weibo comments", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "description": "Weibo ID", "title": "Id" }, "description": "Weibo ID", "example": "5283919831764022" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of comments", "default": 10, "title": "Count" }, "description": "Number of comments", "example": 10 }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Page number", "default": "", "title": "Max Id" }, "description": "Page number", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_post_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_post_detail", "summary": "Get single post data", "description": "Get single post data", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Id" }, "description": "Post ID", "example": "5092682368025584" }, { "name": "is_get_long_text", "in": "query", "required": false, "schema": { "type": "string", "description": "Whether to get the full text of long Weibo posts (true/false)", "default": "true", "title": "Is Get Long Text" }, "description": "Whether to get the full text of long Weibo posts (true/false)", "example": "true" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_post_sub_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_post_sub_comments", "summary": "Get Weibo sub-comments", "description": "Get Weibo sub-comments", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "description": "Comment ID", "title": "Id" }, "description": "Comment ID", "example": "5283574244704555" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of sub-comments", "default": 10, "title": "Count" }, "description": "Number of sub-comments", "example": 10 }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Page identifier", "default": "", "title": "Max Id" }, "description": "Page identifier", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_realtime_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_realtime_search", "summary": "Weibo Realtime Search", "description": "Weibo Realtime Search", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "yu7" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_search_all": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_search_all", "summary": "Comprehensive search", "description": "Comprehensive search", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "NVIDIA" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "search_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Search type: 1=comprehensive, 61=real-time, 3=user, 64=video, 63=image, 62=following, 60=trending, 21=entire network, 38=topic, 98=super topic, 92=location, 97=product", "default": 1, "title": "Search Type" }, "description": "Search type: 1=comprehensive, 61=real-time, 3=user, 64=video, 63=image, 62=following, 60=trending, 21=entire network, 38=topic, 98=super topic, 92=location, 97=product", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_similar_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_similar_search", "summary": "Get Weibo similar search recommendations", "description": "Get Weibo similar search recommendations", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "#WeiboAdventures#" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_social_ranking": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_social_ranking", "summary": "Get Weibo social ranking", "description": "Get Weibo social ranking", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_status_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_status_comments", "summary": "Get post comments", "description": "Get post comments", "parameters": [ { "name": "status_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Weibo ID", "title": "Status Id" }, "description": "Weibo ID", "example": "5258708168476831" }, { "name": "max_id", "in": "query", "required": false, "schema": { "description": "Pagination cursor", "title": "Max Id", "nullable": true, "type": "string" }, "description": "Pagination cursor" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort type: 0=by popularity, 1=by time", "default": "0", "title": "Sort Type" }, "description": "Sort type: 0=by popularity, 1=by time", "example": "0" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_status_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_status_detail", "summary": "Get post detail", "description": "Get post detail", "parameters": [ { "name": "status_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Weibo ID", "title": "Status Id" }, "description": "Weibo ID", "example": "5016922058656962" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_status_likes": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_status_likes", "summary": "Get post likes", "description": "Get post likes", "parameters": [ { "name": "status_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Weibo ID", "title": "Status Id" }, "description": "Weibo ID", "example": "5016922058656962" }, { "name": "attitude_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Reaction type: 0=All, 1=Like, 2=Happy, 3=Surprised, 4=Sad, 5=Angry, 6=Tip, 8=Hug", "default": "0", "title": "Attitude Type" }, "description": "Reaction type: 0=All, 1=Like, 2=Happy, 3=Surprised, 4=Sad, 5=Angry, 6=Tip, 8=Hug", "example": "0" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_status_reposts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_status_reposts", "summary": "Get post reposts", "description": "Get post reposts", "parameters": [ { "name": "status_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Weibo ID", "title": "Status Id" }, "description": "Weibo ID", "example": "5016922058656962" }, { "name": "max_id", "in": "query", "required": false, "schema": { "description": "Pagination cursor", "title": "Max Id", "nullable": true, "type": "string" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_topic_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_topic_search", "summary": "Weibo topic search", "description": "Weibo topic search", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "yu7" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_album": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_album", "summary": "Get user album", "description": "Get user album", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "7648703289" }, { "name": "since_id", "in": "query", "required": false, "schema": { "description": "Pagination cursor", "title": "Since Id", "nullable": true, "type": "string" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_articles": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_articles", "summary": "Get user articles", "description": "Get user articles", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "1725941200" }, { "name": "since_id", "in": "query", "required": false, "schema": { "description": "Pagination cursor", "title": "Since Id", "nullable": true, "type": "string" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_audios": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_audios", "summary": "Get user audios", "description": "Get user audios", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "1725941200" }, { "name": "since_id", "in": "query", "required": false, "schema": { "description": "Pagination cursor", "title": "Since Id", "nullable": true, "type": "string" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/weibo/web_v2/fetch_user_basic_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_basic_info", "summary": "Get user basic information", "description": "Get user basic information", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "Uid" }, "description": "User id", "example": "7277477906" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_user_fans": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_fans", "summary": "Get user fans list", "description": "Get user fans list", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "1722594714" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 0, "title": "Page" }, "description": "Page number", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_followers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_followers", "summary": "Get user followers", "description": "Get user followers", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "1856404484" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number starting from 1", "default": 1, "title": "Page" }, "description": "Page number starting from 1", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_following": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_following", "summary": "Get user following", "description": "Get user following", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "1856404484" }, { "name": "since_id", "in": "query", "required": false, "schema": { "description": "Pagination cursor in the format \"timestamp|offset\"; omit for the first request, then pass the since_id value from the previous response", "title": "Since Id", "nullable": true, "type": "string" }, "description": "Pagination cursor in the format \"timestamp|offset\"; omit for the first request, then pass the since_id value from the previous response" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type: 1=by latest Weibo time, 2=by follow time (default)", "default": 2, "title": "Sort Type" }, "description": "Sort type: 1=by latest Weibo time, 2=by follow time (default)", "example": 2 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_info", "summary": "Get user information", "description": "Get user information", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "7648703289" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_info_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_info_detail", "summary": "Get user detail information", "description": "Get user detail information", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "7648703289" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_user_original_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_original_posts", "summary": "Get Weibo user original posts", "description": "Get Weibo user original posts", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "Uid" }, "description": "User id", "example": "7277477906" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination identifier for getting next page data", "default": "", "title": "Since Id" }, "description": "Pagination identifier for getting next page data", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_user_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_posts", "summary": "Get Weibo user posts", "description": "Get Weibo user posts", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "Uid" }, "description": "User id", "example": "7277477906" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "feature", "in": "query", "required": false, "schema": { "type": "integer", "description": "Feature type: 0=10 basic posts, 1=20 extended posts, 2=20 image-related posts, 3=20 video-related posts, fields increase progressively", "default": 0, "title": "Feature" }, "description": "Feature type: 0=10 basic posts, 1=20 extended posts, 2=20 image-related posts, 3=20 video-related posts, fields increase progressively", "example": 0 }, { "name": "since_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination identifier for getting next page data", "default": "", "title": "Since Id" }, "description": "Pagination identifier for getting next page data", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_profile_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_profile_feed", "summary": "Get user profile feed", "description": "Get user profile feed", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "6580994757" }, { "name": "since_id", "in": "query", "required": false, "schema": { "description": "Pagination cursor", "title": "Since Id", "nullable": true, "type": "string" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_user_recommend_timeline": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_recommend_timeline", "summary": "Get user recommend timeline", "description": "Get user recommend timeline", "parameters": [ { "name": "refresh", "in": "query", "required": false, "schema": { "type": "integer", "description": "Refresh type: 0=normal refresh, 1=force refresh", "default": 0, "title": "Refresh" }, "description": "Refresh type: 0=normal refresh, 1=force refresh", "example": 0 }, { "name": "group_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Group ID", "default": "102803", "title": "Group Id" }, "description": "Group ID", "example": "102803" }, { "name": "containerid", "in": "query", "required": false, "schema": { "type": "string", "description": "Container ID", "default": "102803", "title": "Containerid" }, "description": "Container ID", "example": "102803" }, { "name": "extparam", "in": "query", "required": false, "schema": { "type": "string", "description": "Extended parameters", "default": "discover|new_feed", "title": "Extparam" }, "description": "Extended parameters", "example": "discover|new_feed" }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Max ID", "default": "0", "title": "Max Id" }, "description": "Max ID", "example": "0" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Count", "default": 10, "title": "Count" }, "description": "Count", "example": 10 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_user_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_search", "summary": "User search", "description": "User search", "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "description": "Search keyword/Query (if provided, treated as 'all' search; leave empty to apply only advanced filter parameters)", "title": "Query", "nullable": true, "type": "string" }, "description": "Search keyword/Query (if provided, treated as 'all' search; leave empty to apply only advanced filter parameters)", "example": "yu7" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page", "default": 1, "title": "Page" }, "description": "Page", "example": 1 }, { "name": "region", "in": "query", "required": false, "schema": { "description": "Region code from /city_list", "title": "Region", "nullable": true, "type": "string" }, "description": "Region code from /city_list", "example": "custom:11:1" }, { "name": "auth", "in": "query", "required": false, "schema": { "description": "Auth type: org_vip (organization), per_vip (individual), ord (standard)", "title": "Auth", "nullable": true, "type": "string" }, "description": "Auth type: org_vip (organization), per_vip (individual), ord (standard)", "example": "org_vip" }, { "name": "gender", "in": "query", "required": false, "schema": { "description": "Gender: man / women", "title": "Gender", "nullable": true, "type": "string" }, "description": "Gender: man / women", "example": "man" }, { "name": "age", "in": "query", "required": false, "schema": { "description": "Age bucket: 18y/22y/29y/39y/40y", "title": "Age", "nullable": true, "type": "string" }, "description": "Age bucket: 18y/22y/29y/39y/40y", "example": "22y" }, { "name": "nickname", "in": "query", "required": false, "schema": { "description": "Nickname filter", "title": "Nickname", "nullable": true, "type": "string" }, "description": "Nickname filter", "example": "Zhang San" }, { "name": "tag", "in": "query", "required": false, "schema": { "description": "Tag filter", "title": "Tag", "nullable": true, "type": "string" }, "description": "Tag filter", "example": "Photography" }, { "name": "school", "in": "query", "required": false, "schema": { "description": "School filter", "title": "School", "nullable": true, "type": "string" }, "description": "School filter", "example": "Tsinghua University" }, { "name": "work", "in": "query", "required": false, "schema": { "description": "Company filter", "title": "Work", "nullable": true, "type": "string" }, "description": "Company filter", "example": "ByteDance" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_super_topics": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_super_topics", "summary": "Get user super topics", "description": "Get user super topics", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "7648703289" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_timeline": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_timeline", "summary": "Get user timeline", "description": "Get user timeline", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "7648703289" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "filter_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter type", "default": "all", "title": "Filter Type" }, "description": "Filter type", "example": "all" }, { "name": "month", "in": "query", "required": false, "schema": { "description": "Time filter (YYYYMMDD format)", "title": "Month", "nullable": true, "type": "string" }, "description": "Time filter (YYYYMMDD format)", "example": "20251010" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_user_video_collection_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_video_collection_detail", "summary": "Get user video collection detail", "description": "Get user video collection detail", "parameters": [ { "name": "cid", "in": "query", "required": true, "schema": { "type": "string", "description": "Collection ID", "title": "Cid" }, "description": "Collection ID", "example": "4883992307236954" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor", "default": "", "title": "Cursor" }, "description": "Pagination cursor", "example": "" }, { "name": "tab_code", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type: 0=default, 1=hottest, 2=latest", "default": 0, "title": "Tab Code" }, "description": "Sort type: 0=default, 1=hottest, 2=latest", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_user_video_collection_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_video_collection_list", "summary": "Get user video collection list", "description": "Get user video collection list", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "7277477906" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_user_video_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_video_list", "summary": "Get user all videos", "description": "Get user all videos", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "7277477906" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor", "default": "0", "title": "Cursor" }, "description": "Pagination cursor", "example": "0" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_user_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_user_videos", "summary": "Get user videos", "description": "Get user videos", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "7648703289" }, { "name": "since_id", "in": "query", "required": false, "schema": { "description": "Pagination cursor", "title": "Since Id", "nullable": true, "type": "string" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_video_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_video_detail", "summary": "Get video detail", "description": "Get video detail", "parameters": [ { "name": "mid", "in": "query", "required": true, "schema": { "type": "string", "description": "Weibo video ID", "title": "Mid" }, "description": "Weibo video ID", "example": "5242977759006596" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/app/fetch_video_featured_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_app_fetch_video_featured_feed", "summary": "Get video featured feed", "description": "Get video featured feed", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number; omit for the first page, pass 2 for the second page", "title": "Page", "nullable": true, "type": "string" }, "description": "Page number; omit for the first page, pass 2 for the second page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/fetch_video_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_video_search", "summary": "all)", "description": "all)", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "yu7" }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "description": "Search mode: hot=trending, all=all", "default": "hot", "title": "Mode" }, "description": "Search mode: hot=trending, all=all", "example": "hot" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/weibo/web_v2/search_user_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_search_user_posts", "summary": "Search user posts", "description": "Search user posts", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "7277477906" }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "description": "Search keyword", "default": "", "title": "Q" }, "description": "Search keyword" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "starttime", "in": "query", "required": false, "schema": { "description": "Start timestamp", "default": 1772294400, "title": "Starttime", "nullable": true, "type": "integer" }, "description": "Start timestamp", "example": 1772294400 }, { "name": "endtime", "in": "query", "required": false, "schema": { "description": "End timestamp", "default": 1772294400, "title": "Endtime", "nullable": true, "type": "integer" }, "description": "End timestamp", "example": 1772294400 }, { "name": "hasori", "in": "query", "required": false, "schema": { "type": "integer", "description": "Include original posts: 1=include, 0=exclude", "default": 1, "title": "Hasori" }, "description": "Include original posts: 1=include, 0=exclude", "example": 1 }, { "name": "hasret", "in": "query", "required": false, "schema": { "type": "integer", "description": "Include retweets: 1=include, 0=exclude", "default": 1, "title": "Hasret" }, "description": "Include retweets: 1=include, 0=exclude", "example": 1 }, { "name": "hastext", "in": "query", "required": false, "schema": { "type": "integer", "description": "Include text posts: 1=include, 0=exclude", "default": 1, "title": "Hastext" }, "description": "Include text posts: 1=include, 0=exclude", "example": 1 }, { "name": "haspic", "in": "query", "required": false, "schema": { "type": "integer", "description": "Include image posts: 1=include, 0=exclude", "default": 1, "title": "Haspic" }, "description": "Include image posts: 1=include, 0=exclude", "example": 1 }, { "name": "hasvideo", "in": "query", "required": false, "schema": { "type": "integer", "description": "Include video posts: 1=include, 0=exclude", "default": 1, "title": "Hasvideo" }, "description": "Include video posts: 1=include, 0=exclude", "example": 1 }, { "name": "hasmusic", "in": "query", "required": false, "schema": { "type": "integer", "description": "Include music posts: 1=include, 0=exclude", "default": 1, "title": "Hasmusic" }, "description": "Include music posts: 1=include, 0=exclude", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/web_v3/fetch_homefeed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_web_v3_fetch_homefeed", "summary": "Fetch homepage feed", "description": "Fetch homepage feed", "parameters": [ { "name": "num", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 40, "description": "Number of results, max 40", "default": 20, "title": "Num" }, "description": "Number of results, max 40", "example": 20 }, { "name": "cursor_score", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor", "default": "", "title": "Cursor Score" }, "description": "Pagination cursor" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "description": "Category channel ID", "default": "homefeed_recommend", "title": "Category" }, "description": "Category channel ID", "example": "homefeed_recommend" }, { "name": "need_filter_image", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Image notes only", "default": false, "title": "Need Filter Image" }, "description": "Image notes only" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/web_v3/fetch_homefeed_categories": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_web_v3_fetch_homefeed_categories", "summary": "Fetch homepage categories", "description": "Fetch homepage categories", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/web_v3/fetch_note_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_web_v3_fetch_note_detail", "summary": "Fetch note detail", "description": "Fetch note detail", "parameters": [ { "name": "note_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Note ID", "title": "Note Id" }, "description": "Note ID", "example": "6a2f423d000000001003cb36" }, { "name": "xsec_token", "in": "query", "required": true, "schema": { "type": "string", "description": "Security token, can be obtained from the Xiaohongshu sharing link", "title": "Xsec Token" }, "description": "Security token, can be obtained from the Xiaohongshu sharing link", "example": "ABtexB6bX5HgLD42SFrK1scGUmSO8YV5_isaLrDy9sLxQ=" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/web_v3/fetch_search_suggest": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_web_v3_fetch_search_suggest", "summary": "Fetch search suggestions", "description": "Fetch search suggestions", "parameters": [ { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string", "description": "Keyword (optional)", "default": "", "title": "Keyword" }, "description": "Keyword (optional)", "example": "Lipstick" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/web_v3/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_web_v3_fetch_user_info", "summary": "Fetch user info", "description": "Fetch user info", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "5e3a8ee700000000010070c6" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_creator_hot_inspiration_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_creator_hot_inspiration_feed", "summary": "Get creator hot inspiration feed", "description": "Get creator hot inspiration feed", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for first request", "default": "", "title": "Cursor" }, "description": "Pagination cursor, leave empty for first request", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_creator_inspiration_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_creator_inspiration_feed", "summary": "Get creator inspiration feed", "description": "Get creator inspiration feed", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for first request", "default": "", "title": "Cursor" }, "description": "Pagination cursor, leave empty for first request", "example": "" }, { "name": "tab", "in": "query", "required": false, "schema": { "type": "integer", "description": "Tab type", "default": 0, "title": "Tab" }, "description": "Tab type", "example": 0 }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "description": "Source", "default": "creator_center", "title": "Source" }, "description": "Source", "example": "creator_center" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_image_note_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_image_note_detail", "summary": "Get image note detail", "description": "Get image note detail", "parameters": [ { "name": "note_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Note ID", "default": "", "title": "Note Id" }, "description": "Note ID", "example": "697c0eee000000000a03c308" }, { "name": "share_text", "in": "query", "required": false, "schema": { "type": "string", "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "default": "", "title": "Share Text" }, "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "example": "http://xhslink.com/o/8GqargIxrko" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_note_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_note_comments", "summary": "Get note comments", "description": "Get note comments", "parameters": [ { "name": "note_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Note ID", "default": "", "title": "Note Id" }, "description": "Note ID", "example": "697c0eee000000000a03c308" }, { "name": "share_text", "in": "query", "required": false, "schema": { "type": "string", "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "default": "", "title": "Share Text" }, "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "example": "http://xhslink.com/o/8GqargIxrko" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for first request", "default": "", "title": "Cursor" }, "description": "Pagination cursor, leave empty for first request", "example": "" }, { "name": "index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Comment index, pass 0 for first request", "default": 0, "title": "Index" }, "description": "Comment index, pass 0 for first request", "example": 0 }, { "name": "pageArea", "in": "query", "required": false, "schema": { "type": "string", "description": "Fold state: UNFOLDED (default, expanded), FOLDED (collapsed)", "default": "UNFOLDED", "title": "Pagearea" }, "description": "Fold state: UNFOLDED (default, expanded), FOLDED (collapsed)", "example": "UNFOLDED" }, { "name": "sort_strategy", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort strategy: default, latest_v2, like_count", "default": "latest_v2", "title": "Sort Strategy" }, "description": "Sort strategy: default, latest_v2, like_count", "example": "latest_v2" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_note_sub_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_note_sub_comments", "summary": "Get note sub comments", "description": "Get note sub comments", "parameters": [ { "name": "note_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Note ID", "default": "", "title": "Note Id" }, "description": "Note ID", "example": "699916e6000000001d0253da" }, { "name": "share_text", "in": "query", "required": false, "schema": { "type": "string", "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "default": "", "title": "Share Text" }, "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "example": "http://xhslink.com/o/8GqargIxrko" }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Parent comment ID", "title": "Comment Id" }, "description": "Parent comment ID", "example": "699fb9930000000008030db6" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for first request, extract cursor from $.data.data.cursor for next page", "default": "", "title": "Cursor" }, "description": "Pagination cursor, leave empty for first request, extract cursor from $.data.data.cursor for next page", "example": "" }, { "name": "index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Pagination index, pass 1 for first request, extract index from $.data.data.cursor for next page", "default": 1, "title": "Index" }, "description": "Pagination index, pass 1 for first request, extract index from $.data.data.cursor for next page", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_product_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_product_detail", "summary": "Get product detail", "description": "Get product detail", "parameters": [ { "name": "sku_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Product SKU ID", "title": "Sku Id" }, "description": "Product SKU ID", "example": "669ddd44e05f3700011067ed" }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "description": "Source", "default": "mall_search", "title": "Source" }, "description": "Source", "example": "mall_search" }, { "name": "pre_page", "in": "query", "required": false, "schema": { "type": "string", "description": "Previous page", "default": "mall_search", "title": "Pre Page" }, "description": "Previous page", "example": "mall_search" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_product_recommendations": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_product_recommendations", "summary": "Get product recommendations", "description": "Get product recommendations", "parameters": [ { "name": "sku_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Product SKU ID", "title": "Sku Id" }, "description": "Product SKU ID", "example": "669ddd44e05f3700011067ed" }, { "name": "cursor_score", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for first request", "default": "", "title": "Cursor Score" }, "description": "Pagination cursor, leave empty for first request", "example": "" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region", "default": "US", "title": "Region" }, "description": "Region", "example": "US" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_product_review_overview": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_product_review_overview", "summary": "Get product review overview", "description": "Get product review overview", "parameters": [ { "name": "sku_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Product SKU ID", "title": "Sku Id" }, "description": "Product SKU ID", "example": "669ddd44e05f3700011067ed" }, { "name": "tab", "in": "query", "required": false, "schema": { "type": "integer", "description": "Tab type", "default": 2, "title": "Tab" }, "description": "Tab type", "example": 2 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_product_reviews": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_product_reviews", "summary": "Get product reviews", "description": "Get product reviews", "parameters": [ { "name": "sku_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Product SKU ID", "title": "Sku Id" }, "description": "Product SKU ID", "example": "669ddd44e05f3700011067ed" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number, start from 0", "default": 0, "title": "Page" }, "description": "Page number, start from 0", "example": 0 }, { "name": "sort_strategy_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort strategy: 0=general, 1=latest", "default": 0, "title": "Sort Strategy Type" }, "description": "Sort strategy: 0=general, 1=latest", "example": 0 }, { "name": "share_pics_only", "in": "query", "required": false, "schema": { "type": "integer", "description": "Show reviews with images only: 0=no, 1=yes", "default": 0, "title": "Share Pics Only" }, "description": "Show reviews with images only: 0=no, 1=yes", "example": 0 }, { "name": "from_page", "in": "query", "required": false, "schema": { "type": "string", "description": "From page", "default": "score_page", "title": "From Page" }, "description": "From page", "example": "score_page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_topic_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_topic_feed", "summary": "Get topic feed", "description": "Get topic feed", "parameters": [ { "name": "page_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Topic page ID", "title": "Page Id" }, "description": "Topic page ID", "example": "5c1cc866febed9000184b7c1" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort: trend=hottest, time=latest", "default": "trend", "title": "Sort" }, "description": "Sort: trend=hottest, time=latest", "example": "trend" }, { "name": "cursor_score", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor score for next page", "default": "", "title": "Cursor Score" }, "description": "Pagination cursor score for next page", "example": "" }, { "name": "last_note_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Last note ID from the previous page (required for pagination)", "default": "", "title": "Last Note Id" }, "description": "Last note ID from the previous page (required for pagination)", "example": "" }, { "name": "last_note_ct", "in": "query", "required": false, "schema": { "type": "string", "description": "Last note creation time from the previous page (required for pagination)", "default": "", "title": "Last Note Ct" }, "description": "Last note creation time from the previous page (required for pagination)", "example": "" }, { "name": "session_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Session ID; keep consistent across pages for pagination", "default": "", "title": "Session Id" }, "description": "Session ID; keep consistent across pages for pagination", "example": "" }, { "name": "first_load_time", "in": "query", "required": false, "schema": { "type": "string", "description": "First load timestamp, keep consistent for pagination", "default": "", "title": "First Load Time" }, "description": "First load timestamp, keep consistent for pagination", "example": "" }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "description": "Source", "default": "normal", "title": "Source" }, "description": "Source", "example": "normal" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_topic_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_topic_info", "summary": "Get topic info", "description": "Get topic info", "parameters": [ { "name": "page_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Topic page ID", "title": "Page Id" }, "description": "Topic page ID", "example": "5c1cc866febed9000184b7c1" }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "description": "Source", "default": "normal", "title": "Source" }, "description": "Source", "example": "normal" }, { "name": "note_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Source note ID, pass when jumping from note to topic", "default": "", "title": "Note Id" }, "description": "Source note ID, pass when jumping from note to topic", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_user_faved_notes": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_user_faved_notes", "summary": "Get user faved notes", "description": "Get user faved notes", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "default": "", "title": "User Id" }, "description": "User ID", "example": "5a8cf39111be10466d285d6b" }, { "name": "share_text", "in": "query", "required": false, "schema": { "type": "string", "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "default": "", "title": "Share Text" }, "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "example": "https://xhslink.com/a/EZ4M9TwMA6c3" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for first request, pass last note_id from previous page for next page", "default": "", "title": "Cursor" }, "description": "Pagination cursor, leave empty for first request, pass last note_id from previous page for next page", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_user_info", "summary": "Get user info", "description": "Get user info", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "default": "", "title": "User Id" }, "description": "User ID", "example": "61b46d790000000010008153" }, { "name": "share_text", "in": "query", "required": false, "schema": { "type": "string", "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "default": "", "title": "Share Text" }, "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "example": "https://xhslink.com/m/3ZSCJZAMz0a" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_user_posted_notes": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_user_posted_notes", "summary": "Get user posted notes", "description": "Get user posted notes", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "default": "", "title": "User Id" }, "description": "User ID", "example": "61b46d790000000010008153" }, { "name": "share_text", "in": "query", "required": false, "schema": { "type": "string", "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "default": "", "title": "Share Text" }, "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "example": "http://xhslink.com/o/8GqargIxrko" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, leave empty for first request", "default": "", "title": "Cursor" }, "description": "Pagination cursor, leave empty for first request", "example": "" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/get_video_note_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_get_video_note_detail", "summary": "Get video note detail", "description": "Get video note detail", "parameters": [ { "name": "note_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Note ID", "default": "", "title": "Note Id" }, "description": "Note ID", "example": "697c0eee000000000a03c308" }, { "name": "share_text", "in": "query", "required": false, "schema": { "type": "string", "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "default": "", "title": "Share Text" }, "description": "Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn", "example": "http://xhslink.com/o/8GqargIxrko" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/search_groups": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_search_groups", "summary": "Search groups", "description": "Search groups", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "Shanghai" }, { "name": "page_no", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number, start from 0", "default": 0, "title": "Page No" }, "description": "Page number, start from 0", "example": 0 }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search ID for pagination", "default": "", "title": "Search Id" }, "description": "Search ID for pagination", "example": "" }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "description": "Source", "default": "unifiedSearchGroup", "title": "Source" }, "description": "Source", "example": "unifiedSearchGroup" }, { "name": "is_recommend", "in": "query", "required": false, "schema": { "type": "integer", "description": "Is recommended: 0=no, 1=yes", "default": 0, "title": "Is Recommend" }, "description": "Is recommended: 0=no, 1=yes", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/search_images": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_search_images", "summary": "Search images", "description": "Search images", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "Wallpaper" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number, start from 1", "default": 1, "title": "Page" }, "description": "Page number, start from 1", "example": 1 }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search ID for pagination", "default": "", "title": "Search Id" }, "description": "Search ID for pagination", "example": "" }, { "name": "search_session_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search session ID for pagination", "default": "", "title": "Search Session Id" }, "description": "Search session ID for pagination", "example": "" }, { "name": "word_request_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Word request ID for pagination", "default": "", "title": "Word Request Id" }, "description": "Word request ID for pagination", "example": "" }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "description": "Source", "default": "explore_feed", "title": "Source" }, "description": "Source", "example": "explore_feed" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/search_notes": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_search_notes", "summary": "Search notes", "description": "Search notes", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "Food Recommendations" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number, start from 1", "default": 1, "title": "Page" }, "description": "Page number, start from 1", "example": 1 }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort type", "default": "general", "title": "Sort Type" }, "description": "Sort type", "example": "general" }, { "name": "note_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Note type: Unlimited, Video note, Standard note, Live note", "default": "No filter", "title": "Note Type" }, "description": "Note type: Unlimited, Video note, Standard note, Live note", "example": "No filter" }, { "name": "time_filter", "in": "query", "required": false, "schema": { "type": "string", "description": "Publish time filter: Unlimited, Within 1 day, Within 1 week, Within 6 months", "default": "No filter", "title": "Time Filter" }, "description": "Publish time filter: Unlimited, Within 1 day, Within 1 week, Within 6 months", "example": "No filter" }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search ID for pagination", "default": "", "title": "Search Id" }, "description": "Search ID for pagination", "example": "" }, { "name": "search_session_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search session ID for pagination", "default": "", "title": "Search Session Id" }, "description": "Search session ID for pagination", "example": "" }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "description": "Source", "default": "explore_feed", "title": "Source" }, "description": "Source", "example": "explore_feed" }, { "name": "ai_mode", "in": "query", "required": false, "schema": { "type": "integer", "description": "AI mode: 0=off, 1=on", "default": 0, "title": "Ai Mode" }, "description": "AI mode: 0=off, 1=on", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/search_products": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_search_products", "summary": "Search products", "description": "Search products", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "Phone case" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number, start from 1", "default": 1, "title": "Page" }, "description": "Page number, start from 1", "example": 1 }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search ID for pagination", "default": "", "title": "Search Id" }, "description": "Search ID for pagination", "example": "" }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "description": "Source", "default": "explore_feed", "title": "Source" }, "description": "Source", "example": "explore_feed" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/app_v2/search_users": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "get_tikhub_xiaohongshu_app_v2_search_users", "summary": "Search users", "description": "Search users", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "Food Blogger" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number, start from 1", "default": 1, "title": "Page" }, "description": "Page number, start from 1", "example": 1 }, { "name": "search_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search ID for pagination", "default": "", "title": "Search Id" }, "description": "Search ID for pagination", "example": "" }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "description": "Source", "default": "explore_feed", "title": "Source" }, "description": "Source", "example": "explore_feed" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_ai_search_stream": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_ai_search_stream", "summary": "Get Zhihu AI Search (v2)", "description": "Get Zhihu AI Search (v2)", "parameters": [ { "name": "message_content", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Content", "title": "Message Content" }, "description": "Search Content" }, { "name": "chat_mode", "in": "query", "required": false, "schema": { "type": "string", "description": "Chat mode", "default": "FAST", "title": "Chat Mode" }, "description": "Chat mode" }, { "name": "session_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Session ID", "default": "", "title": "Session Id" }, "description": "Session ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_answer_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_answer_detail", "summary": "Get Zhihu Answer Detail", "description": "Get Zhihu Answer Detail", "parameters": [ { "name": "answer_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Answer ID", "title": "Answer Id" }, "description": "Answer ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_article_search_v3": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_article_search_v3", "summary": "Get Zhihu Article Search V3", "description": "Get Zhihu Article Search V3", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keywords", "title": "Keyword" }, "description": "Search Keywords" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of articles per page", "default": "20", "title": "Limit" }, "description": "Number of articles per page" }, { "name": "show_all_topics", "in": "query", "required": false, "schema": { "type": "integer", "description": "Show all topics", "default": 0, "title": "Show All Topics" }, "description": "Show all topics" }, { "name": "search_source", "in": "query", "required": false, "schema": { "type": "string", "description": "Search Source", "default": "Normal", "title": "Search Source" }, "description": "Search Source" }, { "name": "search_hash_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search Hash ID", "default": "", "title": "Search Hash Id" }, "description": "Search Hash ID" }, { "name": "vertical", "in": "query", "required": false, "schema": { "type": "string", "description": "Vertical type", "default": "", "title": "Vertical" }, "description": "Vertical type" }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort", "default": "", "title": "Sort" }, "description": "Sort" }, { "name": "time_interval", "in": "query", "required": false, "schema": { "type": "string", "description": "Time Interval", "default": "", "title": "Time Interval" }, "description": "Time Interval" }, { "name": "vertical_info", "in": "query", "required": false, "schema": { "type": "string", "description": "Vertical info", "default": "", "title": "Vertical Info" }, "description": "Vertical info" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_column_article_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_column_article_detail", "summary": "Get Zhihu Column Article Detail", "description": "Get Zhihu Column Article Detail", "parameters": [ { "name": "article_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Article ID", "title": "Article Id" }, "description": "Article ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_column_articles": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_column_articles", "summary": "Get Zhihu Column Articles", "description": "Get Zhihu Column Articles", "parameters": [ { "name": "column_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Column ID", "title": "Column Id" }, "description": "Column ID" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of articles per page", "default": "10", "title": "Limit" }, "description": "Number of articles per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_column_comment_config": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_column_comment_config", "summary": "Get Zhihu Column Comment Config", "description": "Get Zhihu Column Comment Config", "parameters": [ { "name": "article_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Article ID", "title": "Article Id" }, "description": "Article ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_column_recommend": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_column_recommend", "summary": "Get Zhihu Similar Column Recommend", "description": "Get Zhihu Similar Column Recommend", "parameters": [ { "name": "article_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Article ID", "title": "Article Id" }, "description": "Article ID" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of columns per page", "default": "12", "title": "Limit" }, "description": "Number of columns per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_column_relationship": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_column_relationship", "summary": "Get Zhihu Column Article Relationship", "description": "Get Zhihu Column Article Relationship", "parameters": [ { "name": "article_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Article ID", "title": "Article Id" }, "description": "Article ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_column_search_v3": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_column_search_v3", "summary": "Get Zhihu Column Search V3", "description": "Get Zhihu Column Search V3", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keywords", "title": "Keyword" }, "description": "Search Keywords" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of columns per page", "default": "20", "title": "Limit" }, "description": "Number of columns per page" }, { "name": "search_hash_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search Hash ID", "default": "", "title": "Search Hash Id" }, "description": "Search Hash ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_comment_v5": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_comment_v5", "summary": "Get Zhihu Comment V5", "description": "Get Zhihu Comment V5", "parameters": [ { "name": "answer_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Answer ID", "title": "Answer Id" }, "description": "Answer ID" }, { "name": "order_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort", "default": "score", "title": "Order By" }, "description": "Sort" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of comments per page", "default": "20", "title": "Limit" }, "description": "Number of comments per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "", "title": "Offset" }, "description": "Offset" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_ebook_search_v3": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_ebook_search_v3", "summary": "Get Zhihu Ebook Search V3", "description": "Get Zhihu Ebook Search V3", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keywords", "title": "Keyword" }, "description": "Search Keywords" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of ebooks per page", "default": "20", "title": "Limit" }, "description": "Number of ebooks per page" }, { "name": "search_hash_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search Hash ID", "default": "", "title": "Search Hash Id" }, "description": "Search Hash ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_hot_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_hot_list", "summary": "Get Zhihu Hot List", "description": "Get Zhihu Hot List", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of articles per page", "default": "50", "title": "Limit" }, "description": "Number of articles per page" }, { "name": "desktop", "in": "query", "required": false, "schema": { "type": "string", "description": "Is it a desktop", "default": "true", "title": "Desktop" }, "description": "Is it a desktop" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_hot_recommend": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_hot_recommend", "summary": "Get Zhihu Hot Recommend", "description": "Get Zhihu Hot Recommend", "parameters": [ { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "page_number", "in": "query", "required": false, "schema": { "type": "string", "description": "Page Number", "default": "1", "title": "Page Number" }, "description": "Page Number" }, { "name": "session_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Session Token", "default": "", "title": "Session Token" }, "description": "Session Token" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_pin_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_pin_comments", "summary": "Get Zhihu Pin Comments", "description": "Get Zhihu Pin Comments", "parameters": [ { "name": "pin_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Pin ID", "title": "Pin Id" }, "description": "Pin ID" }, { "name": "order_by", "in": "query", "required": false, "schema": { "enum": [ "score", "ts" ], "type": "string", "description": "Sort: score=default, ts=newest", "default": "score", "title": "Order By" }, "description": "Sort: score=default, ts=newest" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of comments per page", "default": "20", "title": "Limit" }, "description": "Number of comments per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset from response cursor (for pagination)", "default": "", "title": "Offset" }, "description": "Offset from response cursor (for pagination)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_pin_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_pin_detail", "summary": "Get Zhihu Pin Detail", "description": "Get Zhihu Pin Detail", "parameters": [ { "name": "pin_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Pin ID", "title": "Pin Id" }, "description": "Pin ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_preset_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_preset_search", "summary": "Get Zhihu Preset Search", "description": "Get Zhihu Preset Search", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_question_answers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_question_answers", "summary": "Get Zhihu Question Answers", "description": "Get Zhihu Question Answers", "parameters": [ { "name": "question_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Question ID", "title": "Question Id" }, "description": "Question ID" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor", "default": "", "title": "Cursor" }, "description": "Pagination cursor" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of answers per page", "default": 5, "title": "Limit" }, "description": "Number of answers per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset" }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort order: default=default sort, updated=sort by time", "default": "default", "title": "Order" }, "description": "Sort order: default=default sort, updated=sort by time" }, { "name": "session_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Session ID", "default": "", "title": "Session Id" }, "description": "Session ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_question_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_question_detail", "summary": "Get Zhihu Question Detail", "description": "Get Zhihu Question Detail", "parameters": [ { "name": "question_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Question ID", "title": "Question Id" }, "description": "Question ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_recommend_followees": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_recommend_followees", "summary": "Get Zhihu Recommend Followees", "description": "Get Zhihu Recommend Followees", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_salt_search_v3": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_salt_search_v3", "summary": "Get Zhihu Salt Search V3", "description": "Get Zhihu Salt Search V3", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keywords", "title": "Keyword" }, "description": "Search Keywords" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of contents per page", "default": "20", "title": "Limit" }, "description": "Number of contents per page" }, { "name": "search_hash_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search Hash ID", "default": "", "title": "Search Hash Id" }, "description": "Search Hash ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_scholar_search_v3": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "post_tikhub_zhihu_web_fetch_scholar_search_v3", "summary": "Get Zhihu Scholar Search V3", "description": "Get Zhihu Scholar Search V3", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keywords", "title": "Keyword" }, "description": "Search Keywords" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of papers per page", "default": "25", "title": "Limit" }, "description": "Number of papers per page" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Filter Fields", "default": { "advanced_filter": "keywords,title,authors,abstract", "indexed_by": "", "classification": "" }, "title": "Filter Fields" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_search_recommend": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_search_recommend", "summary": "Get Zhihu Search Recommend", "description": "Get Zhihu Search Recommend", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_search_suggest": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_search_suggest", "summary": "Get Zhihu Search Suggest", "description": "Get Zhihu Search Suggest", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keywords", "title": "Keyword" }, "description": "Search Keywords" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_sub_comment_v5": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_sub_comment_v5", "summary": "Get Zhihu Sub Comment V5", "description": "Get Zhihu Sub Comment V5", "parameters": [ { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Comment ID", "title": "Comment Id" }, "description": "Comment ID" }, { "name": "order_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort", "default": "score", "title": "Order By" }, "description": "Sort" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of comments per page", "default": "20", "title": "Limit" }, "description": "Number of comments per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "", "title": "Offset" }, "description": "Offset" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_topic_search_v3": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_topic_search_v3", "summary": "Get Zhihu Topic Search V3", "description": "Get Zhihu Topic Search V3", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keywords", "title": "Keyword" }, "description": "Search Keywords" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of topics per page", "default": "25", "title": "Limit" }, "description": "Number of topics per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_answers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_answers", "summary": "Get Zhihu User Answers", "description": "Get Zhihu User Answers", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of answers per page", "default": "20", "title": "Limit" }, "description": "Number of answers per page" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "enum": [ "created", "voteups" ], "type": "string", "description": "Sort Type", "default": "created", "title": "Sort Type" }, "description": "Sort Type" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/zhihu/web/fetch_user_articles": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_articles", "summary": "Get Zhihu User Articles", "description": "Get Zhihu User Articles", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of articles per page", "default": "20", "title": "Limit" }, "description": "Number of articles per page" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "enum": [ "created", "voteups" ], "type": "string", "description": "Sort Type", "default": "created", "title": "Sort Type" }, "description": "Sort Type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_collections": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_collections", "summary": "Get Zhihu User Created Collections", "description": "Get Zhihu User Created Collections", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of collections per page", "default": "20", "title": "Limit" }, "description": "Number of collections per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_follow_collections": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_follow_collections", "summary": "Get Zhihu User Follow Collections", "description": "Get Zhihu User Follow Collections", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of collections per page", "default": "20", "title": "Limit" }, "description": "Number of collections per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_follow_columns": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_follow_columns", "summary": "Get Zhihu User Columns", "description": "Get Zhihu User Columns", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of columns per page", "default": "20", "title": "Limit" }, "description": "Number of columns per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_follow_questions": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_follow_questions", "summary": "Get Zhihu User Follow Questions", "description": "Get Zhihu User Follow Questions", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of questions per page", "default": "20", "title": "Limit" }, "description": "Number of questions per page" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/zhihu/web/fetch_user_follow_topics": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_follow_topics", "summary": "Get Zhihu User Follow Topics", "description": "Get Zhihu User Follow Topics", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of topics per page", "default": "20", "title": "Limit" }, "description": "Number of topics per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_followees": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_followees", "summary": "Get Zhihu User Following", "description": "Get Zhihu User Following", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of users per page", "default": "20", "title": "Limit" }, "description": "Number of users per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_followers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_followers", "summary": "Get Zhihu User Followers", "description": "Get Zhihu User Followers", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of users per page", "default": "20", "title": "Limit" }, "description": "Number of users per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_included_articles": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_included_articles", "summary": "Get Zhihu User Included Articles", "description": "Get Zhihu User Included Articles", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of articles per page", "default": "20", "title": "Limit" }, "description": "Number of articles per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_info", "summary": "Get Zhihu User Info", "description": "Get Zhihu User Info", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_pins": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_pins", "summary": "Get Zhihu User Pins", "description": "Get Zhihu User Pins", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Url Token" }, "description": "User ID" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of pins per page", "default": "20", "title": "Limit" }, "description": "Number of pins per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_search_v3": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_search_v3", "summary": "Get Zhihu User Search V3", "description": "Get Zhihu User Search V3", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keywords", "title": "Keyword" }, "description": "Search Keywords" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of users per page", "default": "25", "title": "Limit" }, "description": "Number of users per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_user_segments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_user_segments", "summary": "Get Zhihu User Segments", "description": "Get Zhihu User Segments", "parameters": [ { "name": "user_url_token", "in": "query", "required": true, "schema": { "type": "string", "description": "User member hash id (not url_token)", "title": "User Url Token" }, "description": "User member hash id (not url_token)" }, { "name": "content_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Content type", "default": "all", "title": "Content Type" }, "description": "Content type" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number per page", "default": "20", "title": "Limit" }, "description": "Number per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_video_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_video_list", "summary": "Get Zhihu Video List", "description": "Get Zhihu Video List", "parameters": [ { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of videos per page", "default": "12", "title": "Limit" }, "description": "Number of videos per page" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/zhihu/web/fetch_video_search_v3": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Zhihu" ], "operationId": "get_tikhub_zhihu_web_fetch_video_search_v3", "summary": "Get Zhihu Video Search V3", "description": "Get Zhihu Video Search V3", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keywords", "title": "Keyword" }, "description": "Search Keywords" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "description": "Number of videos per page", "default": "20", "title": "Limit" }, "description": "Number of videos per page" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Offset", "default": "0", "title": "Offset" }, "description": "Offset" }, { "name": "search_hash_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Search Hash ID", "default": "", "title": "Search Hash Id" }, "description": "Search Hash ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/account_session_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_account_session_info", "summary": "Get current advertiser account information", "description": "Get current advertiser account information", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/cooperate_experience_industry": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_cooperate_experience_industry", "summary": "Get collaboration-experience industries", "description": "Get collaboration-experience industries", "parameters": [ { "name": "industry_type", "in": "query", "required": true, "schema": { "type": "integer", "description": "Industry index: 1=Gaming, 2=Daily Chemicals/Small Appliances, 3=Consumer Electronics, 4=Automotive, 5=Food & Beverage, 6=Online Services", "title": "Industry Type" }, "description": "Industry index: 1=Gaming, 2=Daily Chemicals/Small Appliances, 3=Consumer Electronics, 4=Automotive, 5=Food & Beverage, 6=Online Services" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/dmp_pkg_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_dmp_pkg_list", "summary": "Get audience packages", "description": "Get audience packages", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/bilibili/huahuo/effect_goods_drop": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_effect_goods_drop", "summary": "Get commerce category options", "description": "Get commerce category options", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/industry_tags": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_industry_tags", "summary": "Get industry tags", "description": "Get industry tags", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/label_char_style": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_label_char_style", "summary": "Get content-style tags", "description": "Get content-style tags", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/live_area_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_live_area_list", "summary": "Get live-streaming areas", "description": "Get live-streaming areas", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/live_commerce_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_live_commerce_info", "summary": "Get live-commerce performance", "description": "Get live-commerce performance", "parameters": [ { "name": "upper_mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Upper Mid" }, "description": "Creator UID" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/bilibili/huahuo/live_good_category": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_live_good_category", "summary": "Get live-commerce categories", "description": "Get live-commerce categories", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/live_guild_drop": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_live_guild_drop", "summary": "Get live-streaming guilds", "description": "Get live-streaming guilds", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Fuzzy filter by name; empty=all", "default": "", "title": "Name" }, "description": "Fuzzy filter by name; empty=all" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/live_parent_tag": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_live_parent_tag", "summary": "Get live creator persona tags", "description": "Get live creator persona tags", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/live_upper_portrait": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_live_upper_portrait", "summary": "Get live creator profile", "description": "Get live creator profile", "parameters": [ { "name": "mcn_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "MCN organization ID, obtainable from marketplace search results or upper_base_info", "title": "Mcn Id" }, "description": "MCN organization ID, obtainable from marketplace search results or upper_base_info" }, { "name": "upper_mid", "in": "query", "required": false, "schema": { "description": "Creator UID (optional)", "title": "Upper Mid", "nullable": true, "type": "integer" }, "description": "Creator UID (optional)" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/bilibili/huahuo/mcn_drop": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_mcn_drop", "summary": "Get MCN organizations", "description": "Get MCN organizations", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Fuzzy filter by name; empty=all", "default": "", "title": "Name" }, "description": "Fuzzy filter by name; empty=all" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/partition_drop": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_partition_drop", "summary": "Get video partition options", "description": "Get video partition options", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/popular_avid_category_drop": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_popular_avid_category_drop", "summary": "Get video ranking industries", "description": "Get video ranking industries", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/popular_avid_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_popular_avid_list", "summary": "Get Huahuo video rankings", "description": "Get Huahuo video rankings", "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "description": "Industry name; valid values from popular_avid_category_drop, empty=all", "default": "", "title": "Category" }, "description": "Industry name; valid values from popular_avid_category_drop, empty=all" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/popular_goods_industry_up_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_popular_goods_industry_up_list", "summary": "Get commerce creators by industry", "description": "Get commerce creators by industry", "parameters": [ { "name": "x_huo_industry_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Industry ID; valid values from x_huo_industry_drop?scene=2", "title": "X Huo Industry Id" }, "description": "Industry ID; valid values from x_huo_industry_drop?scene=2" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/popular_goods_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_popular_goods_list", "summary": "Get X-Huo product rankings", "description": "Get X-Huo product rankings", "parameters": [ { "name": "x_huo_industry_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Industry ID; valid values from x_huo_industry_drop?scene=2", "title": "X Huo Industry Id" }, "description": "Industry ID; valid values from x_huo_industry_drop?scene=2" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "rank_type", "in": "query", "required": false, "schema": { "description": "Ranking scope", "title": "Rank Type", "nullable": true, "type": "integer" }, "description": "Ranking scope" }, { "name": "data_cycle", "in": "query", "required": false, "schema": { "description": "Data period", "title": "Data Cycle", "nullable": true, "type": "integer" }, "description": "Data period" }, { "name": "min_goods_price", "in": "query", "required": false, "schema": { "description": "Minimum product price", "title": "Min Goods Price", "nullable": true, "type": "integer" }, "description": "Minimum product price" }, { "name": "max_goods_price", "in": "query", "required": false, "schema": { "description": "Maximum product price", "title": "Max Goods Price", "nullable": true, "type": "integer" }, "description": "Maximum product price" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/popular_goods_up_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_popular_goods_up_list", "summary": "Get creators ranked for a product", "description": "Get creators ranked for a product", "parameters": [ { "name": "goods_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Product ID, see popular_goods_list for values", "title": "Goods Id" }, "description": "Product ID, see popular_goods_list for values" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/popular_up_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_popular_up_list", "summary": "Get creator rankings", "description": "Get creator rankings", "parameters": [ { "name": "rank_cate", "in": "query", "required": false, "schema": { "type": "integer", "description": "Ranking type: 1=Rising Stars, 2=Best Value Picks, 3=Top Must-haves", "default": 3, "title": "Rank Cate" }, "description": "Ranking type: 1=Rising Stars, 2=Best Value Picks, 3=Top Must-haves" }, { "name": "tid_name", "in": "query", "required": false, "schema": { "type": "string", "description": "Ranking section name; see popular_up_tid_drop for values; leave empty for all", "default": "", "title": "Tid Name" }, "description": "Ranking section name; see popular_up_tid_drop for values; leave empty for all" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/popular_up_tid_drop": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_popular_up_tid_drop", "summary": "Get creator ranking categories", "description": "Get creator ranking categories", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/popular_up_x_huo": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_popular_up_x_huo", "summary": "Get X-Huo creator rankings", "description": "Get X-Huo creator rankings", "parameters": [ { "name": "x_huo_industry_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Industry ID; valid values from x_huo_industry_drop", "title": "X Huo Industry Id" }, "description": "Industry ID; valid values from x_huo_industry_drop" }, { "name": "rank_date_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Ranking period: 1=Monthly, 2=Quarterly", "default": 1, "title": "Rank Date Type" }, "description": "Ranking period: 1=Monthly, 2=Quarterly" }, { "name": "rank_date", "in": "query", "required": false, "schema": { "description": "Ranking issue `YYYY-MM`; see x_huo_date_options for values; leave empty for the latest issue", "title": "Rank Date", "nullable": true, "type": "string" }, "description": "Ranking issue `YYYY-MM`; see x_huo_date_options for values; leave empty for the latest issue" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/region_drop": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_region_drop", "summary": "Get region options", "description": "Get region options", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/search_live_upper": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "post_tikhub_bilibili_huahuo_search_live_upper", "summary": "Search live creators", "description": "Search live creators", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSearchBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/search_upper": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "post_tikhub_bilibili_huahuo_search_upper", "summary": "Search Huahuo creators or content", "description": "Search Huahuo creators or content", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpperSearchBody" }, "examples": { "content_type_single": { "summary": "Single content type", "description": "Select Outdoor Travel > Outdoor Adventure (upper_label_tree value=794).", "value": { "label_array": [ [ 794 ] ], "page": 1 } }, "content_type_multiple": { "summary": "Multiple content types", "description": "Select Outdoor Adventure (794), AI Short Film (747), and AI Funny Video (748) simultaneously; all values are in the same inner array.", "value": { "label_array": [ [ 794, 747, 748 ] ], "page": 1 } }, "cooperation_pricing_deep_custom": { "summary": "Deep-custom pricing", "description": "Over 100,000 RMB; includes licensed derivative creation/distribution, complimentary trailer, and custom content; creation skills selected: overseas filming, in-depth technical analysis, short film/micro-movie.", "value": { "price_info": [ { "cooperation_type": 22, "creative_skill": [ 1, 2, 3 ], "include_content": [ 1, 2, 3 ], "price_min": 100000, "price_max": "", "price_right": [] } ], "page": 1 } }, "cooperation_pricing_embedded_video": { "summary": "Embedded-video pricing", "description": "Embedded-video pricing 100,000 RMB or above; pass empty arrays for unavailable creative skills and included content.", "value": { "price_info": [ { "cooperation_type": 1, "creative_skill": [], "include_content": [], "price_min": 100000, "price_max": "", "price_right": [] } ], "page": 1 } }, "cooperation_pricing_custom_podcast": { "summary": "Custom-podcast pricing", "description": "Custom podcast series, starting at 100,000 CNY, including licensing for derivative content/distribution.", "value": { "price_info": [ { "cooperation_type": 23, "creative_skill": [], "include_content": [ 1 ], "price_min": 100000, "price_max": "", "price_right": [] } ], "page": 1 } }, "cooperation_pricing_direct_post": { "summary": "Direct-post pricing", "description": "Direct-post pricing 100,000 RMB or above; pass empty arrays for unavailable array fields.", "value": { "price_info": [ { "cooperation_type": 3, "creative_skill": [], "include_content": [], "price_min": 100000, "price_max": "", "price_right": [] } ], "page": 1 } }, "cooperation_experience_real_estate": { "summary": "Real-estate cooperation experience", "description": "Cooperation count set to \"Has cooperation experience\", cooperation industry set to \"Real Estate / All\".", "value": { "panel_type": 0, "spark_tag": [ "cooperate" ], "huahuo_first_industry_ids": [ "388" ], "huahuo_second_industry_ids": [ "389", "393", "399", "401", "403" ], "huahuo_third_industry_ids": [ "390", "394", "395", "396", "398", "400", "402", "404" ], "page": 1 } }, "cooperation_experience_multiple_industries": { "summary": "Extensive multi-industry experience", "description": "Cooperation count set to \"Extensive experience\", with all selected industry IDs for Real Estate, Furniture, and Bathroom Products passed hierarchically.", "value": { "panel_type": 0, "spark_tag": [ "coo_frequent" ], "huahuo_first_industry_ids": [ "388", "405" ], "huahuo_second_industry_ids": [ "389", "393", "399", "401", "403", "406", "411" ], "huahuo_third_industry_ids": [ "390", "394", "395", "396", "398", "400", "402", "404", "407", "408", "409", "410", "413" ], "page": 1 } }, "cooperation_experience_multiple_industries_experienced": { "summary": "Multiple-industry cooperation experience", "description": "Cooperation count set to \"Has cooperation experience\", with all selected industry IDs for Real Estate, Furniture, and Bathroom Products passed hierarchically.", "value": { "panel_type": 0, "spark_tag": [ "cooperate" ], "huahuo_first_industry_ids": [ "388", "405" ], "huahuo_second_industry_ids": [ "389", "393", "399", "401", "403", "406", "411" ], "huahuo_third_industry_ids": [ "390", "394", "395", "396", "398", "400", "402", "404", "407", "408", "409", "410", "413" ], "page": 1 } }, "residence_regions_multiple": { "summary": "Multiple residence regions", "description": "Select Beijing (4), Shanghai (5), Fujian (23), and within Fujian: Xiamen (51) and Fuzhou (50).", "value": { "region_id": [ 4, 5, 23 ], "second_region_id": [ 51, 50 ], "page": 1 } }, "median_views": { "summary": "Median views", "description": "300,000 to 500,000, organic traffic scope, last 15 days; pass range as a string.", "value": { "min_play_median": "300000", "max_play_median": "500000", "play_median_traffic_type": 2, "play_median_cycle": 2, "page": 1 } }, "median_views_default_scope": { "summary": "Median views from 500K to 1M", "description": "500,000 to 1,000,000, all traffic scope, last 30 days; pass range as a string.", "value": { "min_play_median": "500000", "max_play_median": "1000000", "play_median_traffic_type": 1, "play_median_cycle": 3, "page": 1 } }, "video_honors_multiple": { "summary": "Multiple video honors", "description": "Hot or site-wide chart honor awarded twice in the last 90 days.", "value": { "av_honor": { "honor_type": [ "HOT", "QZPHB" ], "time_period": 90, "honor_count": 2 }, "page": 1 } }, "video_honors_single": { "summary": "Single video honor", "description": "Hot honor awarded once in the last 30 days.", "value": { "av_honor": { "honor_type": [ "HOT" ], "time_period": 30, "honor_count": 1 }, "page": 1 } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/search_upper_suggest": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_search_upper_suggest", "summary": "Search creator suggestions", "description": "Search creator suggestions", "parameters": [ { "name": "nickname_or_mids", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator nickname fragment or UID", "title": "Nickname Or Mids" }, "description": "Creator nickname fragment or UID" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "One-based page number", "default": 1, "title": "Page" }, "description": "One-based page number" }, { "name": "panel_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Industry strategy panel; values match search_upper", "default": 0, "title": "Panel Type" }, "description": "Industry strategy panel; values match search_upper" }, { "name": "marketing_target", "in": "query", "required": false, "schema": { "type": "integer", "description": "Marketing objective; values match search_upper", "default": 1, "title": "Marketing Target" }, "description": "Marketing objective; values match search_upper" }, { "name": "cpm_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "CPM traffic scope: 1=all, 2=organic", "default": 1, "title": "Cpm Type" }, "description": "CPM traffic scope: 1=all, 2=organic" }, { "name": "cpm_cycle", "in": "query", "required": false, "schema": { "type": "integer", "description": "CPM window: 1=7, 2=15, 3=30 days", "default": 3, "title": "Cpm Cycle" }, "description": "CPM window: 1=7, 2=15, 3=30 days" }, { "name": "play_median_traffic_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Median-view traffic scope: 1=all, 2=organic", "default": 1, "title": "Play Median Traffic Type" }, "description": "Median-view traffic scope: 1=all, 2=organic" }, { "name": "play_median_cycle", "in": "query", "required": false, "schema": { "type": "integer", "description": "Median-view window: 1=7, 2=15, 3=30 days", "default": 3, "title": "Play Median Cycle" }, "description": "Median-view window: 1=7, 2=15, 3=30 days" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/square_static_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_square_static_info", "summary": "Get creator marketplace filter dictionaries", "description": "Get creator marketplace filter dictionaries", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/tag_character": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_tag_character", "summary": "Get persona tags", "description": "Get persona tags", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/tag_commercial": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_tag_commercial", "summary": "Get commercial tags", "description": "Get commercial tags", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/tag_occupation": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_tag_occupation", "summary": "Get occupation tags", "description": "Get occupation tags", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_archive_highlights": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_archive_highlights", "summary": "Get creator video highlights", "description": "Get creator video highlights", "parameters": [ { "name": "upper_mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Upper Mid" }, "description": "Creator UID" }, { "name": "day_range", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time period: 1=last 30 days, 2=last 90 days, 3=last 180 days", "default": 3, "title": "Day Range" }, "description": "Time period: 1=last 30 days, 2=last 90 days, 3=last 180 days" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/bilibili/huahuo/upper_base_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_base_info", "summary": "Get creator basic information", "description": "Get creator basic information", "parameters": [ { "name": "mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Mid" }, "description": "Creator UID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_busy_time": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_busy_time", "summary": "Get creator unavailable dates", "description": "Get creator unavailable dates", "parameters": [ { "name": "mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Mid" }, "description": "Creator UID" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/bilibili/huahuo/upper_by_nickname": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_by_nickname", "summary": "Find creators by nickname", "description": "Find creators by nickname", "parameters": [ { "name": "nickname", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator nickname", "title": "Nickname" }, "description": "Creator nickname" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_detail", "summary": "Get creator profile", "description": "Get creator profile", "parameters": [ { "name": "upper_mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Upper Mid" }, "description": "Creator UID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_draft_performance": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_draft_performance", "summary": "Get creator video performance", "description": "Get creator video performance", "parameters": [ { "name": "upper_mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Upper Mid" }, "description": "Creator UID" }, { "name": "day_range", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time period: 1=last 30 days, 2=last 90 days, 3=last 180 days", "default": 3, "title": "Day Range" }, "description": "Time period: 1=last 30 days, 2=last 90 days, 3=last 180 days" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_draft_trend": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_draft_trend", "summary": "Get creator video metric trends", "description": "Get creator video metric trends", "parameters": [ { "name": "upper_mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Upper Mid" }, "description": "Creator UID" }, { "name": "trend_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Metric: 3=Views, 4=Likes, 5=Comments, 6=Bullet comments, 7=Watch duration", "default": 3, "title": "Trend Type" }, "description": "Metric: 3=Views, 4=Likes, 5=Comments, 6=Bullet comments, 7=Watch duration" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_fans_trend": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_fans_trend", "summary": "Get creator follower trends", "description": "Get creator follower trends", "parameters": [ { "name": "upper_mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Upper Mid" }, "description": "Creator UID" }, { "name": "query_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Metric scope: 1=Total, 2=Incremental", "default": 1, "title": "Query Type" }, "description": "Metric scope: 1=Total, 2=Incremental" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_label_tree": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_label_tree", "summary": "Get creator filter panel configuration", "description": "Get creator filter panel configuration", "parameters": [ { "name": "panel_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Strategy panel: 0=general, 1=gaming, 2=beauty, 3=digital, 4=automotive, 5=performance, 6=food, 8=internet", "default": 0, "title": "Panel Type" }, "description": "Strategy panel: 0=general, 1=gaming, 2=beauty, 3=digital, 4=automotive, 5=performance, 6=food, 8=internet" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_overlap_uppers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_overlap_uppers", "summary": "Get creators with overlapping audiences", "description": "Get creators with overlapping audiences", "parameters": [ { "name": "upper_mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Upper Mid" }, "description": "Creator UID" }, { "name": "fans_range", "in": "query", "required": false, "schema": { "type": "string", "description": "Follower count tier: 9=2M+, 8=1M-2M, 7=500K-1M, 6=300K-500K, 5=200K-300K, 4=100K-200K, 3=50K-100K, 2=10K-50K", "default": "6", "title": "Fans Range" }, "description": "Follower count tier: 9=2M+, 8=1M-2M, 7=500K-1M, 6=300K-500K, 5=200K-300K, 4=100K-200K, 3=50K-100K, 2=10K-50K" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_representative": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_representative", "summary": "Get creator representative videos", "description": "Get creator representative videos", "parameters": [ { "name": "upper_mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Upper Mid" }, "description": "Creator UID" }, { "name": "type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Post type: 1=personal post, 2=commercial post", "default": 2, "title": "Type" }, "description": "Post type: 1=personal post, 2=commercial post" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_seek_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_seek_info", "summary": "Get creator inquiry settings", "description": "Get creator inquiry settings", "parameters": [ { "name": "mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Mid" }, "description": "Creator UID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/upper_similar": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_upper_similar", "summary": "Get creators with similar content", "description": "Get creators with similar content", "parameters": [ { "name": "upper_mid", "in": "query", "required": true, "schema": { "type": "integer", "description": "Creator UID", "title": "Upper Mid" }, "description": "Creator UID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/x_huo_date_options": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_x_huo_date_options", "summary": "Get X-Huo ranking periods", "description": "Get X-Huo ranking periods", "parameters": [ { "name": "rank_date_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Ranking period: 1=Monthly, 2=Quarterly", "default": 1, "title": "Rank Date Type" }, "description": "Ranking period: 1=Monthly, 2=Quarterly" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/bilibili/huahuo/x_huo_industry_drop": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0087, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_huahuo_x_huo_industry_drop", "summary": "Get X-Huo ranking industries", "description": "Get X-Huo ranking industries", "parameters": [ { "name": "scene", "in": "query", "required": false, "schema": { "type": "integer", "description": "Scene: 1=Creator ranking, 2=Product ranking", "default": 1, "title": "Scene" }, "description": "Scene: 1=Creator ranking, 2=Product ranking" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_city_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_city_list", "summary": "Fetch Chinese city list", "description": "Fetch Chinese city list", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_content_tag": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_content_tag", "summary": "Fetch vertical content tags", "description": "Fetch vertical content tags", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_account_fans_interest_account_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_account_fans_interest_account_list", "summary": "Fetch fan interest author 20 users", "description": "Fetch fan interest author 20 users", "parameters": [ { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_id", "title": "Sec Uid" }, "description": "User sec_id", "example": "MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/billboard/fetch_hot_account_fans_interest_search_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_account_fans_interest_search_list", "summary": "Fetch fan interest search term in the last 3 days 10 search terms", "description": "Fetch fan interest search term in the last 3 days 10 search terms", "parameters": [ { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_id", "title": "Sec Uid" }, "description": "User sec_id", "example": "MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/billboard/fetch_hot_account_fans_interest_topic_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_account_fans_interest_topic_list", "summary": "Fetch fan interest topic in the last 3 days 10 topics", "description": "Fetch fan interest topic in the last 3 days 10 topics", "parameters": [ { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_id", "title": "Sec Uid" }, "description": "User sec_id", "example": "MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_account_fans_portrait_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_account_fans_portrait_list", "summary": "Fetch fan portrait", "description": "Fetch fan portrait", "parameters": [ { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_id", "title": "Sec Uid" }, "description": "User sec_id", "example": "MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4" }, { "name": "option", "in": "query", "required": false, "schema": { "type": "integer", "description": "Options: 1=Phone price distribution, 2=Gender distribution, 3=Age distribution, 4=Regional distribution by province, 5=Regional distribution by city, 6=City tier, 7=Phone brand distribution, 8=Interest tag analysis (percentage)", "default": 1, "title": "Option" }, "description": "Options: 1=Phone price distribution, 2=Gender distribution, 3=Age distribution, 4=Regional distribution by province, 5=Regional distribution by city, 6=City tier, 7=Phone brand distribution, 8=Interest tag analysis (percentage)", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/billboard/fetch_hot_account_item_analysis_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_account_item_analysis_list", "summary": "Fetch account work analysis - last week", "description": "Fetch account work analysis - last week", "parameters": [ { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_id", "title": "Sec Uid" }, "description": "User sec_id", "example": "MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/billboard/fetch_hot_account_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_account_list", "summary": "Fetch hot account list", "description": "Fetch hot account list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_account_list_api_v1_douyin_billboard_fetch_hot_account_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_account_search_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_account_search_list", "summary": "Fetch account search list", "description": "Fetch account search list", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Username or Douyin ID to search", "title": "Keyword" }, "description": "Username or Douyin ID to search", "example": "rmrbxmt" }, { "name": "cursor", "in": "query", "required": true, "schema": { "type": "integer", "description": "Cursor, defaults to empty", "title": "Cursor" }, "description": "Cursor, defaults to empty", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_account_trends_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_account_trends_list", "summary": "Fetch account fan data trend", "description": "Fetch account fan data trend", "parameters": [ { "name": "sec_uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_id", "title": "Sec Uid" }, "description": "User sec_id", "example": "MS4wLjABAAAA8U_l6rBzmy7bcy6xOJel4v0RzoR_wfAubGPeJimN__4" }, { "name": "option", "in": "query", "required": false, "schema": { "type": "integer", "description": "Options: 2=New likes, 3=New posts, 4=New comments, 5=New shares", "example": 2, "default": 2, "title": "Option" }, "description": "Options: 2=New likes, 3=New posts, 4=New comments, 5=New shares" }, { "name": "date_window", "in": "query", "required": false, "schema": { "type": "integer", "description": "Data point granularity (hours): 1=one point per hour, 24=one point per day; default 24", "example": 1, "default": 24, "title": "Date Window" }, "description": "Data point granularity (hours): 1=one point per hour, 24=one point per day; default 24" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/billboard/fetch_hot_calendar_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_calendar_detail", "summary": "Fetch activity calendar detail", "description": "Fetch activity calendar detail", "parameters": [ { "name": "calendar_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Activity id", "title": "Calendar Id" }, "description": "Activity id", "example": "1720" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_calendar_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_calendar_list", "summary": "Fetch activity calendar", "description": "Fetch activity calendar", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_calendar_list_api_v1_douyin_billboard_fetch_hot_calendar_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_category_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_category_list", "summary": "Fetch hot list category", "description": "Fetch hot list category", "parameters": [ { "name": "billboard_type", "in": "query", "required": true, "schema": { "type": "string", "description": "Ranking type", "title": "Billboard Type" }, "description": "Ranking type", "example": "rise" }, { "name": "snapshot_time", "in": "query", "required": false, "schema": { "type": "string", "description": "Snapshot time, yyyyMMddHHmmss format", "default": "20250106151500", "title": "Snapshot Time" }, "description": "Snapshot time, yyyyMMddHHmmss format" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "description": "Snapshot start time, yyyyMMdd format", "default": "", "title": "Start Date" }, "description": "Snapshot start time, yyyyMMdd format" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "description": "Snapshot end time, yyyyMMdd format", "default": "", "title": "End Date" }, "description": "Snapshot end time, yyyyMMdd format" }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot search keyword", "default": "", "title": "Keyword" }, "description": "Hot search keyword" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/billboard/fetch_hot_challenge_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_challenge_list", "summary": "Fetch hot challenge list", "description": "Fetch hot challenge list", "parameters": [ { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "description": "Page number", "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "page_size", "in": "query", "required": true, "schema": { "type": "integer", "description": "Items per page", "title": "Page Size" }, "description": "Items per page", "example": 10 }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot search keyword", "default": "", "title": "Keyword" }, "description": "Hot search keyword" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_city_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_city_list", "summary": "Fetch city hot list", "description": "Fetch city hot list", "parameters": [ { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "description": "Page number", "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "page_size", "in": "query", "required": true, "schema": { "type": "integer", "description": "Items per page", "title": "Page Size" }, "description": "Items per page", "example": 10 }, { "name": "order", "in": "query", "required": true, "schema": { "type": "string", "description": "Sort method", "example": "rank", "title": "Order" }, "description": "Sort method" }, { "name": "city_code", "in": "query", "required": false, "schema": { "type": "string", "description": "City code from city list; leave empty for all", "default": "", "title": "City Code" }, "description": "City code from city list; leave empty for all" }, { "name": "sentence_tag", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot-spot category tag; obtained from the hot-spot ranking categories; multiple values separated by commas; leave empty for all", "default": "", "title": "Sentence Tag" }, "description": "Hot-spot category tag; obtained from the hot-spot ranking categories; multiple values separated by commas; leave empty for all" }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot search keyword", "default": "", "title": "Keyword" }, "description": "Hot search keyword" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_comment_word_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_comment_word_list", "summary": "Fetch work comment analysis word cloud weight", "description": "Fetch work comment analysis word cloud weight", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Aweme Id" }, "description": "Post ID", "example": "7456035425539329340" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/billboard/fetch_hot_item_trends_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_item_trends_list", "summary": "Fetch post data trend", "description": "Fetch post data trend", "parameters": [ { "name": "aweme_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Post ID", "default": "", "title": "Aweme Id" }, "description": "Post ID" }, { "name": "option", "in": "query", "required": false, "schema": { "type": "integer", "description": "Options: 7=Likes, 8=Shares, 9=Comments", "example": 7, "default": 7, "title": "Option" }, "description": "Options: 7=Likes, 8=Shares, 9=Comments" }, { "name": "date_window", "in": "query", "required": false, "schema": { "type": "integer", "description": "Data point granularity: 1=hourly, 2=daily; default 1", "example": 1, "default": 1, "title": "Date Window" }, "description": "Data point granularity: 1=hourly, 2=daily; default 1" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_rise_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_rise_list", "summary": "Fetch rising hot list", "description": "Fetch rising hot list", "parameters": [ { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "description": "Page number", "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "page_size", "in": "query", "required": true, "schema": { "type": "integer", "description": "Items per page", "title": "Page Size" }, "description": "Items per page", "example": 10 }, { "name": "order", "in": "query", "required": true, "schema": { "type": "string", "description": "Sort method", "title": "Order" }, "description": "Sort method", "example": "rank" }, { "name": "sentence_tag", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot-spot category tag; obtained from the hot-spot ranking categories; multiple values separated by commas; leave empty for all", "default": "", "title": "Sentence Tag" }, "description": "Hot-spot category tag; obtained from the hot-spot ranking categories; multiple values separated by commas; leave empty for all" }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot search keyword", "default": "", "title": "Keyword" }, "description": "Hot search keyword" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_high_fan_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_high_fan_list", "summary": "Fetch high fan rate list", "description": "Fetch high fan rate list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_high_fan_list_api_v1_douyin_billboard_fetch_hot_total_high_fan_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_high_like_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_high_like_list", "summary": "Fetch high like rate list", "description": "Fetch high like rate list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_high_like_list_api_v1_douyin_billboard_fetch_hot_total_high_like_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_high_play_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_high_play_list", "summary": "Fetch high completion rate list", "description": "Fetch high completion rate list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_high_play_list_api_v1_douyin_billboard_fetch_hot_total_high_play_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_high_search_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_high_search_list", "summary": "Fetch search list with rising popularity", "description": "Fetch search list with rising popularity", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_high_search_list_api_v1_douyin_billboard_fetch_hot_total_high_search_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_high_topic_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_high_topic_list", "summary": "Fetch topic list with rising popularity", "description": "Fetch topic list with rising popularity", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_high_topic_list_api_v1_douyin_billboard_fetch_hot_total_high_topic_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_hot_word_detail_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_total_hot_word_detail_list", "summary": "Fetch content word details", "description": "Fetch content word details", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "" }, { "name": "word_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Content keyword ID", "title": "Word Id" }, "description": "Content keyword ID", "example": "" }, { "name": "query_day", "in": "query", "required": true, "schema": { "type": "integer", "description": "Query date in YYYYMMDD format; must be today's date", "title": "Query Day" }, "description": "Query date in YYYYMMDD format; must be today's date", "example": 20250105 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_hot_word_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_hot_word_list", "summary": "Fetch all hot content words", "description": "Fetch all hot content words", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_hot_word_list_api_v1_douyin_billboard_fetch_hot_total_hot_word_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_total_list", "summary": "Fetch total hot list", "description": "Fetch total hot list", "parameters": [ { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "description": "Page number", "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "page_size", "in": "query", "required": true, "schema": { "type": "integer", "description": "Items per page", "title": "Page Size" }, "description": "Items per page", "example": 10 }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "description": "Snapshot type: snapshot=view by moment, range=view by time range", "example": "snapshot", "title": "Type" }, "description": "Snapshot type: snapshot=view by moment, range=view by time range" }, { "name": "snapshot_time", "in": "query", "required": false, "schema": { "type": "string", "description": "Snapshot time, yyyyMMddHHmmss format", "default": "20250106151500", "title": "Snapshot Time" }, "description": "Snapshot time, yyyyMMddHHmmss format" }, { "name": "start_date", "in": "query", "required": false, "schema": { "type": "string", "description": "Snapshot start time, yyyyMMdd format", "default": "", "title": "Start Date" }, "description": "Snapshot start time, yyyyMMdd format" }, { "name": "end_date", "in": "query", "required": false, "schema": { "type": "string", "description": "Snapshot end time, yyyyMMdd format", "default": "", "title": "End Date" }, "description": "Snapshot end time, yyyyMMdd format" }, { "name": "sentence_tag", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot-spot category tag; obtained from the hot-spot ranking categories; multiple values separated by commas; leave empty for all", "default": "", "title": "Sentence Tag" }, "description": "Hot-spot category tag; obtained from the hot-spot ranking categories; multiple values separated by commas; leave empty for all" }, { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot search keyword", "default": "", "title": "Keyword" }, "description": "Hot search keyword" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_low_fan_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_low_fan_list", "summary": "Fetch low fan explosion list", "description": "Fetch low fan explosion list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_low_fan_list_api_v1_douyin_billboard_fetch_hot_total_low_fan_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_search_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_search_list", "summary": "Fetch search hot list", "description": "Fetch search hot list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_search_list_api_v1_douyin_billboard_fetch_hot_total_search_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_topic_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_topic_list", "summary": "Fetch topic hot list", "description": "Fetch topic hot list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_topic_list_api_v1_douyin_billboard_fetch_hot_total_topic_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_total_video_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_billboard_fetch_hot_total_video_list", "summary": "Fetch video hot list", "description": "Fetch video hot list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_hot_total_video_list_api_v1_douyin_billboard_fetch_hot_total_video_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/billboard/fetch_hot_user_portrait_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_billboard_fetch_hot_user_portrait_list", "summary": "Fetch work like audience portrait - hot list only", "description": "Fetch work like audience portrait - hot list only", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Aweme Id" }, "description": "Post ID", "example": "7456035425539329340" }, { "name": "option", "in": "query", "required": false, "schema": { "type": "integer", "description": "Options: 1=Phone price distribution, 2=Gender distribution, 3=Age distribution, 4=Regional distribution by province, 5=Regional distribution by city, 6=City tier, 7=Phone brand distribution", "example": 1, "default": 4, "title": "Option" }, "description": "Options: 1=Phone price distribution, 2=Gender distribution, 3=Age distribution, 4=Regional distribution by province, 5=Regional distribution by city, 6=City tier, 7=Phone brand distribution" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator_v2/fetch_author_diagnosis": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_author_diagnosis", "summary": "Fetch author diagnosis", "description": "Fetch author diagnosis", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorDiagnosisRequest", "description": "Author diagnosis request parameters" }, "example": { "cookie": "Your_Cookie_Here" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator/fetch_creator_activity_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_activity_detail", "summary": "Get creator activity detail", "description": "Get creator activity detail", "parameters": [ { "name": "activity_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Activity ID", "title": "Activity Id" }, "description": "Activity ID", "example": "7545335931785450534" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator/fetch_creator_activity_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_activity_list", "summary": "Get creator activity list", "description": "Get creator activity list", "parameters": [ { "name": "start_time", "in": "query", "required": true, "schema": { "type": "integer", "description": "Start timestamp", "title": "Start Time" }, "description": "Start timestamp", "example": 1756656000 }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "integer", "description": "End timestamp", "title": "End Time" }, "description": "End timestamp", "example": 1759247999 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_content_category": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_content_category", "summary": "Get creator content creation category", "description": "Get creator content creation category", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_content_course": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_content_course", "summary": "Get creator content creation course", "description": "Get creator content creation course", "parameters": [ { "name": "category_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Category ID", "title": "Category Id" }, "description": "Category ID", "example": 180 }, { "name": "order", "in": "query", "required": false, "schema": { "type": "integer", "description": "Order type: 1=Recommended, 2=Most popular, 3=Latest upload", "default": 1, "title": "Order" }, "description": "Order type: 1=Recommended, 2=Most popular, 3=Latest upload", "example": 1 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Items per page", "default": 24, "title": "Limit" }, "description": "Items per page", "example": 24 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Offset (starting position)", "default": 0, "title": "Offset" }, "description": "Offset (starting position)", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_hot_challenge_billboard": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_hot_challenge_billboard", "summary": "Get creator hot challenge billboard", "description": "Get creator hot challenge billboard", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_hot_course": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_hot_course", "summary": "Get creator hot course", "description": "Get creator hot course", "parameters": [ { "name": "order", "in": "query", "required": false, "schema": { "type": "integer", "description": "Order type: 1=Recommended, 2=Most popular, 3=Latest upload", "default": 1, "title": "Order" }, "description": "Order type: 1=Recommended, 2=Most popular, 3=Latest upload", "example": 1 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Items per page (recommended: 24)", "default": 24, "title": "Limit" }, "description": "Items per page (recommended: 24)", "example": 24 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset", "example": 0 }, { "name": "category_id", "in": "query", "required": false, "schema": { "description": "Selected topic category ID - omit for popular courses, provide to filter by selected topic\n Available values:\n 6976547830546582816=Knowledge, 6976547923849006336=Lifestyle, 6976547940311633165=Entertainment,\n 6976547972108635404=Food, 6980288134957272352=Positivity, 6980288181744766219=Gaming,\n 6980288219548011776=General", "title": "Category Id", "nullable": true, "type": "string" }, "description": "Selected topic category ID - omit for popular courses, provide to filter by selected topic\n Available values:\n 6976547830546582816=Knowledge, 6976547923849006336=Lifestyle, 6976547940311633165=Entertainment,\n 6976547972108635404=Food, 6980288134957272352=Positivity, 6980288181744766219=Gaming,\n 6980288219548011776=General" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_hot_music_billboard": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_hot_music_billboard", "summary": "Get creator hot music billboard", "description": "Get creator hot music billboard", "parameters": [ { "name": "billboard_tag", "in": "query", "required": false, "schema": { "type": "integer", "description": "Billboard tag (0=all; specific category values can be obtained via the config endpoint)", "default": 0, "title": "Billboard Tag" }, "description": "Billboard tag (0=all; specific category values can be obtained via the config endpoint)", "example": 0 }, { "name": "order_key", "in": "query", "required": false, "schema": { "type": "integer", "description": "Order key: 1=highest views, 2=most likes, 4=highest popularity, 5=most submissions", "default": 1, "title": "Order Key" }, "description": "Order key: 1=highest views, 2=most likes, 4=highest popularity, 5=most submissions", "example": 1 }, { "name": "time_filter", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time filter: 1=24 hours, 2=7 days, 3=30 days", "default": 1, "title": "Time Filter" }, "description": "Time filter: 1=24 hours, 2=7 days, 3=30 days", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_hot_props_billboard": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_hot_props_billboard", "summary": "Get creator hot props billboard", "description": "Get creator hot props billboard", "parameters": [ { "name": "billboard_tag", "in": "query", "required": false, "schema": { "type": "integer", "description": "Billboard tag, 0=all, other values can be obtained through config interface", "default": 0, "title": "Billboard Tag" }, "description": "Billboard tag, 0=all, other values can be obtained through config interface" }, { "name": "order_key", "in": "query", "required": false, "schema": { "type": "integer", "description": "Order key: 1=highest views, 5=most submissions, 6=highest exposure, 7=most favorites", "default": 1, "title": "Order Key" }, "description": "Order key: 1=highest views, 5=most submissions, 6=highest exposure, 7=most favorites" }, { "name": "time_filter", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time filter: 1=24 hours, 2=7 days, 3=30 days", "default": 1, "title": "Time Filter" }, "description": "Time filter: 1=24 hours, 2=7 days, 3=30 days" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_hot_spot_billboard": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_hot_spot_billboard", "summary": "Get creator hot spot billboard", "description": "Get creator hot spot billboard", "parameters": [ { "name": "billboard_tag", "in": "query", "required": false, "schema": { "type": "string", "description": "Hot spot tag - multiple tags separated by comma, like '1004,1000,1002'", "default": "0", "title": "Billboard Tag" }, "description": "Hot spot tag - multiple tags separated by comma, like '1004,1000,1002'" }, { "name": "hot_search_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Hot search type: 1=Overall ranking, 2=Local ranking, 3=Rising ranking", "default": 1, "title": "Hot Search Type" }, "description": "Hot search type: 1=Overall ranking, 2=Local ranking, 3=Rising ranking" }, { "name": "city_code", "in": "query", "required": false, "schema": { "description": "City code - required when hot_search_type=2", "title": "City Code", "nullable": true, "type": "string" }, "description": "City code - required when hot_search_type=2" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_hot_topic_billboard": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_hot_topic_billboard", "summary": "Get creator hot topic billboard", "description": "Get creator hot topic billboard", "parameters": [ { "name": "billboard_tag", "in": "query", "required": false, "schema": { "type": "integer", "description": "Billboard tag, 0=all, other values can be obtained through config interface", "default": 0, "title": "Billboard Tag" }, "description": "Billboard tag, 0=all, other values can be obtained through config interface" }, { "name": "order_key", "in": "query", "required": false, "schema": { "type": "integer", "description": "Order key: 1=highest views, 2=most likes, 3=most comments, 4=most submissions", "default": 1, "title": "Order Key" }, "description": "Order key: 1=highest views, 2=most likes, 3=most comments, 4=most submissions" }, { "name": "time_filter", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time filter: 1=24 hours, 2=7 days, 3=30 days", "default": 1, "title": "Time Filter" }, "description": "Time filter: 1=24 hours, 2=7 days, 3=30 days" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_material_center_billboard": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_material_center_billboard", "summary": "Get creator material center billboard", "description": "Get creator material center billboard", "parameters": [ { "name": "billboard_tag", "in": "query", "required": false, "schema": { "type": "integer", "description": "Billboard tag, 0=all, other values can be obtained through config interface", "default": 0, "title": "Billboard Tag" }, "description": "Billboard tag, 0=all, other values can be obtained through config interface" }, { "name": "order_key", "in": "query", "required": false, "schema": { "type": "integer", "description": "Order key: 1=highest views, 2=most likes, 3=most comments, 4=highest popularity", "default": 1, "title": "Order Key" }, "description": "Order key: 1=highest views, 2=most likes, 3=most comments, 4=highest popularity" }, { "name": "time_filter", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time filter: 1=24 hours, 2=7 days, 3=30 days", "default": 1, "title": "Time Filter" }, "description": "Time filter: 1=24 hours, 2=7 days, 3=30 days" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_material_center_config": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_material_center_config", "summary": "Get creator material center config", "description": "Get creator material center config", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_creator_material_center_related": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_creator_material_center_related", "summary": "Get topic or hot spot related videos", "description": "Get topic or hot spot related videos", "parameters": [ { "name": "query_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Query ID (topic ID or hot-spot ID, obtained from other ranking list endpoints)", "title": "Query Id" }, "description": "Query ID (topic ID or hot-spot ID, obtained from other ranking list endpoints)", "example": "2488260" }, { "name": "billboard_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Billboard type (2=Hot Topics, 3=Topics, 4=Props, 5=Music)", "default": 2, "title": "Billboard Type" }, "description": "Billboard type (2=Hot Topics, 3=Topics, 4=Props, 5=Music)", "example": 2 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Items per page", "default": 20, "title": "Limit" }, "description": "Items per page", "example": 20 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_industry_category_config": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_industry_category_config", "summary": "Get industry category config", "description": "Get industry category config", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator_v2/fetch_item_analysis_involved_vertical": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_analysis_involved_vertical", "summary": "Fetch item analysis involved vertical", "description": "Fetch item analysis involved vertical", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemAnalysisInvolvedVerticalRequest", "description": "Item analysis involved vertical request parameters" }, "example": { "cookie": "Your_Cookie_Here", "start_date": "20250713", "end_date": "20251011" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_analysis_item_performance": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_analysis_item_performance", "summary": "Fetch item analysis item performance", "description": "Fetch item analysis item performance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemAnalysisItemPerformanceRequest", "description": "Item analysis item performance request parameters" }, "example": { "cookie": "Your_Cookie_Here", "start_date": "20250713", "end_date": "20251011", "genres": [ 2, 3, 4, 5, 8 ], "primary_verticals": [ "Animal" ], "metric_type": 1 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_analysis_overview": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_analysis_overview", "summary": "Fetch item analysis overview", "description": "Fetch item analysis overview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemAnalysisOverviewRequest", "description": "Item analysis overview request parameters" }, "example": { "cookie": "Your_Cookie_Here", "start_date": "20250713", "end_date": "20251011", "genres": [ 1, 2, 3, 4, 5, 8 ], "primary_verticals": [ "Animal" ] } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_audience_others": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_audience_others", "summary": "Fetch item audience others analysis", "description": "Fetch item audience others analysis", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemAudienceOthersRequest", "description": "Item audience supplementary analysis request parameters" }, "example": { "cookie": "Your_Cookie_Here", "item_id": "7559536212910853422" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_audience_portrait": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_audience_portrait", "summary": "Fetch item audience portrait", "description": "Fetch item audience portrait", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemAudiencePortraitRequest", "description": "Item audience portrait request parameters" }, "example": { "cookie": "Your_Cookie_Here", "item_id": "7559536212910853422" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_danmaku_analysis": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_danmaku_analysis", "summary": "Fetch item bullet analysis", "description": "Fetch item bullet analysis", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemBulletAnalysisRequest", "description": "Item bullet (danmaku) analysis request parameters" }, "example": { "cookie": "Your_Cookie_Here", "item_id": "7559536212910853422" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_list", "summary": "Fetch item list", "description": "Fetch item list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemListRequest", "description": "Item list request parameters" }, "example": { "cookie": "Your_Cookie_Here", "start_time": 1758988800000, "end_time": 1760198399000, "count": 10, "order_by": 1, "fields": "metrics,review,visibility", "need_cooperation": true, "need_long_article": true } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_list_download": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_list_download", "summary": "Download item list", "description": "Download item list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemListDownloadRequest", "description": "Item list download request parameters" }, "example": { "cookie": "Your_Cookie_Here", "min_cursor": 1752336000000, "max_cursor": 1760198399000, "type_filters": [ 2, 3, 4, 5, 1, 8 ], "need_long_article": true } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_overview_data": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_overview_data", "summary": "Fetch item overview data", "description": "Fetch item overview data", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemMgetRequest", "description": "Item overview data request parameters" }, "example": { "cookie": "Your_Cookie_Here", "ids": "7559536212910853422", "fields": "metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_play_source": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_play_source", "summary": "Fetch item play source statistics", "description": "Fetch item play source statistics", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemPlaySourceRequest", "description": "Item play source statistics request parameters" }, "example": { "cookie": "Your_Cookie_Here", "item_id": "7559536212910853422" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_search_keyword": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_search_keyword", "summary": "Fetch item search keywords statistics", "description": "Fetch item search keywords statistics", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSearchKeywordRequest", "description": "Item search keywords statistics request parameters" }, "example": { "cookie": "Your_Cookie_Here", "item_id": "7559536212910853422" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_item_watch_trend": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_item_watch_trend", "summary": "Fetch item watch trend analysis", "description": "Fetch item watch trend analysis", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemWatchTrendRequest", "description": "Item watch trend analysis request parameters" }, "example": { "cookie": "Your_Cookie_Here", "item_id": "7559536212910853422", "analysis_type": 1 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator_v2/fetch_live_room_history_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_creator_v2_fetch_live_room_history_list", "summary": "Fetch live room history list", "description": "Fetch live room history list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveRoomHistoryListRequest", "description": "Live room history list request parameters" }, "example": { "cookie": "Your_Cookie_Here", "start_date": "2025-09-11", "end_date": "2025-10-11", "limit": 400, "need_living": 1, "download": 0 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/creator/fetch_mission_task_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_mission_task_list", "summary": "Get mission task list", "description": "Get mission task list", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Cursor (pagination)", "default": 0, "title": "Cursor" }, "description": "Cursor (pagination)", "example": 0 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Items per page", "default": 24, "title": "Limit" }, "description": "Items per page", "example": 24 }, { "name": "mission_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Mission type", "default": 1, "title": "Mission Type" }, "description": "Mission type", "example": 1 }, { "name": "tab_scene", "in": "query", "required": false, "schema": { "type": "integer", "description": "Scene type: 1=Submittable, 2=Registerable, 3=Product review", "default": 1, "title": "Tab Scene" }, "description": "Scene type: 1=Submittable, 2=Registerable, 3=Product review", "example": 1 }, { "name": "industry_lv1", "in": "query", "required": false, "schema": { "type": "integer", "description": "Primary industry (-1=all)", "default": -1, "title": "Industry Lv1" }, "description": "Primary industry (-1=all)", "example": 1913 }, { "name": "industry_lv2", "in": "query", "required": false, "schema": { "type": "integer", "description": "Secondary industry (-1=all)", "default": -1, "title": "Industry Lv2" }, "description": "Secondary industry (-1=all)", "example": 191301 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "description": "Platform channel: 1=Douyin video, 2=Douyin live, 3=Douyin image+text", "title": "Platform Channel", "nullable": true, "type": "integer" }, "description": "Platform channel: 1=Douyin video, 2=Douyin live, 3=Douyin image+text", "example": 1 }, { "name": "pay_type", "in": "query", "required": false, "schema": { "description": "Pay type: 1=video level, 2=custom, 3=pay per conversion, 4=pay per valid view, 5=pay per sale, 9=pay per redemption, 14=pay per commission", "title": "Pay Type", "nullable": true, "type": "integer" }, "description": "Pay type: 1=video level, 2=custom, 3=pay per conversion, 4=pay per valid view, 5=pay per sale, 9=pay per redemption, 14=pay per commission", "example": 4 }, { "name": "greater_than_cost_progress", "in": "query", "required": false, "schema": { "description": "Cost progress (20=above 20%, 50=above 50%, 80=above 80%)", "title": "Greater Than Cost Progress", "nullable": true, "type": "integer" }, "description": "Cost progress (20=above 20%, 50=above 50%, 80=above 80%)", "example": 20 }, { "name": "publish_time_start", "in": "query", "required": false, "schema": { "description": "Publish start time (timestamp)", "title": "Publish Time Start", "nullable": true, "type": "integer" }, "description": "Publish start time (timestamp)", "example": 1757097636 }, { "name": "quick_selector_scene", "in": "query", "required": false, "schema": { "description": "Quick selector (1=high revenue, 4=guaranteed income, 5=previously cooperated)", "title": "Quick Selector Scene", "nullable": true, "type": "integer" }, "description": "Quick selector (1=high revenue, 4=guaranteed income, 5=previously cooperated)" }, { "name": "keyword", "in": "query", "required": false, "schema": { "description": "Keyword (task name or ID)", "title": "Keyword", "nullable": true, "type": "string" }, "description": "Keyword (task name or ID)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_user_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_user_search", "summary": "Search users", "description": "Search users", "parameters": [ { "name": "user_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Username (supports Douyin ID and Douyin nickname)", "title": "User Name" }, "description": "Username (supports Douyin ID and Douyin nickname)", "example": "Y" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/creator/fetch_video_danmaku_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_creator_fetch_video_danmaku_list", "summary": "Get video danmaku list", "description": "Get video danmaku list", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video item ID", "title": "Item Id" }, "description": "Video item ID", "example": "7545659154417896746" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Items per page", "default": 20, "title": "Count" }, "description": "Items per page", "example": 20 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Offset (starting position)", "default": 0, "title": "Offset" }, "description": "Offset (starting position)", "example": 0 }, { "name": "order_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Order type: 1=sort by time, 2=other sort", "default": 1, "title": "Order Type" }, "description": "Order type: 1=sort by time, 2=other sort", "example": 1 }, { "name": "is_blocked", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Is blocked", "default": false, "title": "Is Blocked" }, "description": "Is blocked", "example": false } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/douplus/calculate_cost": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_calculate_cost", "summary": "DOU+ cost estimation", "description": "DOU+ cost estimation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostEstimateRequest" }, "example": { "cookie": "Your_Cookie_Here", "sec_uid": "MS4wLjABAAAA9fe7vGjwyiaOjL6REhX8rvmSb32VzA_XsKca9F3_YSHRXlEqgT2cpX54WGbtgnsA", "item_ids": "7651166972160446949", "target_id": 31 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_analyse_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_analyse_detail", "summary": "Delivery analysis detail", "description": "Delivery analysis detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyseStatsRequest" }, "example": { "cookie": "Your_Cookie_Here", "query": { "startTime": "1780934400", "endTime": "1781625599", "page": 1, "limit": 10, "analysisType": 1, "authorSecIdList": [], "statusList": [], "SecondaryTargetIds": [], "CollectWayIds": [], "metrics": [ "stat_cost", "total_play", "total_like", "dy_comment" ], "orderByMetric": "create_time", "orderByType": 1 } } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_analyse_graph": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_analyse_graph", "summary": "Delivery analysis trend graph", "description": "Delivery analysis trend graph", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyseStatsRequest" }, "example": { "cookie": "Your_Cookie_Here", "query": { "startTime": "1780934400", "endTime": "1781625599", "dimension": 1, "analysisType": 1, "authorSecIdList": [], "statusList": [], "SecondaryTargetIds": [], "CollectWayIds": [], "metrics": [ "stat_cost", "total_play", "total_like", "dy_comment" ] } } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_analyse_overview": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_analyse_overview", "summary": "Delivery analysis overview", "description": "Delivery analysis overview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyseStatsRequest" }, "example": { "cookie": "Your_Cookie_Here", "query": { "startTime": "1780934400", "endTime": "1781625599", "analysisType": 1, "authorSecIdList": [], "statusList": [], "SecondaryTargetIds": [], "CollectWayIds": [], "metrics": [ "stat_cost", "total_play", "play_duration_5s_rate", "total_like", "dy_comment", "dy_share", "dy_home_visited", "dy_follow" ] } } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_promotable_item_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_promotable_item_list", "summary": "Get promotable item list (with like & comment counts)", "description": "Get promotable item list (with like & comment counts)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotableItemListRequest" }, "example": { "sec_uid": "MS4wLjABAAAA9fe7vGjwyiaOjL6REhX8rvmSb32VzA_XsKca9F3_YSHRXlEqgT2cpX54WGbtgnsA", "count": 30, "target_id": 31 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_promoted_accounts": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_promoted_accounts", "summary": "Get promoted accounts", "description": "Get promoted accounts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotedAccountsRequest" }, "example": { "cookie": "Your_Cookie_Here", "limit": 20, "cursor": "" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_sec_token": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_sec_token", "summary": "Get DOU+ sec_token for POST requests", "description": "Get DOU+ sec_token for POST requests", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecTokenRequest" }, "example": { "cookie": "Your_Cookie_Here" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_talent_categories": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_talent_categories", "summary": "Get talent categories", "description": "Get talent categories", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TalentCategoryRequest" }, "example": {} } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_talents_by_category": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_talents_by_category", "summary": "Search talents by category", "description": "Search talents by category", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TalentByCategoryRequest" }, "example": { "name": "Music", "page": 0, "limit": 20 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_user_posts": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_user_posts", "summary": "Get user homepage posts", "description": "Get user homepage posts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPostsRequest" }, "example": { "sec_uid": "MS4wLjABAAAA9fe7vGjwyiaOjL6REhX8rvmSb32VzA_XsKca9F3_YSHRXlEqgT2cpX54WGbtgnsA", "cursor": "0", "count": 10 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_video_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_video_detail", "summary": "Get video detail (by id or link)", "description": "Get video detail (by id or link)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoDetailRequest" }, "example": { "video": "7651708301280906538" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_video_ranking": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_video_ranking", "summary": "Get DOU+ video ranking", "description": "Get DOU+ video ranking", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoRankingRequest" }, "example": { "time_range": 2, "tag_id": 634, "dim_type": 5, "adv_id": "" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/search_live_room": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_search_live_room", "summary": "Search live rooms (by Douyin ID or nickname)", "description": "Search live rooms (by Douyin ID or nickname)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveRoomSearchRequest" }, "example": { "keyword": "Xiao Erduo", "cursor": 0, "count": 10 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/search_user_v2": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_search_user_v2", "summary": "Search user V2", "description": "Search user V2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSearchV2Request" }, "example": { "keyword": "Bo", "cursor": 0, "count": 10, "scope": 1 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/search_video": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_search_video", "summary": "Search videos (by title)", "description": "Search videos (by title)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoSearchRequest" }, "example": { "keyword": "major", "cursor": 0, "count": 12 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/index/fetch_all_area": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_all_area", "summary": "Get all area list", "description": "Get all area list", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_all_valid_date": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_all_valid_date", "summary": "Get all valid dates", "description": "Get all valid dates", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_brand_cycles": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_brand_cycles", "summary": "Get brand cycles", "description": "Get brand cycles", "parameters": [ { "name": "brand_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Brand name", "title": "Brand Name" }, "description": "Brand name" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_brand_hot_videos_time_scope": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_brand_hot_videos_time_scope", "summary": "Brand hot videos time scope", "description": "Brand hot videos time scope", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_brand_initiative_rank_weekly": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_brand_initiative_rank_weekly", "summary": "Get brand initiative rank weekly", "description": "Get brand initiative rank weekly", "parameters": [ { "name": "brand_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Brand name", "title": "Brand Name" }, "description": "Brand name" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_brand_lines": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_brand_lines", "summary": "Get brand trend lines", "description": "Get brand trend lines", "parameters": [ { "name": "brand_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Brand name", "title": "Brand Name" }, "description": "Brand name" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_brand_radar_chart": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_brand_radar_chart", "summary": "Get brand radar chart", "description": "Get brand radar chart", "parameters": [ { "name": "brand_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Brand name", "title": "Brand Name" }, "description": "Brand name" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_brand_suggest": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_brand_suggest", "summary": "Brand search suggest", "description": "Brand search suggest", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Brand keyword", "title": "Keyword" }, "description": "Brand keyword" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_brand_valid_info": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_brand_valid_info", "summary": "Get brand index", "description": "Get brand index", "parameters": [ { "name": "keyword_list", "in": "query", "required": true, "schema": { "type": "string", "description": "Brand list, comma separated", "title": "Keyword List" }, "description": "Brand list, comma separated" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_author_portrait": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_content_author_portrait", "summary": "Content author portrait", "description": "Content author portrait", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)", "title": "Tag Id" }, "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)" }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "week", "month" ], "type": "string", "description": "Period: week or month", "default": "month", "title": "Period" }, "description": "Period: week or month" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_consume_trend": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_content_consume_trend", "summary": "Content consume trend", "description": "Content consume trend", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)", "title": "Tag Id" }, "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_consumer_portrait": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_content_consumer_portrait", "summary": "Content consumer portrait", "description": "Content consumer portrait", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)", "title": "Tag Id" }, "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)" }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "week", "month" ], "type": "string", "description": "Period: week or month", "default": "month", "title": "Period" }, "description": "Period: week or month" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_creative_duration": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_content_creative_duration", "summary": "Content creative duration", "description": "Content creative duration", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)", "title": "Tag Id" }, "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)" }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "week", "month" ], "type": "string", "description": "Period: week=weekly, month=monthly", "default": "week", "title": "Period" }, "description": "Period: week=weekly, month=monthly" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_creative_keyword_items": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_content_creative_keyword_items", "summary": "Creative keyword related items", "description": "Creative keyword related items", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Category ID, required, does NOT support 0=all", "title": "Tag Id" }, "description": "Category ID, required, does NOT support 0=all" }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "1", "3", "7" ], "type": "string", "description": "Period: 1, 3, 7", "default": "7", "title": "Period" }, "description": "Period: 1, 3, 7" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD (**must be a Sunday only when period=7**; any day for period=1/3)", "title": "End Date" }, "description": "End date YYYYMMDD (**must be a Sunday only when period=7**; any day for period=1/3)" }, { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword (get from fetch_content_creative_keywords)", "title": "Keyword" }, "description": "Keyword (get from fetch_content_creative_keywords)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_creative_keywords": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_content_creative_keywords", "summary": "Content creative keywords", "description": "Content creative keywords", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)", "title": "Tag Id" }, "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)" }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "1", "3", "7" ], "type": "string", "description": "Period: 1=last 1 day, 3=last 3 days, 7=last 7 days", "default": "7", "title": "Period" }, "description": "Period: 1=last 1 day, 3=last 3 days, 7=last 7 days" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD (**must be a Sunday only when period=7**; any day for period=1/3)", "title": "End Date" }, "description": "End date YYYYMMDD (**must be a Sunday only when period=7**; any day for period=1/3)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_creative_topic": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_content_creative_topic", "summary": "Content creative topic", "description": "Content creative topic", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Category ID, required, does NOT support 0=all", "title": "Tag Id" }, "description": "Category ID, required, does NOT support 0=all" }, { "name": "period", "in": "query", "required": false, "schema": { "enum": [ "1", "3", "7" ], "type": "string", "description": "Period: 1, 3, 7", "default": "7", "title": "Period" }, "description": "Period: 1, 3, 7" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD (**must be a Sunday only when period=7**; any day for period=1/3)", "title": "End Date" }, "description": "End date YYYYMMDD (**must be a Sunday only when period=7**; any day for period=1/3)" }, { "name": "rank_type", "in": "query", "required": false, "schema": { "enum": [ "index", "rise" ], "type": "string", "description": "Rank type: index=index sort, rise=rising sort", "default": "index", "title": "Rank Type" }, "description": "Rank type: index=index sort, rise=rising sort" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_interact_trend": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_content_interact_trend", "summary": "Content interact trend", "description": "Content interact trend", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)", "title": "Tag Id" }, "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_publish_trend": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_content_publish_trend", "summary": "Content publish trend", "description": "Content publish trend", "parameters": [ { "name": "tag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)", "title": "Tag Id" }, "description": "Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_content_valid_date": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_content_valid_date", "summary": "Get content valid date", "description": "Get content valid date", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_current_hot_topic": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_current_hot_topic", "summary": "Get current hot topics", "description": "Get current hot topics", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_daren_compare_users_stable": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_daren_compare_users_stable", "summary": "Daren compare users", "description": "Daren compare users", "parameters": [ { "name": "user_list", "in": "query", "required": true, "schema": { "type": "string", "description": "Daren uid list, comma separated, max 5", "title": "User List" }, "description": "Daren uid list, comma separated, max 5" }, { "name": "days", "in": "query", "required": false, "schema": { "enum": [ "7", "30" ], "type": "string", "description": "Days: 7 or 30", "default": "7", "title": "Days" }, "description": "Days: 7 or 30" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_daren_great_item_mile_info": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_daren_great_item_mile_info", "summary": "Get daren core metrics", "description": "Get daren core metrics", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin uid (numeric). Example: 3100268042915212", "title": "User Id" }, "description": "Douyin uid (numeric). Example: 3100268042915212" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_daren_great_user_fans_info": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_daren_great_user_fans_info", "summary": "Get daren fans analysis", "description": "Get daren fans analysis", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin uid (numeric). Example: 3100268042915212", "title": "User Id" }, "description": "Douyin uid (numeric). Example: 3100268042915212" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_daren_great_user_top_video": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_daren_great_user_top_video", "summary": "Get daren top videos", "description": "Get daren top videos", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin uid (numeric). Example: 3100268042915212", "title": "User Id" }, "description": "Douyin uid (numeric). Example: 3100268042915212" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_daren_similar_users": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_daren_similar_users", "summary": "Get similar daren", "description": "Get similar daren", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin uid (numeric). Example: 3100268042915212", "title": "User Id" }, "description": "Douyin uid (numeric). Example: 3100268042915212" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_daren_sug_great_user_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_daren_sug_great_user_list", "summary": "Daren search suggest", "description": "Daren search suggest", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword" }, { "name": "total", "in": "query", "required": false, "schema": { "type": "string", "description": "Return count", "default": "20", "title": "Total" }, "description": "Return count" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_encrypt_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_encrypt_user_id", "summary": "Encrypt Douyin uid to user_id", "description": "Encrypt Douyin uid to user_id", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin uid (numeric). Example: 3100268042915212", "title": "Uid" }, "description": "Douyin uid (numeric). Example: 3100268042915212" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_get_user_sub_word": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_get_user_sub_word", "summary": "Get user subscribed keywords", "description": "Get user subscribed keywords", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_hot_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_hot_detail", "summary": "Get hot topic detail", "description": "Get hot topic detail", "parameters": [ { "name": "topic_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Hot topic name", "title": "Topic Name" }, "description": "Hot topic name" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_hot_trend_word": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_hot_trend_word", "summary": "Get hot trend words", "description": "Get hot trend words", "parameters": [ { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" }, { "name": "type", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1, "minimum": 0, "description": "Word type: 0=Search hot words, 1=Content hot words", "default": 0, "title": "Type" }, "description": "Word type: 0=Search hot words, 1=Content hot words" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_hot_words": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_hot_words", "summary": "Get hot words", "description": "Get hot words", "parameters": [ { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_insight_get_rec": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_insight_get_rec", "summary": "Get related insight recommendations", "description": "Get related insight recommendations", "parameters": [ { "name": "report_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Report ID", "title": "Report Id" }, "description": "Report ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_insight_recommend": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_insight_recommend", "summary": "Get recommended insight reports", "description": "Get recommended insight reports", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_item_analysis": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_item_analysis", "summary": "Get video comparison analysis", "description": "Get video comparison analysis", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575", "title": "Item Id" }, "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_item_base": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_item_base", "summary": "Get video detail", "description": "Get video detail", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575", "title": "Item Id" }, "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/index/fetch_item_filter_options": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_item_filter_options", "summary": "Get video search filter options", "description": "Get video search filter options", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_item_index": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_item_index", "summary": "Get video index trend", "description": "Get video index trend", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575", "title": "Item Id" }, "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_item_index_interpret": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_item_index_interpret", "summary": "Get video index interpretation", "description": "Get video index interpretation", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575", "title": "Item Id" }, "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_item_query": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_item_query", "summary": "Video search results", "description": "Video search results", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword" }, { "name": "category_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Category ID (get from fetch_item_filter_options), 0=all", "default": "0", "title": "Category Id" }, "description": "Category ID (get from fetch_item_filter_options), 0=all" }, { "name": "date_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Date type (get from fetch_item_filter_options), 0=unlimited", "default": 0, "title": "Date Type" }, "description": "Date type (get from fetch_item_filter_options), 0=unlimited" }, { "name": "label_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Label type (get from fetch_item_filter_options), 0=unlimited", "default": 0, "title": "Label Type" }, "description": "Label type (get from fetch_item_filter_options), 0=unlimited" }, { "name": "duration_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Duration type (get from fetch_item_filter_options): 0=unlimited", "default": 0, "title": "Duration Type" }, "description": "Duration type (get from fetch_item_filter_options): 0=unlimited" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_item_sug": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_item_sug", "summary": "Video search suggest", "description": "Video search suggest", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_item_user_profile": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_item_user_profile", "summary": "Get video audience profile", "description": "Get video audience profile", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575", "title": "Item Id" }, "description": "Video ID (Douyin aweme id, numeric). Example: 7660090930283744575" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_keyword_valid_date": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_keyword_valid_date", "summary": "Get keyword valid date", "description": "Get keyword valid date", "parameters": [ { "name": "keyword_list", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword list, comma separated", "title": "Keyword List" }, "description": "Keyword list, comma separated" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_multi_keyword_hot_trend": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00435, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_multi_keyword_hot_trend", "summary": "Get multi-keyword hot trend", "description": "Get multi-keyword hot trend", "parameters": [ { "name": "keyword_list", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword list, comma separated", "title": "Keyword List" }, "description": "Keyword list, comma separated" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date, YYYYMMDD", "title": "Start Date" }, "description": "Start date, YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date, YYYYMMDD", "title": "End Date" }, "description": "End date, YYYYMMDD" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region list, comma separated", "default": "", "title": "Region" }, "description": "Region list, comma separated" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_multi_keyword_interpretation": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_multi_keyword_interpretation", "summary": "Get multi-keyword interpretation", "description": "Get multi-keyword interpretation", "parameters": [ { "name": "keyword_list", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword list, comma separated", "title": "Keyword List" }, "description": "Keyword list, comma separated" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date, YYYYMMDD", "title": "Start Date" }, "description": "Start date, YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date, YYYYMMDD", "title": "End Date" }, "description": "End date, YYYYMMDD" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region list, comma separated", "default": "", "title": "Region" }, "description": "Region list, comma separated" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_portrait": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_portrait", "summary": "Get crowd portrait", "description": "Get crowd portrait", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_relation_word": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_relation_word", "summary": "Get relation word analysis", "description": "Get relation word analysis", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date (Monday) YYYYMMDD", "title": "Start Date" }, "description": "Start date (Monday) YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date (must be Sunday) YYYYMMDD", "title": "End Date" }, "description": "End date (must be Sunday) YYYYMMDD" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_report_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_report_detail", "summary": "Get report detail", "description": "Get report detail", "parameters": [ { "name": "report_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Report ID. Example: 1081", "title": "Report Id" }, "description": "Report ID. Example: 1081" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/index/fetch_report_search": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_report_search", "summary": "Search trend reports", "description": "Search trend reports", "parameters": [ { "name": "current_page", "in": "query", "required": false, "schema": { "type": "string", "description": "Page number", "default": "1", "title": "Current Page" }, "description": "Page number" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "string", "description": "Page size", "default": "16", "title": "Page Size" }, "description": "Page size" }, { "name": "type", "in": "query", "required": false, "schema": { "enum": [ "", "Industry Insights", "Product Insights", "User Insights", "Trend Insights" ], "type": "string", "description": "Report type: empty=all, Industry Insight=Industry, Product Insight=Product, User Insight=User, Trend Insight=Trend", "default": "", "title": "Type" }, "description": "Report type: empty=all, Industry Insight=Industry, Product Insight=Product, User Insight=User, Trend Insight=Trend" }, { "name": "business", "in": "query", "required": false, "schema": { "type": "string", "description": "Business list, comma separated. Options: Juliang Engine, Toutiao, Douyin, Xigua Video, Douyin eCommerce, Shixiaolu, Other", "default": "", "title": "Business" }, "description": "Business list, comma separated. Options: Juliang Engine, Toutiao, Douyin, Xigua Video, Douyin eCommerce, Shixiaolu, Other" }, { "name": "report_time", "in": "query", "required": false, "schema": { "type": "string", "description": "Year list, comma separated. e.g. 2024,2023", "default": "", "title": "Report Time" }, "description": "Year list, comma separated. e.g. 2024,2023" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "description": "Search keyword", "default": "", "title": "Search" }, "description": "Search keyword" }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "description": "Top category ID (default 6 = Douyin Index trend reports)", "default": "6", "title": "Category" }, "description": "Top category ID (default 6 = Douyin Index trend reports)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_topic_query": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_topic_query", "summary": "Topic search results", "description": "Topic search results", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Topic keyword", "title": "Keyword" }, "description": "Topic keyword" }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date YYYYMMDD", "title": "Start Date" }, "description": "Start date YYYYMMDD" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date YYYYMMDD", "title": "End Date" }, "description": "End date YYYYMMDD" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_topic_suggest": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_index_fetch_topic_suggest", "summary": "Topic search suggest", "description": "Topic search suggest", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Topic keyword", "title": "Keyword" }, "description": "Topic keyword" }, { "name": "app_name", "in": "query", "required": false, "schema": { "enum": [ "aweme", "toutiao" ], "type": "string", "description": "Platform: aweme (Douyin), toutiao (Toutiao)", "default": "aweme", "title": "App Name" }, "description": "Platform: aweme (Douyin), toutiao (Toutiao)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/index/fetch_valid_date_for_relation": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_index_fetch_valid_date_for_relation", "summary": "Get valid date for relation", "description": "Get valid date for relation", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu/author_content_hot_comment_keywords_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_author_content_hot_comment_keywords_v1", "summary": "Get Author Content Hot Comment Keywords V1", "description": "Get Author Content Hot Comment Keywords V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/author_hot_comment_tokens_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_author_hot_comment_tokens_v1", "summary": "Get Author Hot Comment Tokens V1", "description": "Get Author Hot Comment Tokens V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_audience_distribution": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_audience_distribution", "summary": "Get Author Audience Distribution", "description": "Get Author Audience Distribution", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7029342444797820939" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 }, { "name": "link_type", "in": "query", "required": true, "schema": { "type": "integer", "description": "Audience profile link type, required; example: 5", "title": "Link Type" }, "description": "Audience profile link type, required; example: 5", "example": 5 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_base_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_base_info", "summary": "Get Author Base Info", "description": "Get Author Base Info", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator author ID", "title": "O Author Id" }, "description": "Creator author ID", "example": "7589271892177518598" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 }, { "name": "recommend", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to return recommendation info", "default": true, "title": "Recommend" }, "description": "Whether to return recommendation info", "example": true }, { "name": "need_sec_uid", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to return sec_uid", "default": true, "title": "Need Sec Uid" }, "description": "Whether to return sec_uid", "example": true }, { "name": "need_linkage_info", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to return linkage info", "default": true, "title": "Need Linkage Info" }, "description": "Whether to return linkage info", "example": true } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_business_card_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_business_card_info", "summary": "Get Author Business Card Info", "description": "Get Author Business Card Info", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator author ID", "title": "O Author Id" }, "description": "Creator author ID", "example": "7589271892177518598" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_commerce_spread_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00435, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_commerce_spread_info", "summary": "Get Author Commerce Spread Info", "description": "Get Author Commerce Spread Info", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7112600044674482187" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_content_hot_keywords": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_content_hot_keywords", "summary": "Get Author Content Hot Keywords", "description": "Get Author Content Hot Keywords", "parameters": [ { "name": "author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator author ID", "title": "Author Id" }, "description": "Creator author ID", "example": "7589271892177518598" }, { "name": "keyword_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Keyword type", "default": 0, "title": "Keyword Type" }, "description": "Keyword type", "example": 0 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_author_convert_ability": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_convert_ability", "summary": "Get Author Convert Ability", "description": "Get Author Convert Ability", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7029342444797820939" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 }, { "name": "industry_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "Industry ID, 0=unlimited", "default": 0, "title": "Industry Id" }, "description": "Industry ID, 0=unlimited", "example": 0 }, { "name": "time_range", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time range tier, default 2", "default": 2, "title": "Time Range" }, "description": "Time range tier, default 2", "example": 2 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_convert_videos_or_products": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_convert_videos_or_products", "summary": "Get Author Convert Videos or Products", "description": "Get Author Convert Videos or Products", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7589271892177518598" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 }, { "name": "detail_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Detail type: 1=related videos, 2=related products", "default": 1, "title": "Detail Type" }, "description": "Detail type: 1=related videos, 2=related products", "example": 1 }, { "name": "industry_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "Industry ID, 0=unlimited", "default": 0, "title": "Industry Id" }, "description": "Industry ID, 0=unlimited", "example": 0 }, { "name": "time_range", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time range tier, default 2", "default": 2, "title": "Time Range" }, "description": "Time range tier, default 2", "example": 2 }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_cp_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_cp_info", "summary": "Get Author CP Info", "description": "Get Author CP Info", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7029342444797820939" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_daily_fans": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_daily_fans", "summary": "Get Author Daily Fans", "description": "Get Author Daily Fans", "parameters": [ { "name": "author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "Author Id" }, "description": "Creator ID", "example": "7029342444797820939" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "start_date", "in": "query", "required": false, "schema": { "description": "Start date, format YYYYMMDD, optional", "title": "Start Date", "nullable": true, "type": "string" }, "description": "Start date, format YYYYMMDD, optional" }, { "name": "end_date", "in": "query", "required": false, "schema": { "description": "End date, format YYYYMMDD, optional", "title": "End Date", "nullable": true, "type": "string" }, "description": "End date, format YYYYMMDD, optional" }, { "name": "author_type", "in": "query", "required": false, "schema": { "description": "Author type, optional", "title": "Author Type", "nullable": true, "type": "integer" }, "description": "Author type, optional" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_author_daily_link": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00435, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_daily_link", "summary": "Get Author Daily Link", "description": "Get Author Daily Link", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7112600044674482187" }, { "name": "link_type", "in": "query", "required": true, "schema": { "type": "integer", "description": "Xingtu link metric type ID", "title": "Link Type" }, "description": "Xingtu link metric type ID", "example": 5 }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date, YYYYMMDD recommended", "title": "Start Date" }, "description": "Start date, YYYYMMDD recommended", "example": "20250801" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date, YYYYMMDD recommended", "title": "End Date" }, "description": "End date, YYYYMMDD recommended", "example": "20250822" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source: 1 for Douyin", "default": 1, "title": "Platform Source" }, "description": "Platform source: 1 for Douyin" }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel: 1 for short video", "default": 1, "title": "Platform Channel" }, "description": "Platform channel: 1 for short video" }, { "name": "industry_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "Industry ID, 0 for all", "default": 0, "title": "Industry Id" }, "description": "Industry ID, 0 for all" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_daily_link_score": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00435, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_daily_link_score", "summary": "Get Author Daily Link Score", "description": "Get Author Daily Link Score", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7112600044674482187" }, { "name": "link_score_type", "in": "query", "required": true, "schema": { "type": "integer", "description": "Xingtu link-score type ID", "title": "Link Score Type" }, "description": "Xingtu link-score type ID", "example": 1 }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date, YYYYMMDD recommended", "title": "Start Date" }, "description": "Start date, YYYYMMDD recommended", "example": "20250801" }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "description": "End date, YYYYMMDD recommended", "title": "End Date" }, "description": "End date, YYYYMMDD recommended", "example": "20250822" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source: 1 for Douyin", "default": 1, "title": "Platform Source" }, "description": "Platform source: 1 for Douyin" }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel: 1 for short video", "default": 1, "title": "Platform Channel" }, "description": "Platform channel: 1 for short video" }, { "name": "industry_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "Industry ID, 0 for all", "default": 0, "title": "Industry Id" }, "description": "Industry ID, 0 for all" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_fans_distribution": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_fans_distribution", "summary": "Get Author Fans Distribution", "description": "Get Author Fans Distribution", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7029342444797820939" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_homepage_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_homepage_videos", "summary": "Get Author Homepage Videos", "description": "Get Author Homepage Videos", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7029342444797820939" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "is_star_item", "in": "query", "required": false, "schema": { "description": "1=star items only, 0=non-star only, omit=all", "title": "Is Star Item", "nullable": true, "type": "integer" }, "description": "1=star items only, 0=non-star only, omit=all" }, { "name": "start_time", "in": "query", "required": false, "schema": { "description": "Post publish start time, Unix seconds", "title": "Start Time", "nullable": true, "type": "integer" }, "description": "Post publish start time, Unix seconds" }, { "name": "end_time", "in": "query", "required": false, "schema": { "description": "Post publish end time, Unix seconds", "title": "End Time", "nullable": true, "type": "integer" }, "description": "Post publish end time, Unix seconds" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_hot_comment_tokens": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_hot_comment_tokens", "summary": "Get Author Hot Comment Tokens", "description": "Get Author Hot Comment Tokens", "parameters": [ { "name": "author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator author ID", "title": "Author Id" }, "description": "Creator author ID", "example": "7589271892177518598" }, { "name": "num", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of hot tokens", "default": 10, "title": "Num" }, "description": "Number of hot tokens", "example": 10 }, { "name": "without_emoji", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to exclude emoji", "default": true, "title": "Without Emoji" }, "description": "Whether to exclude emoji", "example": true } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_author_link_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_link_info", "summary": "Get Author Link Info", "description": "Get Author Link Info", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7589271892177518598" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 }, { "name": "industy_tag", "in": "query", "required": false, "schema": { "type": "integer", "description": "Industry tag, 0=unlimited", "default": 0, "title": "Industy Tag" }, "description": "Industry tag, 0=unlimited", "example": 0 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_local_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_local_info", "summary": "Get Author Local Info", "description": "Get Author Local Info", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator author ID", "title": "O Author Id" }, "description": "Creator author ID", "example": "7146074596666507300" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 }, { "name": "time_range", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time range in days", "default": 30, "title": "Time Range" }, "description": "Time range in days", "example": 30 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_market_fields": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_market_fields", "summary": "Get Author Market Fields", "description": "Get Author Market Fields", "parameters": [ { "name": "market_scene", "in": "query", "required": false, "schema": { "type": "integer", "description": "Market scene: 1=default", "default": 1, "title": "Market Scene" }, "description": "Market scene: 1=default", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_author_rec_videos_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_rec_videos_v2", "summary": "Get Author Recommended Videos V2", "description": "Get Author Recommended Videos V2", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7112600044674482187" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source: 1=Douyin", "default": 1, "title": "Platform Source" }, "description": "Platform source: 1=Douyin", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel: 1=Douyin video", "default": 1, "title": "Platform Channel" }, "description": "Platform channel: 1=Douyin video", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_show_items": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_show_items", "summary": "Get Author Show Items", "description": "Get Author Show Items", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator author ID", "title": "O Author Id" }, "description": "Creator author ID", "example": "7589271892177518598" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 }, { "name": "only_assign", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Only show assigned videos", "default": false, "title": "Only Assign" }, "description": "Only show assigned videos", "example": false }, { "name": "flow_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Flow type", "default": 0, "title": "Flow Type" }, "description": "Flow type", "example": 0 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_spread_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_spread_info", "summary": "Get Author Spread Info", "description": "Get Author Spread Info", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator author ID", "title": "O Author Id" }, "description": "Creator author ID", "example": "7589271892177518598" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 }, { "name": "type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Video type, 1=personal video", "default": 1, "title": "Type" }, "description": "Video type, 1=personal video", "example": 1 }, { "name": "flow_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Flow type", "default": 0, "title": "Flow Type" }, "description": "Flow type", "example": 0 }, { "name": "only_assign", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Only assigned videos", "default": false, "title": "Only Assign" }, "description": "Only assigned videos", "example": false }, { "name": "range", "in": "query", "required": false, "schema": { "type": "integer", "description": "Time range: 2=last 30 days, 3=last 90 days", "default": 2, "title": "Range" }, "description": "Time range: 2=last 30 days, 3=last 90 days", "example": 2 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_spread_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_spread_videos", "summary": "Get Author Spread Videos", "description": "Get Author Spread Videos", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7112600044674482187" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source: 1 for Douyin", "default": 1, "title": "Platform Source" }, "description": "Platform source: 1 for Douyin" }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel: 1 for short video", "default": 1, "title": "Platform Channel" }, "description": "Platform channel: 1 for short video" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_touch_distribution": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_touch_distribution", "summary": "Get Author Touch Distribution", "description": "Get Author Touch Distribution", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7029342444797820939" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel", "default": 1, "title": "Platform Channel" }, "description": "Platform channel", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_author_video_distribution": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_author_video_distribution", "summary": "Get Author Video Distribution", "description": "Get Author Video Distribution", "parameters": [ { "name": "o_author_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Creator ID", "title": "O Author Id" }, "description": "Creator ID", "example": "7112600044674482187" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source: 1 for Douyin", "default": 1, "title": "Platform Source" }, "description": "Platform source: 1 for Douyin" }, { "name": "platform_channel", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform channel: 1 for short video", "default": 1, "title": "Platform Channel" }, "description": "Platform channel: 1 for short video" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_content_trend_guide": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_content_trend_guide", "summary": "Get Content Trend Guide", "description": "Get Content Trend Guide", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_demander_mcn_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_demander_mcn_list", "summary": "Get Demander MCN List", "description": "Get Demander MCN List", "parameters": [ { "name": "mcn_name", "in": "query", "required": false, "schema": { "type": "string", "description": "MCN name, supports fuzzy search", "default": "", "title": "Mcn Name" }, "description": "MCN name, supports fuzzy search", "example": "" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "order_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort by", "default": "platform_scores", "title": "Order By" }, "description": "Sort by", "example": "platform_scores" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_excellent_case_category_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_excellent_case_category_list", "summary": "Get Excellent Case Category List", "description": "Get Excellent Case Category List", "parameters": [ { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_ip_activity_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_ip_activity_detail", "summary": "Get IP Activity Detail", "description": "Get IP Activity Detail", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Activity ID from get_ip_activity_list", "title": "Id" }, "description": "Activity ID from get_ip_activity_list", "example": 347 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_ip_activity_industry_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_ip_activity_industry_list", "summary": "Get IP Activity Industry List", "description": "Get IP Activity Industry List", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_ip_activity_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_xingtu_v2_get_ip_activity_list", "summary": "Get IP Activity List", "description": "Get IP Activity List", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_ip_activity_list_api_v1_douyin_xingtu_v2_get_ip_activity_list_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_item_play_count": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_item_play_count", "summary": "Get Item Play Count", "description": "Get Item Play Count", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video (item) ID", "title": "Item Id" }, "description": "Video (item) ID", "example": "7630036460159111515" }, { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source", "default": 1, "title": "Platform Source" }, "description": "Platform source", "example": 1 }, { "name": "need_cover_url", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to return cover URL", "default": true, "title": "Need Cover Url" }, "description": "Whether to return cover URL", "example": true } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_item_report_comments": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00435, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_xingtu_v2_get_item_report_comments", "summary": "Get Item Report Comments", "description": "Get Item Report Comments", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_item_report_comments_api_v1_douyin_xingtu_v2_get_item_report_comments_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_item_report_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_xingtu_v2_get_item_report_detail", "summary": "Get Item Report Detail", "description": "Get Item Report Detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_item_report_detail_api_v1_douyin_xingtu_v2_get_item_report_detail_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_item_report_th_analysis": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00435, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_xingtu_v2_get_item_report_th_analysis", "summary": "Get Item Report Interaction Analysis", "description": "Get Item Report Interaction Analysis", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_item_report_th_analysis_api_v1_douyin_xingtu_v2_get_item_report_th_analysis_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_item_report_trend": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00435, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_xingtu_v2_get_item_report_trend", "summary": "Get Item Report Trend", "description": "Get Item Report Trend", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_item_report_trend_api_v1_douyin_xingtu_v2_get_item_report_trend_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_playlet_actor_rank_catalog": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_xingtu_v2_get_playlet_actor_rank_catalog", "summary": "Get Playlet Actor Rank Catalog", "description": "Get Playlet Actor Rank Catalog", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_playlet_actor_rank_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_playlet_actor_rank_list", "summary": "Get Playlet Actor Rank List", "description": "Get Playlet Actor Rank List", "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "description": "Category", "default": "playlet_actor_list", "title": "Category" }, "description": "Category", "example": "playlet_actor_list" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Ranking name", "default": "playlet_actor_composite_list", "title": "Name" }, "description": "Ranking name", "example": "playlet_actor_composite_list" }, { "name": "qualifier", "in": "query", "required": false, "schema": { "type": "string", "description": "Actor type, empty=all", "default": "", "title": "Qualifier" }, "description": "Actor type, empty=all", "example": "" }, { "name": "period", "in": "query", "required": false, "schema": { "type": "integer", "description": "Period, 7=weekly, 30=monthly", "default": 30, "title": "Period" }, "description": "Period, 7=weekly, 30=monthly", "example": 30 }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "description": "Date, format YYYYMMDD", "default": "20251130", "title": "Date" }, "description": "Date, format YYYYMMDD", "example": "20251130" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_ranking_list_catalog": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_ranking_list_catalog", "summary": "Get Ranking List Catalog", "description": "Get Ranking List Catalog", "parameters": [ { "name": "codes", "in": "query", "required": false, "schema": { "type": "string", "description": "Classification codes, default is empty string", "default": "", "title": "Codes" }, "description": "Classification codes, default is empty string", "example": "" }, { "name": "biz_scene", "in": "query", "required": false, "schema": { "type": "string", "description": "Business scene", "default": "douyin_flow_split_video_author_ranks", "title": "Biz Scene" }, "description": "Business scene", "example": "douyin_flow_split_video_author_ranks" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_ranking_list_data": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_ranking_list_data", "summary": "Get Ranking List Data", "description": "Get Ranking List Data", "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "integer", "description": "Ranking type code", "default": 1, "title": "Code" }, "description": "Ranking type code", "example": 1 }, { "name": "qualifier", "in": "query", "required": false, "schema": { "type": "string", "description": "Category qualifier_id, obtained from get_ranking_list_catalog", "default": "1901", "title": "Qualifier" }, "description": "Category qualifier_id, obtained from get_ranking_list_catalog", "example": "1901" }, { "name": "version", "in": "query", "required": false, "schema": { "type": "string", "description": "Version", "default": "flow_split", "title": "Version" }, "description": "Version", "example": "flow_split" }, { "name": "period", "in": "query", "required": false, "schema": { "type": "integer", "description": "Period, 7=weekly, 30=monthly", "default": 30, "title": "Period" }, "description": "Period, 7=weekly, 30=monthly", "example": 30 }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "description": "Date, format YYYYMMDD", "default": "20260131", "title": "Date" }, "description": "Date, format YYYYMMDD", "example": "20260131" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_recommend_for_star_authors": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_xingtu_v2_get_recommend_for_star_authors", "summary": "Get Recommend Similar Star Authors", "description": "Get Recommend Similar Star Authors", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_recommend_for_star_authors_api_v1_douyin_xingtu_v2_get_recommend_for_star_authors_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_resource_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_resource_list", "summary": "Get Resource List", "description": "Get Resource List", "parameters": [ { "name": "resource_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Resource ID", "title": "Resource Id" }, "description": "Resource ID", "example": 1052 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/get_search_field_options": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_search_field_options", "summary": "Get Search Field Options", "description": "Get Search Field Options", "parameters": [ { "name": "platform_source", "in": "query", "required": false, "schema": { "type": "integer", "description": "Platform source: 1=Douyin, 2=Toutiao", "default": 1, "title": "Platform Source" }, "description": "Platform source: 1=Douyin, 2=Toutiao", "example": 1 }, { "name": "task_category", "in": "query", "required": false, "schema": { "type": "integer", "description": "Task category: 1=Douyin video, 6=Douyin live, 11=Toutiao article", "default": 1, "title": "Task Category" }, "description": "Task category: 1=Douyin video, 6=Douyin live, 11=Toutiao article", "example": 1 } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu/get_sign_image": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_get_sign_image", "summary": "Get Sign Image", "description": "Get Sign Image", "parameters": [ { "name": "uri", "in": "query", "required": true, "schema": { "type": "string", "description": "Image URI", "title": "Uri" }, "description": "Image URI", "example": "tos-cn-i-0813c000-ce/oMKzDA3A9QGAuebfsDIAwlDoAfCFEEzSEw8FQZ" }, { "name": "durationTS", "in": "query", "required": false, "schema": { "type": "integer", "description": "Duration in seconds", "default": 86400, "title": "Durationts" }, "description": "Duration in seconds", "example": 86400 }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "description": "Image format", "default": "webp", "title": "Format" }, "description": "Image format", "example": "webp" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_user_profile_qrcode": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_user_profile_qrcode", "summary": "Get User Profile QRCode", "description": "Get User Profile QRCode", "parameters": [ { "name": "core_user_id", "in": "query", "required": false, "schema": { "description": "User core ID (pick one with sec_uid)", "title": "Core User Id", "nullable": true, "type": "string" }, "description": "User core ID (pick one with sec_uid)", "example": "1113181577281568" }, { "name": "sec_uid", "in": "query", "required": false, "schema": { "description": "User sec_uid (pick one with core_user_id)", "title": "Sec Uid", "nullable": true, "type": "string" }, "description": "User sec_uid (pick one with core_user_id)" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id", "summary": "Get XingTu kolid by Douyin sec_user_id", "description": "Get XingTu kolid by Douyin sec_user_id", "parameters": [ { "name": "sec_user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin User sec_user_id", "title": "Sec User Id" }, "description": "Douyin User sec_user_id", "example": "MS4wLjABAAAAoxwUZouIdKL6sZ8EB96KDjkrhfBMS1KbCgsMJR1kIUs" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid", "summary": "Get XingTu kolid by Douyin User ID", "description": "Get XingTu kolid by Douyin User ID", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin User ID", "title": "Uid" }, "description": "Douyin User ID", "example": "70452002324" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id", "summary": "Get XingTu kolid by Douyin unique_id", "description": "Get XingTu kolid by Douyin unique_id", "parameters": [ { "name": "unique_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin User unique_id", "title": "Unique Id" }, "description": "Douyin User unique_id", "example": "m6640150" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu/kol_audience_portrait_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_audience_portrait_v1", "summary": "Get kol Audience Portrait V1", "description": "Get kol Audience Portrait V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_base_info_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_base_info_v1", "summary": "Get kol Base Info V1", "description": "Get kol Base Info V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" }, { "name": "platformChannel", "in": "query", "required": true, "schema": { "type": "string", "description": "Platform channel", "title": "Platformchannel" }, "description": "Platform channel", "example": "_1" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_conversion_ability_analysis_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_conversion_ability_analysis_v1", "summary": "Get kol Conversion Ability Analysis V1", "description": "Get kol Conversion Ability Analysis V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" }, { "name": "_range", "in": "query", "required": true, "schema": { "type": "string", "description": "Time Range", "title": " Range" }, "description": "Time Range", "example": "_1" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_convert_video_display_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_convert_video_display_v1", "summary": "Get kol Convert Video Display V1", "description": "Get kol Convert Video Display V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" }, { "name": "detailType", "in": "query", "required": true, "schema": { "type": "string", "description": "Detail Type", "title": "Detailtype" }, "description": "Detail Type", "example": "_1" }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "description": "Page", "title": "Page" }, "description": "Page", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_cp_info_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_cp_info_v1", "summary": "Get kol Cp Info V1", "description": "Get kol Cp Info V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_daily_fans_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_daily_fans_v1", "summary": "Get kol Daily Fans V1", "description": "Get kol Daily Fans V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "description": "Start date", "title": "Startdate" }, "description": "Start date", "example": "2024-12-01" }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "description": "End Date", "title": "Enddate" }, "description": "End Date", "example": "2025-01-01" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_data_overview_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_data_overview_v1", "summary": "Get kol Data Overview V1", "description": "Get kol Data Overview V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" }, { "name": "_type", "in": "query", "required": true, "schema": { "type": "string", "description": "Type", "title": " Type" }, "description": "Type", "example": "_1" }, { "name": "_range", "in": "query", "required": true, "schema": { "type": "string", "description": "Range", "title": " Range" }, "description": "Range", "example": "_2" }, { "name": "flowType", "in": "query", "required": true, "schema": { "type": "integer", "description": "Flow Type", "title": "Flowtype" }, "description": "Flow Type", "example": 1 }, { "name": "onlyAssign", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether assigned (optional)", "title": "Onlyassign" }, "description": "Whether assigned (optional)" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_fans_portrait_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_fans_portrait_v1", "summary": "Get kol Fans Portrait V1", "description": "Get kol Fans Portrait V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" }, { "name": "fansType", "in": "query", "required": false, "schema": { "type": "string", "description": "Fans Type", "default": "_1", "title": "Fanstype" }, "description": "Fans Type", "example": "_1" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_link_struct_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_link_struct_v1", "summary": "Get kol Link Struct V1", "description": "Get kol Link Struct V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_rec_videos_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_rec_videos_v1", "summary": "Get kol Rec Videos V1", "description": "Get kol Rec Videos V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_service_price_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_service_price_v1", "summary": "Get kol Service Price V1", "description": "Get kol Service Price V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" }, { "name": "platformChannel", "in": "query", "required": true, "schema": { "type": "string", "description": "Platform channel", "title": "Platformchannel" }, "description": "Platform channel", "example": "_1" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_touch_distribution_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_touch_distribution_v1", "summary": "Get kol Touch Distribution V1", "description": "Get kol Touch Distribution V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_video_performance_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_video_performance_v1", "summary": "Get kol Video Performance V1", "description": "Get kol Video Performance V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" }, { "name": "onlyAssign", "in": "query", "required": true, "schema": { "type": "boolean", "description": "Whether to display only assigned works", "title": "Onlyassign" }, "description": "Whether to display only assigned works", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu/kol_xingtu_index_v1": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_kol_xingtu_index_v1", "summary": "Get kol Xingtu Index V1", "description": "Get kol Xingtu Index V1", "parameters": [ { "name": "kolId", "in": "query", "required": true, "schema": { "type": "string", "description": "User kolId", "title": "Kolid" }, "description": "User kolId", "example": "7048929565493690398" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/multi_get_author_info": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_xingtu_v2_multi_get_author_info", "summary": "Multi Get Author Info", "description": "Multi Get Author Info", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_multi_get_author_info_api_v1_douyin_xingtu_v2_multi_get_author_info_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/multi_get_item_stats": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.058, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_xingtu_v2_multi_get_item_stats", "summary": "Multi Get Item Stats", "description": "Multi Get Item Stats", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_multi_get_item_stats_api_v1_douyin_xingtu_v2_multi_get_item_stats_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/search_anchor": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_search_anchor", "summary": "Search Anchor", "description": "Search Anchor", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword: nickname, Douyin ID, Xingtu ID or live content word", "title": "Keyword" }, "description": "Search keyword: nickname, Douyin ID, Xingtu ID or live content word", "example": "Gaming" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "sort_field", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort field, default score (comprehensive)", "default": "score", "title": "Sort Field" }, "description": "Sort field, default score (comprehensive)", "example": "score" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type: 1=asc, 2=desc", "default": 2, "title": "Sort Type" }, "description": "Sort type: 1=asc, 2=desc", "example": 2 }, { "name": "task_category", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cooperation target", "default": 6, "title": "Task Category" }, "description": "Cooperation target", "example": 6 }, { "name": "marketing_target", "in": "query", "required": false, "schema": { "type": "integer", "description": "Marketing target", "default": 3, "title": "Marketing Target" }, "description": "Marketing target", "example": 3 }, { "name": "first_industry_id", "in": "query", "required": false, "schema": { "description": "Industry ID", "title": "First Industry Id", "nullable": true, "type": "integer" }, "description": "Industry ID" }, { "name": "author_list_id", "in": "query", "required": false, "schema": { "description": "Featured creator list ID", "title": "Author List Id", "nullable": true, "type": "string" }, "description": "Featured creator list ID" }, { "name": "price_type", "in": "query", "required": false, "schema": { "description": "Live-stream price type, fixed to 9; used only in combination with price_min/price_max", "title": "Price Type", "nullable": true, "$ref": "#/components/schemas/XingtuAnchorPriceType" }, "description": "Live-stream price type, fixed to 9; used only in combination with price_min/price_max", "example": 9 }, { "name": "price_min", "in": "query", "required": false, "schema": { "description": "Minimum anchor price; price_type must also be provided when this field is supplied", "title": "Price Min", "nullable": true, "type": "integer", "minimum": 0 }, "description": "Minimum anchor price; price_type must also be provided when this field is supplied", "example": 1000 }, { "name": "price_max", "in": "query", "required": false, "schema": { "description": "Maximum anchor price; price_type must also be provided when this field is supplied", "title": "Price Max", "nullable": true, "type": "integer", "minimum": 0 }, "description": "Maximum anchor price; price_type must also be provided when this field is supplied", "example": 100000 }, { "name": "tag", "in": "query", "required": false, "schema": { "description": "Creator category IDs, comma-separated, e.g. `1,6`", "title": "Tag", "nullable": true, "type": "string" }, "description": "Creator category IDs, comma-separated, e.g. `1,6`", "example": "1" }, { "name": "persona_tags", "in": "query", "required": false, "schema": { "description": "Persona IDs (persona/education/certification/tone). Comma=match any; semicolon=group AND, e.g. `1129,110401;110213`", "title": "Persona Tags", "nullable": true, "type": "string" }, "description": "Persona IDs (persona/education/certification/tone). Comma=match any; semicolon=group AND, e.g. `1129,110401;110213`", "example": "1129,110401" }, { "name": "gender", "in": "query", "required": false, "schema": { "description": "Creator gender, 1=male, 2=female", "title": "Gender", "nullable": true, "type": "integer" }, "description": "Creator gender, 1=male, 2=female", "example": 2 }, { "name": "fans_min", "in": "query", "required": false, "schema": { "description": "Minimum followers", "title": "Fans Min", "nullable": true, "type": "integer" }, "description": "Minimum followers", "example": 10000 }, { "name": "fans_max", "in": "query", "required": false, "schema": { "description": "Maximum followers", "title": "Fans Max", "nullable": true, "type": "integer" }, "description": "Maximum followers", "example": 1000000 }, { "name": "expected_play_min", "in": "query", "required": false, "schema": { "description": "Minimum expected plays", "title": "Expected Play Min", "nullable": true, "type": "integer" }, "description": "Minimum expected plays", "example": 100000 }, { "name": "expected_play_max", "in": "query", "required": false, "schema": { "description": "Maximum expected plays", "title": "Expected Play Max", "nullable": true, "type": "integer" }, "description": "Maximum expected plays", "example": 1000000 }, { "name": "cpm_min", "in": "query", "required": false, "schema": { "description": "Minimum expected CPM", "title": "Cpm Min", "nullable": true, "type": "number" }, "description": "Minimum expected CPM", "example": 10 }, { "name": "cpm_max", "in": "query", "required": false, "schema": { "description": "Maximum expected CPM", "title": "Cpm Max", "nullable": true, "type": "number" }, "description": "Maximum expected CPM", "example": 100 }, { "name": "cpe_min", "in": "query", "required": false, "schema": { "description": "Minimum expected CPE", "title": "Cpe Min", "nullable": true, "type": "number" }, "description": "Minimum expected CPE", "example": 0.1 }, { "name": "cpe_max", "in": "query", "required": false, "schema": { "description": "Maximum expected CPE", "title": "Cpe Max", "nullable": true, "type": "number" }, "description": "Maximum expected CPE", "example": 5 }, { "name": "interact_rate_min", "in": "query", "required": false, "schema": { "description": "Minimum interaction rate, 0-1 decimal (e.g. 0.02=2%)", "title": "Interact Rate Min", "nullable": true, "type": "number" }, "description": "Minimum interaction rate, 0-1 decimal (e.g. 0.02=2%)", "example": 0.02 }, { "name": "interact_rate_max", "in": "query", "required": false, "schema": { "description": "Maximum interaction rate, 0-1 decimal", "title": "Interact Rate Max", "nullable": true, "type": "number" }, "description": "Maximum interaction rate, 0-1 decimal", "example": 0.5 }, { "name": "play_over_rate_min", "in": "query", "required": false, "schema": { "description": "Minimum play-completion rate, 0-1 decimal", "title": "Play Over Rate Min", "nullable": true, "type": "number" }, "description": "Minimum play-completion rate, 0-1 decimal", "example": 0.05 }, { "name": "play_over_rate_max", "in": "query", "required": false, "schema": { "description": "Maximum play-completion rate, 0-1 decimal", "title": "Play Over Rate Max", "nullable": true, "type": "number" }, "description": "Maximum play-completion rate, 0-1 decimal", "example": 0.9 }, { "name": "burst_text_rate_min", "in": "query", "required": false, "schema": { "description": "Minimum viral-post rate, 0-1 decimal", "title": "Burst Text Rate Min", "nullable": true, "type": "number" }, "description": "Minimum viral-post rate, 0-1 decimal", "example": 0.1 }, { "name": "burst_text_rate_max", "in": "query", "required": false, "schema": { "description": "Maximum viral-post rate, 0-1 decimal", "title": "Burst Text Rate Max", "nullable": true, "type": "number" }, "description": "Maximum viral-post rate, 0-1 decimal", "example": 0.8 }, { "name": "extra_filter", "in": "query", "required": false, "schema": { "description": "Extra profile filters as a JSON-array string; field_name and field_value must be non-empty strings", "title": "Extra Filter", "nullable": true, "type": "string" }, "description": "Extra profile filters as a JSON-array string; field_name and field_value must be non-empty strings", "example": "[{\"field_name\":\"content_theme_labels_180d\",\"field_value\":\"[\\\"lifestyle-product-review\\\"]\"},{\"field_name\":\"watcher_gender_female_rate_v2__ge\",\"field_value\":\"0.6\"},{\"field_name\":\"link_crowd_profile\",\"field_value\":\"[60,55,53,57]\"}]" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/search_creator": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_search_creator", "summary": "Search Creator", "description": "Search Creator", "parameters": [ { "name": "keyword", "in": "query", "required": false, "schema": { "type": "string", "description": "Optional keyword; empty means filter-only browsing. seach_type=2 matches nickname, =3 matches content", "default": "", "title": "Keyword" }, "description": "Optional keyword; empty means filter-only browsing. seach_type=2 matches nickname, =3 matches content", "example": "Fitness" }, { "name": "seach_type", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/XingtuCreatorSearchType", "description": "Search mode: 2=by nickname, 3=by content", "default": 2 }, "description": "Search mode: 2=by nickname, 3=by content", "example": 2 }, { "name": "time_range_days", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/XingtuContentSearchTimeRange", "description": "Content time range; only effective when seach_type=3", "default": 180 }, "description": "Content time range; only effective when seach_type=3", "example": 180 }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "sort_field", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort field, default score (comprehensive)", "default": "score", "title": "Sort Field" }, "description": "Sort field, default score (comprehensive)", "example": "score" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type: 1=asc, 2=desc", "default": 2, "title": "Sort Type" }, "description": "Sort type: 1=asc, 2=desc", "example": 2 }, { "name": "task_category", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cooperation target", "default": 1, "title": "Task Category" }, "description": "Cooperation target", "example": 1 }, { "name": "marketing_target", "in": "query", "required": false, "schema": { "type": "integer", "description": "Marketing target", "default": 1, "title": "Marketing Target" }, "description": "Marketing target", "example": 1 }, { "name": "first_industry_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "Industry ID, 0=unlimited", "default": 0, "title": "First Industry Id" }, "description": "Industry ID, 0=unlimited", "example": 0 }, { "name": "author_list_id", "in": "query", "required": false, "schema": { "description": "Featured creator list ID", "title": "Author List Id", "nullable": true, "type": "string" }, "description": "Featured creator list ID" }, { "name": "price_type", "in": "query", "required": false, "schema": { "description": "Creator video price tier: 1=1-20 seconds, 2=21-60 seconds, 3=60 seconds or above; used only in combination with price_min/price_max", "title": "Price Type", "nullable": true, "$ref": "#/components/schemas/XingtuCreatorPriceType" }, "description": "Creator video price tier: 1=1-20 seconds, 2=21-60 seconds, 3=60 seconds or above; used only in combination with price_min/price_max", "example": 2 }, { "name": "price_min", "in": "query", "required": false, "schema": { "description": "Minimum creator price; must be provided together with price_type", "title": "Price Min", "nullable": true, "type": "integer", "minimum": 0 }, "description": "Minimum creator price; must be provided together with price_type", "example": 1000 }, { "name": "price_max", "in": "query", "required": false, "schema": { "description": "Maximum creator price; must be provided together with price_type", "title": "Price Max", "nullable": true, "type": "integer", "minimum": 0 }, "description": "Maximum creator price; must be provided together with price_type", "example": 100000 }, { "name": "tag", "in": "query", "required": false, "schema": { "description": "Creator category IDs, comma-separated, e.g. `1,6`", "title": "Tag", "nullable": true, "type": "string" }, "description": "Creator category IDs, comma-separated, e.g. `1,6`", "example": "1" }, { "name": "persona_tags", "in": "query", "required": false, "schema": { "description": "Persona IDs (persona/education/certification/tone). Comma=match any; semicolon=group AND, e.g. `1129,110401;110213`", "title": "Persona Tags", "nullable": true, "type": "string" }, "description": "Persona IDs (persona/education/certification/tone). Comma=match any; semicolon=group AND, e.g. `1129,110401;110213`", "example": "1129,110401" }, { "name": "gender", "in": "query", "required": false, "schema": { "description": "Creator gender, 1=male, 2=female", "title": "Gender", "nullable": true, "type": "integer" }, "description": "Creator gender, 1=male, 2=female", "example": 2 }, { "name": "fans_min", "in": "query", "required": false, "schema": { "description": "Minimum followers", "title": "Fans Min", "nullable": true, "type": "integer" }, "description": "Minimum followers", "example": 10000 }, { "name": "fans_max", "in": "query", "required": false, "schema": { "description": "Maximum followers", "title": "Fans Max", "nullable": true, "type": "integer" }, "description": "Maximum followers", "example": 1000000 }, { "name": "expected_play_min", "in": "query", "required": false, "schema": { "description": "Minimum expected plays", "title": "Expected Play Min", "nullable": true, "type": "integer" }, "description": "Minimum expected plays", "example": 100000 }, { "name": "expected_play_max", "in": "query", "required": false, "schema": { "description": "Maximum expected plays", "title": "Expected Play Max", "nullable": true, "type": "integer" }, "description": "Maximum expected plays", "example": 1000000 }, { "name": "cpm_min", "in": "query", "required": false, "schema": { "description": "Minimum expected CPM", "title": "Cpm Min", "nullable": true, "type": "number" }, "description": "Minimum expected CPM", "example": 10 }, { "name": "cpm_max", "in": "query", "required": false, "schema": { "description": "Maximum expected CPM", "title": "Cpm Max", "nullable": true, "type": "number" }, "description": "Maximum expected CPM", "example": 100 }, { "name": "cpe_min", "in": "query", "required": false, "schema": { "description": "Minimum expected CPE", "title": "Cpe Min", "nullable": true, "type": "number" }, "description": "Minimum expected CPE", "example": 0.1 }, { "name": "cpe_max", "in": "query", "required": false, "schema": { "description": "Maximum expected CPE", "title": "Cpe Max", "nullable": true, "type": "number" }, "description": "Maximum expected CPE", "example": 5 }, { "name": "interact_rate_min", "in": "query", "required": false, "schema": { "description": "Minimum interaction rate, 0-1 decimal (e.g. 0.02=2%)", "title": "Interact Rate Min", "nullable": true, "type": "number" }, "description": "Minimum interaction rate, 0-1 decimal (e.g. 0.02=2%)", "example": 0.02 }, { "name": "interact_rate_max", "in": "query", "required": false, "schema": { "description": "Maximum interaction rate, 0-1 decimal", "title": "Interact Rate Max", "nullable": true, "type": "number" }, "description": "Maximum interaction rate, 0-1 decimal", "example": 0.5 }, { "name": "play_over_rate_min", "in": "query", "required": false, "schema": { "description": "Minimum play-completion rate, 0-1 decimal", "title": "Play Over Rate Min", "nullable": true, "type": "number" }, "description": "Minimum play-completion rate, 0-1 decimal", "example": 0.05 }, { "name": "play_over_rate_max", "in": "query", "required": false, "schema": { "description": "Maximum play-completion rate, 0-1 decimal", "title": "Play Over Rate Max", "nullable": true, "type": "number" }, "description": "Maximum play-completion rate, 0-1 decimal", "example": 0.9 }, { "name": "burst_text_rate_min", "in": "query", "required": false, "schema": { "description": "Minimum viral-post rate, 0-1 decimal", "title": "Burst Text Rate Min", "nullable": true, "type": "number" }, "description": "Minimum viral-post rate, 0-1 decimal", "example": 0.1 }, { "name": "burst_text_rate_max", "in": "query", "required": false, "schema": { "description": "Maximum viral-post rate, 0-1 decimal", "title": "Burst Text Rate Max", "nullable": true, "type": "number" }, "description": "Maximum viral-post rate, 0-1 decimal", "example": 0.8 }, { "name": "extra_filter", "in": "query", "required": false, "schema": { "description": "Extra profile filters as a JSON-array string; field_name and field_value must be non-empty strings", "title": "Extra Filter", "nullable": true, "type": "string" }, "description": "Extra profile filters as a JSON-array string; field_name and field_value must be non-empty strings", "example": "[{\"field_name\":\"content_theme_labels_180d\",\"field_value\":\"[\\\"lifestyle-product-review\\\"]\"},{\"field_name\":\"watcher_gender_female_rate_v2__ge\",\"field_value\":\"0.6\"},{\"field_name\":\"link_crowd_profile\",\"field_value\":\"[60,55,53,57]\"}]" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu/search_kol_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_search_kol_v2", "summary": "Search Kol Advanced V2", "description": "Search Kol Advanced V2", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "Beauty" }, { "name": "followerRange", "in": "query", "required": false, "schema": { "type": "string", "description": "Follower Range (optional), e.g. 10-100 means 100K-1M followers", "title": "Followerrange" }, "description": "Follower Range (optional), e.g. 10-100 means 100K-1M followers", "example": "10-100" }, { "name": "contentTag", "in": "query", "required": false, "schema": { "type": "string", "description": "Content Tag (optional), e.g. tag-1 or tag_level_two-7", "title": "Contenttag" }, "description": "Content Tag (optional), e.g. tag-1 or tag_level_two-7", "example": "tag-1" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/douyin/xingtu_v2/search_toutiao_creator": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_search_toutiao_creator", "summary": "Search Toutiao Creator", "description": "Search Toutiao Creator", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword: nickname, Toutiao ID or content word", "title": "Keyword" }, "description": "Search keyword: nickname, Toutiao ID or content word", "example": "Electronics" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 }, { "name": "sort_field", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort field, default score (comprehensive)", "default": "score", "title": "Sort Field" }, "description": "Sort field, default score (comprehensive)", "example": "score" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort type: 1=asc, 2=desc", "default": 2, "title": "Sort Type" }, "description": "Sort type: 1=asc, 2=desc", "example": 2 }, { "name": "task_category", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cooperation target", "default": 11, "title": "Task Category" }, "description": "Cooperation target", "example": 11 }, { "name": "marketing_target", "in": "query", "required": false, "schema": { "type": "integer", "description": "Marketing target", "default": 1, "title": "Marketing Target" }, "description": "Marketing target", "example": 1 }, { "name": "first_industry_id", "in": "query", "required": false, "schema": { "description": "Industry ID", "title": "First Industry Id", "nullable": true, "type": "integer" }, "description": "Industry ID" }, { "name": "author_list_id", "in": "query", "required": false, "schema": { "description": "Featured creator list ID", "title": "Author List Id", "nullable": true, "type": "string" }, "description": "Featured creator list ID" }, { "name": "price_type", "in": "query", "required": false, "schema": { "description": "Toutiao image-text price type, fixed to 11; only used together with price_min/price_max", "title": "Price Type", "nullable": true, "$ref": "#/components/schemas/XingtuToutiaoPriceType" }, "description": "Toutiao image-text price type, fixed to 11; only used together with price_min/price_max", "example": 11 }, { "name": "price_min", "in": "query", "required": false, "schema": { "description": "Minimum image-text price; must be provided together with price_type", "title": "Price Min", "nullable": true, "type": "integer", "minimum": 0 }, "description": "Minimum image-text price; must be provided together with price_type", "example": 1000 }, { "name": "price_max", "in": "query", "required": false, "schema": { "description": "Maximum image-text price; must be provided together with price_type", "title": "Price Max", "nullable": true, "type": "integer", "minimum": 0 }, "description": "Maximum image-text price; must be provided together with price_type", "example": 100000 }, { "name": "tag", "in": "query", "required": false, "schema": { "description": "Creator category IDs, comma-separated, e.g. `1,6`", "title": "Tag", "nullable": true, "type": "string" }, "description": "Creator category IDs, comma-separated, e.g. `1,6`", "example": "1" }, { "name": "persona_tags", "in": "query", "required": false, "schema": { "description": "Persona IDs (persona/education/certification/tone). Comma=match any; semicolon=group AND, e.g. `1129,110401;110213`", "title": "Persona Tags", "nullable": true, "type": "string" }, "description": "Persona IDs (persona/education/certification/tone). Comma=match any; semicolon=group AND, e.g. `1129,110401;110213`", "example": "1129,110401" }, { "name": "gender", "in": "query", "required": false, "schema": { "description": "Creator gender, 1=male, 2=female", "title": "Gender", "nullable": true, "type": "integer" }, "description": "Creator gender, 1=male, 2=female", "example": 2 }, { "name": "fans_min", "in": "query", "required": false, "schema": { "description": "Minimum followers", "title": "Fans Min", "nullable": true, "type": "integer" }, "description": "Minimum followers", "example": 10000 }, { "name": "fans_max", "in": "query", "required": false, "schema": { "description": "Maximum followers", "title": "Fans Max", "nullable": true, "type": "integer" }, "description": "Maximum followers", "example": 1000000 }, { "name": "expected_play_min", "in": "query", "required": false, "schema": { "description": "Minimum expected plays", "title": "Expected Play Min", "nullable": true, "type": "integer" }, "description": "Minimum expected plays", "example": 100000 }, { "name": "expected_play_max", "in": "query", "required": false, "schema": { "description": "Maximum expected plays", "title": "Expected Play Max", "nullable": true, "type": "integer" }, "description": "Maximum expected plays", "example": 1000000 }, { "name": "cpm_min", "in": "query", "required": false, "schema": { "description": "Minimum expected CPM", "title": "Cpm Min", "nullable": true, "type": "number" }, "description": "Minimum expected CPM", "example": 10 }, { "name": "cpm_max", "in": "query", "required": false, "schema": { "description": "Maximum expected CPM", "title": "Cpm Max", "nullable": true, "type": "number" }, "description": "Maximum expected CPM", "example": 100 }, { "name": "cpe_min", "in": "query", "required": false, "schema": { "description": "Minimum expected CPE", "title": "Cpe Min", "nullable": true, "type": "number" }, "description": "Minimum expected CPE", "example": 0.1 }, { "name": "cpe_max", "in": "query", "required": false, "schema": { "description": "Maximum expected CPE", "title": "Cpe Max", "nullable": true, "type": "number" }, "description": "Maximum expected CPE", "example": 5 }, { "name": "interact_rate_min", "in": "query", "required": false, "schema": { "description": "Minimum interaction rate, 0-1 decimal (e.g. 0.02=2%)", "title": "Interact Rate Min", "nullable": true, "type": "number" }, "description": "Minimum interaction rate, 0-1 decimal (e.g. 0.02=2%)", "example": 0.02 }, { "name": "interact_rate_max", "in": "query", "required": false, "schema": { "description": "Maximum interaction rate, 0-1 decimal", "title": "Interact Rate Max", "nullable": true, "type": "number" }, "description": "Maximum interaction rate, 0-1 decimal", "example": 0.5 }, { "name": "play_over_rate_min", "in": "query", "required": false, "schema": { "description": "Minimum play-completion rate, 0-1 decimal", "title": "Play Over Rate Min", "nullable": true, "type": "number" }, "description": "Minimum play-completion rate, 0-1 decimal", "example": 0.05 }, { "name": "play_over_rate_max", "in": "query", "required": false, "schema": { "description": "Maximum play-completion rate, 0-1 decimal", "title": "Play Over Rate Max", "nullable": true, "type": "number" }, "description": "Maximum play-completion rate, 0-1 decimal", "example": 0.9 }, { "name": "burst_text_rate_min", "in": "query", "required": false, "schema": { "description": "Minimum viral-post rate, 0-1 decimal", "title": "Burst Text Rate Min", "nullable": true, "type": "number" }, "description": "Minimum viral-post rate, 0-1 decimal", "example": 0.1 }, { "name": "burst_text_rate_max", "in": "query", "required": false, "schema": { "description": "Maximum viral-post rate, 0-1 decimal", "title": "Burst Text Rate Max", "nullable": true, "type": "number" }, "description": "Maximum viral-post rate, 0-1 decimal", "example": 0.8 }, { "name": "extra_filter", "in": "query", "required": false, "schema": { "description": "Extra profile filters as a JSON-array string; field_name and field_value must be non-empty strings", "title": "Extra Filter", "nullable": true, "type": "string" }, "description": "Extra profile filters as a JSON-array string; field_name and field_value must be non-empty strings", "example": "[{\"field_name\":\"content_theme_labels_180d\",\"field_value\":\"[\\\"lifestyle-product-review\\\"]\"},{\"field_name\":\"watcher_gender_female_rate_v2__ge\",\"field_value\":\"0.6\"},{\"field_name\":\"link_crowd_profile\",\"field_value\":\"[60,55,53,57]\"}]" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/ads/get_ad_interactive_analysis": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_ad_interactive_analysis", "summary": "Get ad interactive analysis", "description": "Get ad interactive analysis", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_ad_interactive_analysis_api_v1_tiktok_ads_get_ad_interactive_analysis_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/ads/get_ad_keyframe_analysis": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_ad_keyframe_analysis", "summary": "Get ad keyframe analysis", "description": "Get ad keyframe analysis", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_ad_keyframe_analysis_api_v1_tiktok_ads_get_ad_keyframe_analysis_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/ads/get_ad_percentile": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_ad_percentile", "summary": "Get ad percentile data", "description": "Get ad percentile data", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_ad_percentile_api_v1_tiktok_ads_get_ad_percentile_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/ads/get_ads_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_ads_detail", "summary": "Get single ad detail", "description": "Get single ad detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_ads_detail_api_v1_tiktok_ads_get_ads_detail_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/ads/get_configure_safety": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_configure_safety", "summary": "Get search modules config", "description": "Get search modules config", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/ads/get_creators_card": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_creators_card", "summary": "Get creators card", "description": "Get creators card", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_creators_card_api_v1_tiktok_ads_get_creators_card_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/ads/get_location_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_location_list", "summary": "Get supported location list", "description": "Get supported location list", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/ads/get_query_suggestions": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_query_suggestions", "summary": "Get query suggestions", "description": "Get query suggestions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_query_suggestions_api_v1_tiktok_ads_get_query_suggestions_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/ads/get_recommended_ads": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_recommended_ads", "summary": "Get recommended ads", "description": "Get recommended ads", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_recommended_ads_api_v1_tiktok_ads_get_recommended_ads_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/ads/get_top_ads_filters": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_top_ads_filters", "summary": "Get Top Ads filters", "description": "Get Top Ads filters", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "title": "Cookie", "description": "Custom Cookie string (optional)" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/ads/get_top_ads_spotlight": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_top_ads_spotlight", "summary": "Get top ads spotlight", "description": "Get top ads spotlight", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_top_ads_spotlight_api_v1_tiktok_ads_get_top_ads_spotlight_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/ads/get_top_contents_item_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_top_contents_item_detail", "summary": "Get top contents item detail", "description": "Get top contents item detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_top_contents_item_detail_api_v1_tiktok_ads_get_top_contents_item_detail_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/ads/get_top_contents_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_top_contents_list", "summary": "Get top contents list", "description": "Get top contents list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_top_contents_list_api_v1_tiktok_ads_get_top_contents_list_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/ads/get_trends_hashtag_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_trends_hashtag_detail", "summary": "Get trending hashtag detail", "description": "Get trending hashtag detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_trends_hashtag_detail_api_v1_tiktok_ads_get_trends_hashtag_detail_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/ads/get_trends_hashtag_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_get_trends_hashtag_list", "summary": "Get trending hashtag list", "description": "Get trending hashtag list", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_get_trends_hashtag_list_api_v1_tiktok_ads_get_trends_hashtag_list_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/ads/search_ads": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_ads_search_ads", "summary": "Search ads", "description": "Search ads", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_search_ads_api_v1_tiktok_ads_search_ads_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/analytics/detect_fake_views": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_analytics_detect_fake_views", "summary": "Detect fake views in video", "description": "Detect fake views in video", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Item Id" }, "description": "Video ID", "example": "7460937381265411370" }, { "name": "content_category", "in": "query", "required": false, "schema": { "type": "string", "description": "Content category, options: default, entertainment, education, product, verified_large", "default": "default", "title": "Content Category" }, "description": "Content category, options: default, entertainment, education, product, verified_large" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/analytics/fetch_comment_keywords": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_analytics_fetch_comment_keywords", "summary": "Get comment keywords analysis", "description": "Get comment keywords analysis", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Item Id" }, "description": "Video ID", "example": "7502551047378832671" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/analytics/fetch_creator_info_and_milestones": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_analytics_fetch_creator_info_and_milestones", "summary": "Get creator info and milestones", "description": "Get creator info and milestones", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "User Id" }, "description": "User id", "example": "107955" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/analytics/fetch_video_metrics": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_analytics_fetch_video_metrics", "summary": "Get video metrics", "description": "Get video metrics", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Item Id" }, "description": "Video ID", "example": "7502551047378832671" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/creator/get_account_health_status": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_account_health_status", "summary": "Get Creator Account Health Status", "description": "Get Creator Account Health Status", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccountHealthRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_account_insights_overview": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_account_insights_overview", "summary": "Get Creator Account Overview", "description": "Get Creator Account Overview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccountOverviewRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_account_violation_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_account_violation_list", "summary": "Get Creator Account Violation Record List", "description": "Get Creator Account Violation Record List", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetViolationRecordRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_creator_account_info": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_creator_account_info", "summary": "Get Creator Account Info", "description": "Get Creator Account Info", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCreatorAccountInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_live_analytics_summary": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_live_analytics_summary", "summary": "Get Creator Live Overview", "description": "Get Creator Live Overview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLiveOverviewRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_product_analytics_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_product_analytics_list", "summary": "Get Creator Product List Analytics", "description": "Get Creator Product List Analytics", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductListRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_product_related_videos": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_product_related_videos", "summary": "Get Product Related Videos", "description": "Get Product Related Videos", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductRelatedVideosRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_showcase_product_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_showcase_product_list", "summary": "Get Showcase Product List", "description": "Get Showcase Product List", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetShowcaseProductListRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_video_analytics_summary": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_video_analytics_summary", "summary": "Get Creator Video Overview", "description": "Get Creator Video Overview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVideoOverviewRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_video_associated_product_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_video_associated_product_list", "summary": "Get Video Associated Product List", "description": "Get Video Associated Product List", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVideoAssociatedProductListRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_video_audience_stats": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_video_audience_stats", "summary": "Get Video Audience Analysis Data", "description": "Get Video Audience Analysis Data", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVideoAudienceStatsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_video_detailed_stats": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_video_detailed_stats", "summary": "Get Video Detailed Statistics", "description": "Get Video Detailed Statistics", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVideoDetailedStatsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_video_list_analytics": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_video_list_analytics", "summary": "Get Creator Video List Analytics", "description": "Get Creator Video List Analytics", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVideoListRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/creator/get_video_to_product_stats": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_creator_get_video_to_product_stats", "summary": "Get Video-Product Association Statistics", "description": "Get Video-Product Association Statistics", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetVideoToProductStatsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/shop/web/fetch_hot_selling_products_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_hot_selling_products_list", "summary": "[Deprecated] Get hot selling products list", "description": "[Deprecated] Get hot selling products list", "parameters": [ { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code", "default": "US", "title": "Region" }, "description": "Region code", "example": "US" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of products to return, default 20", "default": 20, "title": "Count" }, "description": "Number of products to return, default 20", "example": 20 }, { "name": "exclude_product_ids", "in": "query", "required": false, "schema": { "type": "string", "description": "Comma-separated product IDs you already have, used for paging", "default": "", "title": "Exclude Product Ids" }, "description": "Comma-separated product IDs you already have, used for paging", "example": "1731128793906516409,1732305963897557680" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/shop/web/fetch_product_detail_v3": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_product_detail_v3", "summary": "Get product detail V3 (Full Data)", "description": "Get product detail V3 (Full Data)", "parameters": [ { "name": "product_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Product ID", "title": "Product Id" }, "description": "Product ID", "example": "1732108663255959373" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code", "default": "SG", "title": "Region" }, "description": "Region code", "example": "SG" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/shop/web/fetch_product_id_by_share_link": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_product_id_by_share_link", "summary": "Get Product ID by Share Link", "description": "Get Product ID by Share Link", "parameters": [ { "name": "share_link", "in": "query", "required": true, "schema": { "type": "string", "description": "Share link", "title": "Share Link" }, "description": "Share link", "example": "https://affiliate-us.tiktok.com/api/v1/share/AJ4hS3OdXmSg" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/shop/web/fetch_product_reviews_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_product_reviews_v2", "summary": "Get product reviews V2", "description": "Get product reviews V2", "parameters": [ { "name": "product_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Product ID", "title": "Product Id" }, "description": "Product ID", "example": "1729408816995078528" }, { "name": "page_start", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page start", "default": 1, "title": "Page Start" }, "description": "Page start", "example": 1 }, { "name": "sort_rule", "in": "query", "required": false, "schema": { "type": "integer", "description": "Sort order: 1=Recommended, 2=Most recent", "default": 2, "title": "Sort Rule" }, "description": "Sort order: 1=Recommended, 2=Most recent", "example": 2 }, { "name": "filter_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter type: 1=All, 2=With images or videos, 3=Verified purchase", "default": 1, "title": "Filter Type" }, "description": "Filter type: 1=All, 2=With images or videos, 3=Verified purchase", "example": 1 }, { "name": "filter_value", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter value: For filter_type=1, 6=all and 5-1=star rating; use 1 for filter_type=2 or 3", "default": 6, "title": "Filter Value" }, "description": "Filter value: For filter_type=1, 6=all and 5-1=star rating; use 1 for filter_type=2 or 3", "example": 6 }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code", "default": "US", "title": "Region" }, "description": "Region code", "example": "US" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/shop/web/fetch_products_by_category_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_products_by_category_id", "summary": "Get products by category ID", "description": "Get products by category ID", "parameters": [ { "name": "category_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Category ID", "title": "Category Id" }, "description": "Category ID", "example": 963976 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset for pagination", "default": 0, "title": "Offset" }, "description": "Offset for pagination", "example": 0 }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code", "default": "US", "title": "Region" }, "description": "Region code", "example": "US" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/shop/web/fetch_products_category_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_products_category_list", "summary": "Get product category list", "description": "Get product category list", "parameters": [ { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code", "default": "US", "title": "Region" }, "description": "Region code", "example": "US" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/shop/web/fetch_search_products_list_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_search_products_list_v2", "summary": "Search products list V2 (Mobile)", "description": "Search products list V2 (Mobile)", "parameters": [ { "name": "search_word", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Search Word" }, "description": "Search keyword", "example": "labubu" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset", "example": 0 }, { "name": "page_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Page token", "default": "", "title": "Page Token" }, "description": "Page token", "example": "" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code", "default": "US", "title": "Region" }, "description": "Region code", "example": "US" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/shop/web/fetch_search_word_suggestion_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_search_word_suggestion_v2", "summary": "Get search keyword suggestions V2 (Mobile)", "description": "Get search keyword suggestions V2 (Mobile)", "parameters": [ { "name": "search_word", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Search Word" }, "description": "Search keyword", "example": "labubu" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string", "description": "Language", "default": "en-US", "title": "Lang" }, "description": "Language", "example": "en-US" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code", "default": "US", "title": "Region" }, "description": "Region code", "example": "US" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/tiktok/shop/web/fetch_seller_products_list_v2": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_seller_products_list_v2", "summary": "Get seller products list V2 (Mobile)", "description": "Get seller products list V2 (Mobile)", "parameters": [ { "name": "seller_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Seller ID", "title": "Seller Id" }, "description": "Seller ID", "example": "7495150558072178725" }, { "name": "searchParams", "in": "query", "required": false, "schema": { "type": "string", "description": "Search params", "default": "", "title": "Searchparams" }, "description": "Search params", "example": "" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code", "default": "US", "title": "Region" }, "description": "Region code", "example": "US" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/shop/web/fetch_shop_id_by_share_link": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "get_tikhub_tiktok_shop_web_fetch_shop_id_by_share_link", "summary": "Get Shop ID by Share Link", "description": "Get Shop ID by Share Link", "parameters": [ { "name": "share_link", "in": "query", "required": true, "schema": { "type": "string", "description": "Share link", "title": "Share Link" }, "description": "Share link", "example": "https://vt.tiktok.com/ZT2AHoGsE/" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_core_data": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_core_data", "summary": "Get PGY blogger core data trend", "description": "Get PGY blogger core data trend", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoreDataReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_data_summary": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_data_summary", "summary": "Get PGY blogger data summary", "description": "Get PGY blogger data summary", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSummaryReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_detail", "summary": "Get PGY blogger detail", "description": "Get PGY blogger detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserIdReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_fans_history": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_fans_history", "summary": "Get PGY blogger fans growth history", "description": "Get PGY blogger fans growth history", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FansHistoryReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_fans_profile": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_fans_profile", "summary": "Get PGY blogger fans profile", "description": "Get PGY blogger fans profile", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserIdReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_fans_summary": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_fans_summary", "summary": "Get PGY blogger fans summary", "description": "Get PGY blogger fans summary", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserIdReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_filter_options": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_filter_options", "summary": "Get PGY blogger filter options", "description": "Get PGY blogger filter options", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" } } } } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_list", "summary": "PGY note blogger square", "description": "PGY note blogger square", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BloggerListReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_notes_v2": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_notes_v2", "summary": "Get PGY blogger note cases v2 (cross-platform)", "description": "Get PGY blogger note cases v2 (cross-platform)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotesV2Req" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_notes_rate": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_notes_rate", "summary": "Get PGY blogger performance metrics", "description": "Get PGY blogger performance metrics", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotesRateReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_blogger_similar": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_blogger_similar", "summary": "Get PGY similar bloggers", "description": "Get PGY similar bloggers", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_content_square": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_content_square", "summary": "PGY content square leaderboards", "description": "PGY content square leaderboards", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentSquareReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_keyword_daily": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_keyword_daily", "summary": "PGY keyword daily trend", "description": "PGY keyword daily trend", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_keyword_related": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_keyword_related", "summary": "PGY related keywords", "description": "PGY related keywords", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_keyword_stat": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_keyword_stat", "summary": "PGY keyword overview", "description": "PGY keyword overview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeywordReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_live_blogger_list": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_live_blogger_list", "summary": "PGY live blogger square", "description": "PGY live blogger square", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveBloggerReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_note_comments": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_note_comments", "summary": "Get PGY note featured comments", "description": "Get PGY note featured comments", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDetailReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_note_components": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.000145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_note_components", "summary": "Get PGY note components", "description": "Get PGY note components", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDetailReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xiaohongshu/pgy/get_note_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xiaohongshu" ], "operationId": "post_tikhub_xiaohongshu_pgy_get_note_detail", "summary": "Get PGY note detail", "description": "Get PGY note detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDetailReq" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/bilibili/web/fetch_one_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_one_video", "summary": "Get single video data", "description": "Get single video data", "parameters": [ { "name": "bv_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Bv Id" }, "description": "Video id", "example": "BV1M1421t7hT" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/bilibili/web/fetch_video_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Bilibili" ], "operationId": "get_tikhub_bilibili_web_fetch_video_comments", "summary": "Get comments on the specified video", "description": "Get comments on the specified video", "parameters": [ { "name": "bv_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Bv Id" }, "description": "Video id", "example": "BV1M1421t7hT" }, { "name": "pn", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Pn" }, "description": "Page number" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/douplus/fetch_delivery_effect_estimate": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_douplus_fetch_delivery_effect_estimate", "summary": "Get DOU+ estimated delivery results", "description": "Get DOU+ estimated delivery results", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryEffectEstimateRequest" }, "example": { "item_ids": "7677202522116819185", "external_action": 44, "target_id": 31, "schema": 0, "is_max_cv": true, "pay_type": 1, "cost_int": 30000, "duration_seconds": 21600 } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_multi_video": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_fetch_multi_video", "summary": "Batch Get Video Information", "description": "Batch Get Video Information", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "title": "Aweme Ids" }, "example": [ "7372484719365098803", "7126745726494821640", "7372484719365098803", "7126745726494821640", "7372484719365098803", "7126745726494821640", "7372484719365098803", "7126745726494821640", "7372484719365098803", "7126745726494821640" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_multi_video_high_quality_play_url": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.3625, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_fetch_multi_video_high_quality_play_url", "summary": "Batch get the highest quality play URL of videos", "description": "Batch get the highest quality play URL of videos", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchMultiVideoHighQualityPlayUrlRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_one_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_one_video", "summary": "Get single video data", "description": "Get single video data", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Aweme Id" }, "description": "Video id", "example": "7372484719365098803" }, { "name": "need_anchor_info", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether anchor information is needed", "default": false, "title": "Need Anchor Info" }, "description": "Whether anchor information is needed", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_one_video_by_share_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_one_video_by_share_url", "summary": "Get single video data by sharing link", "description": "Get single video data by sharing link", "parameters": [ { "name": "share_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Share link", "title": "Share Url" }, "description": "Share link", "example": "https://v.douyin.com/e3x2fjE/" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_user_fans_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_fans_list", "summary": "Get user fans list", "description": "Get user fans list", "parameters": [ { "name": "sec_user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User sec_user_id", "default": "MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70", "title": "Sec User Id" }, "description": "User sec_user_id" }, { "name": "max_time", "in": "query", "required": false, "schema": { "type": "string", "description": "Maximum timestamp", "default": "0", "title": "Max Time" }, "description": "Maximum timestamp" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" }, { "name": "source_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Source type", "default": 1, "title": "Source Type" }, "description": "Source type" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_user_like_videos": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "post_tikhub_douyin_web_fetch_user_like_videos", "summary": "Get user like video data", "description": "Get user like video data", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_user_like_videos_api_v1_douyin_web_fetch_user_like_videos_post" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_user_post_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_user_post_videos", "summary": "Get user homepage video data", "description": "Get user homepage video data", "parameters": [ { "name": "sec_user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_user_id", "title": "Sec User Id" }, "description": "User sec_user_id", "example": "MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE" }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Maximum cursor", "default": "0", "title": "Max Cursor" }, "description": "Maximum cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number per page", "default": 20, "title": "Count" }, "description": "Number per page" }, { "name": "filter_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter type", "default": "0", "title": "Filter Type" }, "description": "Filter type" }, { "name": "cookie", "in": "query", "required": false, "schema": { "type": "string", "description": "Your web version of Douyin Cookie", "title": "Cookie" }, "description": "Your web version of Douyin Cookie" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_video_comment_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_video_comment_replies", "summary": "Get comment replies data of specified video", "description": "Get comment replies data of specified video", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Item Id" }, "description": "Video id", "example": "7354666303006723354" }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Comment id", "title": "Comment Id" }, "description": "Comment id", "example": "7354669356632638218" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_video_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_video_comments", "summary": "Get single video comments data", "description": "Get single video comments data", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Aweme Id" }, "description": "Video id", "example": "7372484719365098803" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "integer", "description": "Cursor", "default": 0, "title": "Cursor" }, "description": "Cursor" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number", "default": 20, "title": "Count" }, "description": "Number" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/fetch_video_high_quality_play_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_fetch_video_high_quality_play_url", "summary": "Get the highest quality play URL of the video", "description": "Get the highest quality play URL of the video", "parameters": [ { "name": "aweme_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Video id", "title": "Aweme Id" }, "description": "Video id", "example": "7512756548356492544" }, { "name": "share_url", "in": "query", "required": false, "schema": { "type": "string", "description": "Optional, share link", "title": "Share Url" }, "description": "Optional, share link", "example": "https://www.douyin.com/video/7512756548356492544" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Optional, ISO country code (e.g. CN/US/HK). Pass CN to get China-region CDN URLs for faster download in mainland China.", "title": "Region" }, "description": "Optional, ISO country code (e.g. CN/US/HK). Pass CN to get China-region CDN URLs for faster download in mainland China.", "example": "CN" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/web/handler_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_web_handler_user_profile", "summary": "Get information of specified user by sec_user_id", "description": "Get information of specified user by sec_user_id", "parameters": [ { "name": "sec_user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User sec_user_id", "title": "Sec User Id" }, "description": "User sec_user_id", "example": "MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_xingtu_kolid_by_sec_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_xingtu_kolid_by_sec_user_id", "summary": "Get Xingtu Author ID by Douyin sec_user_id", "description": "Get Xingtu Author ID by Douyin sec_user_id", "parameters": [ { "name": "sec_user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin User sec_user_id", "title": "Sec User Id" }, "description": "Douyin User sec_user_id", "example": "MS4wLjABAAAAoxwUZouIdKL6sZ8EB96KDjkrhfBMS1KbCgsMJR1kIUs" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_xingtu_kolid_by_uid": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_xingtu_kolid_by_uid", "summary": "Get Xingtu Author ID by Douyin UID", "description": "Get Xingtu Author ID by Douyin UID", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin User ID (uid", "title": "Uid" }, "description": "Douyin User ID (uid", "example": "70452002324" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/douyin/xingtu_v2/get_xingtu_kolid_by_unique_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Douyin" ], "operationId": "get_tikhub_douyin_xingtu_v2_get_xingtu_kolid_by_unique_id", "summary": "Get Xingtu Author ID by Douyin unique_id", "description": "Get Xingtu Author ID by Douyin unique_id", "parameters": [ { "name": "unique_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Douyin User unique_id", "title": "Unique Id" }, "description": "Douyin User unique_id", "example": "m6640150" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/hybrid/video_data": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Hybrid" ], "operationId": "get_tikhub_hybrid_video_data", "summary": "Hybrid parsing single video endpoint", "description": "Hybrid parsing single video endpoint", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" }, "example": "https://v.douyin.com/L4FJNR3/" }, { "name": "minimal", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to return minimal data", "default": false, "title": "Minimal" }, "description": "Whether to return minimal data" }, { "name": "base64_url", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Base64 encoding URL", "default": false, "title": "Base64 Url" }, "description": "Base64 encoding URL" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_cities": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_cities", "summary": "Get cities by country", "description": "Get cities by country", "parameters": [ { "name": "country_code", "in": "query", "required": true, "schema": { "type": "string", "description": "Country code (e.g. US, CN, JP", "title": "Country Code" }, "description": "Country code (e.g. US, CN, JP", "example": "US" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_explore_sections": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_explore_sections", "summary": "Get explore page sections", "description": "Get explore page sections", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_location_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_location_info", "summary": "Get location info", "description": "Get location info", "parameters": [ { "name": "location_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Location ID", "title": "Location Id" }, "description": "Location ID", "example": "703457703" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_locations": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_locations", "summary": "Get locations by city", "description": "Get locations by city", "parameters": [ { "name": "city_id", "in": "query", "required": true, "schema": { "type": "string", "description": "City ID (from fetch_cities", "title": "City Id" }, "description": "City ID (from fetch_cities", "example": "c2791472" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_post_by_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_post_by_id", "summary": "Get post by ID", "description": "Get post by ID", "parameters": [ { "name": "post_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Post Id" }, "description": "Post ID", "example": "3742637871112032100" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_post_by_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_post_by_url", "summary": "Get post by URL", "description": "Get post by URL", "parameters": [ { "name": "post_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Post URL", "title": "Post Url" }, "description": "Post URL", "example": "https://www.instagram.com/p/DPwhVB-jo9k/" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_related_profiles": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_related_profiles", "summary": "Get related profiles", "description": "Get related profiles", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Instagram user ID", "title": "User Id" }, "description": "Instagram user ID", "example": "25025320" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_search", "summary": "places", "description": "places", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "taylorswift" }, { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "description": "places, omit for all", "title": "Select" }, "description": "places, omit for all" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_section_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_section_posts", "summary": "Get posts by section", "description": "Get posts by section", "parameters": [ { "name": "section_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Section ID (from fetch_explore_sections", "title": "Section Id" }, "description": "Section ID (from fetch_explore_sections", "example": "10156104410190727" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Count per page", "default": 20, "title": "Count" }, "description": "Count per page" }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor for next page", "title": "Max Id" }, "description": "Pagination cursor for next page" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_user_about_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_user_about_info", "summary": "Get user about info", "description": "Get user about info", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Instagram user ID", "title": "User Id" }, "description": "Instagram user ID", "example": "182988865" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_user_info_by_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_user_info_by_id", "summary": "Get user data by user ID", "description": "Get user data by user ID", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Instagram user ID", "title": "User Id" }, "description": "Instagram user ID", "example": "25025320" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_user_info_by_username": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_user_info_by_username", "summary": "Get user data by username", "description": "Get user data by username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Instagram username", "title": "Username" }, "description": "Instagram username", "example": "instagram" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v1/fetch_user_reposts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v1_fetch_user_reposts", "summary": "Get user reposts list", "description": "Get user reposts list", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Instagram user ID", "title": "User Id" }, "description": "Instagram user ID", "example": "25025320" }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor for next page", "title": "Max Id" }, "description": "Pagination cursor for next page" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_comment_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_comment_replies", "summary": "Get comment replies", "description": "Get comment replies", "parameters": [ { "name": "code_or_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Post shortcode or URL", "title": "Code Or Url" }, "description": "Post shortcode or URL", "example": "DRhvwVLAHAG" }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Comment ID", "title": "Comment Id" }, "description": "Comment ID", "example": "18067775592012345" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_hashtag_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_hashtag_posts", "summary": "Get hashtag posts", "description": "Get hashtag posts", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Hashtag keyword (without #", "title": "Keyword" }, "description": "Hashtag keyword (without #", "example": "cat" }, { "name": "feed_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Feed type: top, recent, or reels", "default": "top", "title": "Feed Type" }, "description": "Feed type: top, recent, or reels" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_highlight_stories": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_highlight_stories", "summary": "Get highlight stories", "description": "Get highlight stories", "parameters": [ { "name": "highlight_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Highlight ID", "title": "Highlight Id" }, "description": "Highlight ID", "example": "17895069621772257" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_location_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_location_posts", "summary": "Get location posts", "description": "Get location posts", "parameters": [ { "name": "location_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Location ID", "title": "Location Id" }, "description": "Location ID", "example": "331004901" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_music_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_music_posts", "summary": "Get music posts", "description": "Get music posts", "parameters": [ { "name": "audio_canonical_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Audio ID", "title": "Audio Canonical Id" }, "description": "Audio ID", "example": "564058920086577" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_post_comments", "summary": "Get post comments", "description": "Get post comments", "parameters": [ { "name": "code_or_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Post shortcode or URL", "title": "Code Or Url" }, "description": "Post shortcode or URL", "example": "DRhvwVLAHAG" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort by: recent or popular", "default": "recent", "title": "Sort By" }, "description": "Sort by: recent or popular", "example": "recent" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "default": "", "title": "Pagination Token" }, "description": "Pagination token", "example": "" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_post_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_post_info", "summary": "Get post info", "description": "Get post info", "parameters": [ { "name": "code_or_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Post shortcode or URL", "title": "Code Or Url" }, "description": "Post shortcode or URL", "example": "DRhvwVLAHAG" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_post_likes": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_post_likes", "summary": "Get post likes", "description": "Get post likes", "parameters": [ { "name": "code_or_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Post shortcode or URL", "title": "Code Or Url" }, "description": "Post shortcode or URL", "example": "DRhvwVLAHAG" }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor", "title": "End Cursor" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_similar_users": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_similar_users", "summary": "Get similar users", "description": "Get similar users", "parameters": [ { "name": "username", "in": "query", "required": false, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "18527" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_user_followers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_user_followers", "summary": "Get user followers", "description": "Get user followers", "parameters": [ { "name": "username", "in": "query", "required": false, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "18527" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_user_following": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_user_following", "summary": "Get user following", "description": "Get user following", "parameters": [ { "name": "username", "in": "query", "required": false, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "18527" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_user_highlights": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_user_highlights", "summary": "Get user highlights", "description": "Get user highlights", "parameters": [ { "name": "username", "in": "query", "required": false, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "18527" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_user_info", "summary": "Get user info", "description": "Get user info", "parameters": [ { "name": "username", "in": "query", "required": false, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "18527" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_user_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_user_posts", "summary": "Get user posts", "description": "Get user posts", "parameters": [ { "name": "username", "in": "query", "required": false, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "18527" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_user_reels": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_user_reels", "summary": "Get user reels", "description": "Get user reels", "parameters": [ { "name": "username", "in": "query", "required": false, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "18527" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_user_stories": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_user_stories", "summary": "Get user stories", "description": "Get user stories", "parameters": [ { "name": "username", "in": "query", "required": false, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "18527" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/fetch_user_tagged_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_fetch_user_tagged_posts", "summary": "Get user tagged posts", "description": "Get user tagged posts", "parameters": [ { "name": "username", "in": "query", "required": false, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "18527" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/search_locations": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_search_locations", "summary": "Search locations", "description": "Search locations", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "paris" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/search_music": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_search_music", "summary": "Search music", "description": "Search music", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "happy" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v2/search_reels": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v2_search_reels", "summary": "Search reels", "description": "Search reels", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "cat" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Pagination Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/bulk_translate_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_bulk_translate_comments", "summary": "Bulk translate comments", "description": "Bulk translate comments", "parameters": [ { "name": "comment_ids", "in": "query", "required": true, "schema": { "type": "string", "description": "Comment ID list, comma separated", "title": "Comment Ids" }, "description": "Comment ID list, comma separated", "example": "18099342953509681" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/extract_shortcode": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_extract_shortcode", "summary": "Extract shortcode from URL", "description": "Extract shortcode from URL", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Full Instagram post URL", "title": "Url" }, "description": "Full Instagram post URL", "example": "https://www.instagram.com/p/CrgVBtHrFHm/" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/general_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_general_search", "summary": "General search (with pagination)", "description": "General search (with pagination)", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "justin" }, { "name": "next_max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination ID, omit for first request, get from previous response next_max_id", "title": "Next Max Id" }, "description": "Pagination ID, omit for first request, get from previous response next_max_id" }, { "name": "rank_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Rank token, omit for first request, get from previous response", "title": "Rank Token" }, "description": "Rank token, omit for first request, get from previous response" }, { "name": "enable_metadata", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Enable metadata", "default": true, "title": "Enable Metadata" }, "description": "Enable metadata" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_comment_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_comment_replies", "summary": "Get comment replies", "description": "Get comment replies", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post media ID", "title": "Media Id" }, "description": "Post media ID", "example": "3829530490739515971" }, { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Parent comment ID", "title": "Comment Id" }, "description": "Parent comment ID", "example": "18065937092249736" }, { "name": "min_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, omit for first request, get from previous response next_min_child_cursor", "title": "Min Id" }, "description": "Pagination cursor, omit for first request, get from previous response next_min_child_cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_explore": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_explore", "summary": "Get explore feed", "description": "Get explore feed", "parameters": [ { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, omit for first request, get from previous response next_max_id", "title": "Max Id" }, "description": "Pagination cursor, omit for first request, get from previous response next_max_id" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_hashtag_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_hashtag_posts", "summary": "Get hashtag posts", "description": "Get hashtag posts", "parameters": [ { "name": "tag", "in": "query", "required": true, "schema": { "type": "string", "description": "Hashtag keyword (without #", "title": "Tag" }, "description": "Hashtag keyword (without #", "example": "cat" }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor", "title": "Max Id" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_highlight_stories": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_highlight_stories", "summary": "Get highlight stories", "description": "Get highlight stories", "parameters": [ { "name": "highlight_id", "in": "query", "required": true, "schema": { "type": "string", "description": "format: highlight:xxx", "title": "Highlight Id" }, "description": "format: highlight:xxx", "example": "highlight:18064916456320419" }, { "name": "reel_ids", "in": "query", "required": false, "schema": { "type": "string", "description": "Highlight ID list, comma separated, if not provided only query highlight_id", "title": "Reel Ids" }, "description": "Highlight ID list, comma separated, if not provided only query highlight_id" }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "description": "Items per page", "default": 3, "title": "First" }, "description": "Items per page" }, { "name": "last", "in": "query", "required": false, "schema": { "type": "integer", "description": "Get last N items", "default": 2, "title": "Last" }, "description": "Get last N items" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_location_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_location_info", "summary": "Get location info", "description": "Get location info", "parameters": [ { "name": "location_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Location ID", "title": "Location Id" }, "description": "Location ID", "example": "1016248898" }, { "name": "show_nearby", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to show nearby places", "default": true, "title": "Show Nearby" }, "description": "Whether to show nearby places" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_location_nearby": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_location_nearby", "summary": "Get nearby location content", "description": "Get nearby location content", "parameters": [ { "name": "location_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Location ID (numeric", "title": "Location Id" }, "description": "Location ID (numeric", "example": "213385402" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_location_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_location_posts", "summary": "Get location posts", "description": "Get location posts", "parameters": [ { "name": "location_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Location ID", "title": "Location Id" }, "description": "Location ID", "example": "1016248898" }, { "name": "tab", "in": "query", "required": false, "schema": { "enum": [ "ranked", "recent" ], "type": "string", "description": "latest). Example: ranked", "default": "ranked", "title": "Tab" }, "description": "latest). Example: ranked" }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Posts per page", "default": 12, "title": "First" }, "description": "Posts per page" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor from previous response end_cursor", "title": "After" }, "description": "Pagination cursor from previous response end_cursor" }, { "name": "page_size_override", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page size", "default": 12, "title": "Page Size Override" }, "description": "Page size" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_music_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_music_posts", "summary": "Get music (audio) posts", "description": "Get music (audio) posts", "parameters": [ { "name": "audio_cluster_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Audio ID", "title": "Audio Cluster Id" }, "description": "Audio ID", "example": "18066165960103621" }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor", "title": "Max Id" }, "description": "Pagination cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_post_comments", "summary": "Get post comments", "description": "Get post comments", "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "description": "Post shortcode (e.g., DUajw4YkorV", "title": "Code" }, "description": "Post shortcode (e.g., DUajw4YkorV", "example": "DUajw4YkorV" }, { "name": "min_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, omit for first request, get from previous response next_min_id", "title": "Min Id" }, "description": "Pagination cursor, omit for first request, get from previous response next_min_id" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "enum": [ "popular", "newest" ], "type": "string", "description": "Sort order. /Options: popular( ), newest( ). Example: popular", "default": "popular", "title": "Sort Order" }, "description": "Sort order. /Options: popular( ), newest( ). Example: popular" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_post_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_post_info", "summary": "Get post info (media_id or URL)", "description": "Get post info (media_id or URL)", "parameters": [ { "name": "media_id", "in": "query", "required": false, "schema": { "description": "ID/Post media ID url", "title": "Media Id", "nullable": true, "type": "string" }, "description": "ID/Post media ID url", "example": "3850699893338385742" }, { "name": "url", "in": "query", "required": false, "schema": { "description": "URL/Post URL media_id /p/ /reel/ /reels/ /tv", "title": "Url", "nullable": true, "type": "string" }, "description": "URL/Post URL media_id /p/ /reel/ /reels/ /tv", "example": "https://www.instagram.com/p/DUajw4YkorV/" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_post_info_by_code": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_post_info_by_code", "summary": "Get post info by shortcode", "description": "Get post info by shortcode", "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "description": "Post shortcode", "title": "Code" }, "description": "Post shortcode", "example": "DUajw4YkorV" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_post_likes": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_post_likes", "summary": "Get post likes", "description": "Get post likes", "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string", "description": "Post shortcode", "title": "Code" }, "description": "Post shortcode", "example": "DavSf9yS6wy" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_post_oembed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_post_oembed", "summary": "Get post oEmbed info", "description": "Get post oEmbed info", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Full URL of Instagram post", "title": "Url" }, "description": "Full URL of Instagram post", "example": "https://www.instagram.com/reel/DUlObENDmJD" }, { "name": "hidecaption", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to hide caption", "default": false, "title": "Hidecaption" }, "description": "Whether to hide caption" }, { "name": "maxwidth", "in": "query", "required": false, "schema": { "type": "integer", "description": "Max width in pixels", "default": 540, "title": "Maxwidth" }, "description": "Max width in pixels" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_recommended_reels": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_recommended_reels", "summary": "Get recommended Reels feed", "description": "Get recommended Reels feed", "parameters": [ { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Number of reels to fetch", "default": 12, "title": "First" }, "description": "Number of reels to fetch" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, omit for first request, get from previous response page_info.end_cursor", "title": "After" }, "description": "Pagination cursor, omit for first request, get from previous response page_info.end_cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_similar_users": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_similar_users", "summary": "Get similar users", "description": "Get similar users", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Target user ID", "title": "User Id" }, "description": "Target user ID", "example": "25025320" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_about": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_about", "summary": "Get user about info", "description": "Get user about info", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_brief": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_brief", "summary": "Get user brief info", "description": "Get user brief info", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "791258468" }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "99brasil" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_followers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_followers", "summary": "Get user followers list", "description": "Get user followers list", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of users to fetch per request", "default": 12, "title": "Count" }, "description": "Number of users to fetch per request" }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, omit for first request, get from previous response next_max_id", "title": "Max Id" }, "description": "Pagination cursor, omit for first request, get from previous response next_max_id" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_following": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_following", "summary": "Get user following list", "description": "Get user following list", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of users to fetch per request", "default": 12, "title": "Count" }, "description": "Number of users to fetch per request" }, { "name": "max_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor, omit for first request, get from previous response next_max_id", "title": "Max Id" }, "description": "Pagination cursor, omit for first request, get from previous response next_max_id" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_former_usernames": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_former_usernames", "summary": "Get user former usernames", "description": "Get user former usernames", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_highlights": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_highlights", "summary": "Get user highlights", "description": "Get user highlights", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Number of highlights per page", "default": 10, "title": "First" }, "description": "Number of highlights per page" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "description": "Forward pagination cursor", "title": "After" }, "description": "Forward pagination cursor" }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "description": "Backward pagination cursor", "title": "Before" }, "description": "Backward pagination cursor" }, { "name": "last", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of highlights per page (backward", "title": "Last" }, "description": "Number of highlights per page (backward" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_id_by_username": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_id_by_username", "summary": "Get user ID by username", "description": "Get user ID by username", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "liensue.talks" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_posts", "summary": "Get user posts", "description": "Get user posts", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Instagram username (without @", "title": "Username" }, "description": "Instagram username (without @", "example": "99brasil" }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Number of posts per page (forward", "default": 12, "title": "First" }, "description": "Number of posts per page (forward" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "description": "Forward pagination cursor (end_cursor", "title": "After" }, "description": "Forward pagination cursor (end_cursor" }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "description": "Backward pagination cursor (start_cursor", "title": "Before" }, "description": "Backward pagination cursor (start_cursor" }, { "name": "last", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of posts per page (backward", "title": "Last" }, "description": "Number of posts per page (backward" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of posts for first request", "default": 12, "title": "Count" }, "description": "Number of posts for first request" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_profile", "summary": "Get user profile", "description": "Get user profile", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_reels": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_reels", "summary": "Get user reels", "description": "Get user reels", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Number of reels per page (forward", "default": 12, "title": "First" }, "description": "Number of reels per page (forward" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "description": "Forward pagination cursor (end_cursor", "title": "After" }, "description": "Forward pagination cursor (end_cursor" }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "description": "Backward pagination cursor (start_cursor", "title": "Before" }, "description": "Backward pagination cursor (start_cursor" }, { "name": "last", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of reels per page (backward", "title": "Last" }, "description": "Number of reels per page (backward" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "description": "Videos per page", "default": 12, "title": "Page Size" }, "description": "Videos per page" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_stories": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_stories", "summary": "Get user stories", "description": "Get user stories", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/get_user_tagged_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_get_user_tagged_posts", "summary": "Get user tagged posts", "description": "Get user tagged posts", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "instagram" }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Number of posts per page (forward", "default": 12, "title": "First" }, "description": "Number of posts per page (forward" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "description": "Forward pagination cursor (end_cursor", "title": "After" }, "description": "Forward pagination cursor (end_cursor" }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "description": "Backward pagination cursor (start_cursor", "title": "Before" }, "description": "Backward pagination cursor (start_cursor" }, { "name": "last", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of posts per page (backward", "title": "Last" }, "description": "Number of posts per page (backward" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Number of posts for first request", "default": 12, "title": "Count" }, "description": "Number of posts for first request" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/media_id_to_shortcode": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_media_id_to_shortcode", "summary": "Convert media ID to shortcode", "description": "Convert media ID to shortcode", "parameters": [ { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post media ID", "title": "Media Id" }, "description": "Post media ID", "example": "3850699893338385742" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/search_by_coordinates": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_search_by_coordinates", "summary": "Search locations by coordinates", "description": "Search locations by coordinates", "parameters": [ { "name": "latitude", "in": "query", "required": true, "schema": { "type": "number", "description": "Latitude", "title": "Latitude" }, "description": "Latitude", "example": 40.7 }, { "name": "longitude", "in": "query", "required": true, "schema": { "type": "number", "description": "Longitude", "title": "Longitude" }, "description": "Longitude", "example": -74 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/search_hashtags": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_search_hashtags", "summary": "Search hashtags", "description": "Search hashtags", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "fashion" }, { "name": "rank_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Rank token from previous search response for pagination", "title": "Rank Token" }, "description": "Rank token from previous search response for pagination" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/search_users": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_search_users", "summary": "Search users", "description": "Search users", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "justin" }, { "name": "rank_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Rank token from previous search response for pagination", "title": "Rank Token" }, "description": "Rank token from previous search response for pagination" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/shortcode_to_media_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_shortcode_to_media_id", "summary": "Convert shortcode to media ID", "description": "Convert shortcode to media ID", "parameters": [ { "name": "shortcode", "in": "query", "required": true, "schema": { "type": "string", "description": "Post shortcode", "title": "Shortcode" }, "description": "Post shortcode", "example": "CrgVBtHrFHm" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/translate_comment": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_translate_comment", "summary": "Translate comment or caption", "description": "Translate comment or caption", "parameters": [ { "name": "comment_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Comment ID or caption media ID", "title": "Comment Id" }, "description": "Comment ID or caption media ID", "example": "18191961100350646" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/instagram/v3/user_id_to_username": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Instagram" ], "operationId": "get_tikhub_instagram_v3_user_id_to_username", "summary": "Get user info by user ID", "description": "Get user info by user ID", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "25025320" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/kuaishou/web/fetch_one_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_fetch_one_video", "summary": "Get single video data V1", "description": "Get single video data V1", "parameters": [ { "name": "share_text", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo share link" }, "example": "https://www.kuaishou.com/f/X-f2k5KJpiXN1SY" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/kuaishou/web/fetch_one_video_by_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Kuaishou" ], "operationId": "get_tikhub_kuaishou_web_fetch_one_video_by_url", "summary": "Fetch single video by URL", "description": "Fetch single video by URL", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Photo URL" }, "example": "https://v.kuaishou.com/GKTpYm" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_discover_banners": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_discover_banners", "summary": "Get banners of discover page", "description": "Get banners of discover page", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_discover_tab": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_discover_tab", "summary": "Get main content of discover page", "description": "Get main content of discover page", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_discover_tab_information_tabs": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_discover_tab_information_tabs", "summary": "Get Editor's Picks of discover page", "description": "Get Editor's Picks of discover page", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_hot_search_keywords": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_hot_search_keywords", "summary": "Get hot search keywords", "description": "Get hot search keywords", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_post_comment_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_post_comment_list", "summary": "Get comments list of specified post", "description": "Get comments list of specified post", "parameters": [ { "name": "group_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post's group_id", "title": "Group Id" }, "description": "Post's group_id", "example": "7361926875709129222" }, { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post's item_id", "title": "Item Id" }, "description": "Post's item_id", "example": "7361926875709129222" }, { "name": "media_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post's media_id", "title": "Media Id" }, "description": "Post's media_id", "example": "7428056850216862763" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination parameter", "default": "0", "title": "Offset" }, "description": "Pagination parameter", "example": "0" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_post_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_post_detail", "summary": "Get information of specified post", "description": "Get information of specified post", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Item Id" }, "description": "Post ID", "example": "7361926875709129222" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_search", "summary": "Search API", "description": "Search API", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Query" }, "description": "Search keyword", "example": "lemon8" }, { "name": "max_cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination parameter", "default": "", "title": "Max Cursor" }, "description": "Pagination parameter", "example": "" }, { "name": "filter_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Search filter type", "default": "", "title": "Filter Type" }, "description": "Search filter type", "example": "" }, { "name": "order_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Search sort type", "default": "", "title": "Order By" }, "description": "Search sort type", "example": "" }, { "name": "search_tab", "in": "query", "required": false, "schema": { "type": "string", "description": "Search type", "default": "main", "title": "Search Tab" }, "description": "Search type", "example": "main" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_topic_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_topic_info", "summary": "Get topic information", "description": "Get topic information", "parameters": [ { "name": "forum_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Topic ID", "title": "Forum Id" }, "description": "Topic ID", "example": "7174447913778593798" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_topic_post_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_topic_post_list", "summary": "Get topic post list", "description": "Get topic post list", "parameters": [ { "name": "category", "in": "query", "required": true, "schema": { "type": "string", "description": "Topic category ID", "title": "Category" }, "description": "Topic category ID", "example": "590" }, { "name": "max_behot_time", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination parameter", "default": "", "title": "Max Behot Time" }, "description": "Pagination parameter", "example": "" }, { "name": "category_parameter", "in": "query", "required": true, "schema": { "type": "string", "description": "Category parameter", "title": "Category Parameter" }, "description": "Category parameter", "example": "7174447913778593798" }, { "name": "hashtag_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Hashtag name", "title": "Hashtag Name" }, "description": "Hashtag name", "example": "lemon8christmas" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort type", "default": "0", "title": "Sort Type" }, "description": "Sort type" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_user_follower_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_user_follower_list", "summary": "Get fans list of specified user", "description": "Get fans list of specified user", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "7428056850216862763" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination parameter", "default": "", "title": "Cursor" }, "description": "Pagination parameter", "example": "" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_user_following_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_user_following_list", "summary": "Get following list of specified user", "description": "Get following list of specified user", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "7428056850216862763" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination parameter", "default": "", "title": "Cursor" }, "description": "Pagination parameter", "example": "" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/fetch_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_fetch_user_profile", "summary": "Get information of specified user", "description": "Get information of specified user", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "7217844966059656197" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/get_item_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_get_item_id", "summary": "Get post ID through sharing link", "description": "Get post ID through sharing link", "parameters": [ { "name": "share_text", "in": "query", "required": true, "schema": { "type": "string", "description": "Share link", "title": "Share Text" }, "description": "Share link", "example": "https://v.lemon8-app.com/al/OghwFTppx" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/get_item_ids": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "post_tikhub_lemon8_app_get_item_ids", "summary": "Get post IDs in batch through sharing links", "description": "Get post IDs in batch through sharing links", "requestBody": { "content": { "application/json": { "schema": { "items": {}, "type": "array", "title": "Share Texts", "description": "Share links list" }, "example": [ "https://www.lemon8-app.com/@deathlabs_/7445613324903006766", "https://v.lemon8-app.com/al/OghwFTppx" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/get_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "get_tikhub_lemon8_app_get_user_id", "summary": "Get user ID through sharing link", "description": "Get user ID through sharing link", "parameters": [ { "name": "share_text", "in": "query", "required": true, "schema": { "type": "string", "description": "Share link", "title": "Share Text" }, "description": "Share link", "example": "https://v.lemon8-app.com/al/OgZrsUppx" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/lemon8/app/get_user_ids": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Lemon8" ], "operationId": "post_tikhub_lemon8_app_get_user_ids", "summary": "Get user IDs in batch through sharing links", "description": "Get user IDs in batch through sharing links", "requestBody": { "content": { "application/json": { "schema": { "items": {}, "type": "array", "title": "Share Texts", "description": "Share links list" }, "example": [ "https://www.lemon8-app.com/lemon8cars?region=us", "https://v.lemon8-app.com/al/OgZrsUppx" ] } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/linkedin/web_v2/get_company_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Linkedin" ], "operationId": "get_tikhub_linkedin_web_v2_get_company_posts", "summary": "Get company's posts", "description": "Get company's posts", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Company URL", "title": "Url" }, "description": "Company URL", "example": "https://www.linkedin.com/company/microsoft/" }, { "name": "start", "in": "query", "required": false, "schema": { "description": "Pagination offset", "title": "Start", "nullable": true, "type": "integer", "minimum": 0 }, "description": "Pagination offset" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "description": "Pagination token", "title": "Pagination Token", "nullable": true, "type": "string" }, "description": "Pagination token" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "description": "top | recent", "title": "Sort By", "nullable": true, "type": "string" }, "description": "top | recent" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/linkedin/web_v2/get_company_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Linkedin" ], "operationId": "get_tikhub_linkedin_web_v2_get_company_profile", "summary": "Get company profile", "description": "Get company profile", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Full company URL", "title": "Url" }, "description": "Full company URL", "example": "https://www.linkedin.com/company/microsoft/" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/linkedin/web_v2/get_job_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Linkedin" ], "operationId": "get_tikhub_linkedin_web_v2_get_job_detail", "summary": "Get job detail", "description": "Get job detail", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Job URL", "title": "Url" }, "description": "Job URL", "example": "https://www.linkedin.com/jobs/view/software-engineer-at-pave-4310512612/" }, { "name": "include_skills", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include skills", "default": false, "title": "Include Skills" }, "description": "Include skills" }, { "name": "include_hiring_team", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include hiring team", "default": false, "title": "Include Hiring Team" }, "description": "Include hiring team" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/linkedin/web_v2/get_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Linkedin" ], "operationId": "get_tikhub_linkedin_web_v2_get_post_comments", "summary": "Get post comments", "description": "Get post comments", "parameters": [ { "name": "urn", "in": "query", "required": true, "schema": { "type": "string", "description": "Post activity urn", "title": "Urn" }, "description": "Post activity urn", "example": "7267273010393358336" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "description": "Most recent", "title": "Sort By", "nullable": true, "type": "string" }, "description": "Most recent" }, { "name": "page", "in": "query", "required": false, "schema": { "description": "Page number, starts at 1", "title": "Page", "nullable": true, "type": "integer", "minimum": 1 }, "description": "Page number, starts at 1" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "description": "Pagination token", "title": "Pagination Token", "nullable": true, "type": "string" }, "description": "Pagination token" }, { "name": "share_urn", "in": "query", "required": false, "schema": { "description": "Share urn (optional", "title": "Share Urn", "nullable": true, "type": "string" }, "description": "Share urn (optional" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/linkedin/web_v2/get_post_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Linkedin" ], "operationId": "get_tikhub_linkedin_web_v2_get_post_detail", "summary": "Get post or article detail", "description": "Get post or article detail", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Post or article URL", "title": "Url" }, "description": "Post or article URL", "example": "https://www.linkedin.com/posts/orlenchner_scrapecon-activity-7180537307521769472-oSYN" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/linkedin/web_v2/get_user_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Linkedin" ], "operationId": "get_tikhub_linkedin_web_v2_get_user_posts", "summary": "Get user's posts", "description": "Get user's posts", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Profile URL", "title": "Url" }, "description": "Profile URL", "example": "https://www.linkedin.com/in/williamhgates/" }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "description": "posts / | comments | reactions", "default": "posts", "title": "Type" }, "description": "posts / | comments | reactions" }, { "name": "start", "in": "query", "required": false, "schema": { "description": "Pagination offset", "title": "Start", "nullable": true, "type": "integer", "minimum": 0 }, "description": "Pagination offset" }, { "name": "pagination_token", "in": "query", "required": false, "schema": { "description": "Pagination token", "title": "Pagination Token", "nullable": true, "type": "string" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/linkedin/web_v2/get_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Linkedin" ], "operationId": "get_tikhub_linkedin_web_v2_get_user_profile", "summary": "Get user profile", "description": "Get user profile", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Full profile URL", "title": "Url" }, "description": "Full profile URL", "example": "https://www.linkedin.com/in/williamhgates/" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/linkedin/web_v2/search_jobs": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Linkedin" ], "operationId": "get_tikhub_linkedin_web_v2_search_jobs", "summary": "Search jobs", "description": "Search jobs", "parameters": [ { "name": "keywords", "in": "query", "required": false, "schema": { "description": "Keywords", "title": "Keywords", "nullable": true, "type": "string" }, "description": "Keywords", "example": "data analyst" }, { "name": "geo_code", "in": "query", "required": false, "schema": { "description": "LinkedIn geo code, 92000000 = worldwide", "default": 92000000, "title": "Geo Code", "nullable": true, "type": "integer" }, "description": "LinkedIn geo code, 92000000 = worldwide" }, { "name": "date_posted", "in": "query", "required": false, "schema": { "description": "Any time / Past month / Past week / Past 24 hours", "title": "Date Posted", "nullable": true, "type": "string" }, "description": "Any time / Past month / Past week / Past 24 hours" }, { "name": "experience_levels", "in": "query", "required": false, "schema": { "description": "Internship / Entry level / Associate / Mid-Senior level / Director / Executive", "title": "Experience Levels", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "Internship / Entry level / Associate / Mid-Senior level / Director / Executive" }, { "name": "company_ids", "in": "query", "required": false, "schema": { "description": "Company ids, repeatable", "title": "Company Ids", "nullable": true, "type": "array", "items": { "type": "integer" } }, "description": "Company ids, repeatable" }, { "name": "title_ids", "in": "query", "required": false, "schema": { "description": "Title ids, repeatable", "title": "Title Ids", "nullable": true, "type": "array", "items": { "type": "integer" } }, "description": "Title ids, repeatable" }, { "name": "onsite_remotes", "in": "query", "required": false, "schema": { "description": "On-site / Remote / Hybrid", "title": "Onsite Remotes", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "On-site / Remote / Hybrid" }, { "name": "functions", "in": "query", "required": false, "schema": { "description": "Functions, repeatable", "title": "Functions", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "Functions, repeatable" }, { "name": "industries", "in": "query", "required": false, "schema": { "description": "Industries, repeatable", "title": "Industries", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "Industries, repeatable" }, { "name": "job_types", "in": "query", "required": false, "schema": { "description": "Full-time / Part-time / Contract / Temporary / Internship / Volunteer", "title": "Job Types", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "Full-time / Part-time / Contract / Temporary / Internship / Volunteer" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "description": "Most relevant / Most recent", "title": "Sort By", "nullable": true, "type": "string" }, "description": "Most relevant / Most recent" }, { "name": "easy_apply", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Easy-apply jobs only", "default": false, "title": "Easy Apply" }, "description": "Easy-apply jobs only" }, { "name": "under_10_applicants", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Under 10 applicants only", "default": false, "title": "Under 10 Applicants" }, "description": "Under 10 applicants only" }, { "name": "start", "in": "query", "required": false, "schema": { "description": "Pagination offset", "title": "Start", "nullable": true, "type": "integer", "minimum": 0 }, "description": "Pagination offset" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_hashtag_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_hashtag_detail", "summary": "Get hashtag detail", "description": "Get hashtag detail", "parameters": [ { "name": "hashtag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Hashtag id", "title": "Hashtag Id" }, "description": "Hashtag id", "example": "129559" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_hashtag_post_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_hashtag_post_list", "summary": "Get hashtag post list", "description": "Get hashtag post list", "parameters": [ { "name": "hashtag_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Hashtag id", "title": "Hashtag Id" }, "description": "Hashtag id", "example": "129559" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Page cursor", "default": "0", "title": "Cursor" }, "description": "Page cursor", "example": "0" }, { "name": "feed_count", "in": "query", "required": false, "schema": { "type": "string", "description": "Page count", "default": "0", "title": "Feed Count" }, "description": "Page count", "example": "0" }, { "name": "hashtag_request_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Hashtag request type", "default": "0", "title": "Hashtag Request Type" }, "description": "Hashtag request type", "example": "0" }, { "name": "hashtag_sort_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Hashtag sort type", "default": "3", "title": "Hashtag Sort Type" }, "description": "Hashtag sort type", "example": "3" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_home_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_home_feed", "summary": "Get home feed", "description": "Get home feed", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Page cursor", "default": "0", "title": "Cursor" }, "description": "Page cursor", "example": "0" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_home_short_drama_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_home_short_drama_feed", "summary": "Get home short drama feed", "description": "Get home short drama feed", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_hot_search_board_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_hot_search_board_detail", "summary": "Get hot search board detail", "description": "Get hot search board detail", "parameters": [ { "name": "block_type", "in": "query", "required": true, "schema": { "type": "integer", "description": "Board type", "title": "Block Type" }, "description": "Board type", "example": 12 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_hot_search_board_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_hot_search_board_list", "summary": "Get hot search board list", "description": "Get hot search board list", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_hot_search_words": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_hot_search_words", "summary": "Get hot search words", "description": "Get hot search words", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_increase_post_view_count": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_increase_post_view_count", "summary": "Increase post view count", "description": "Increase post view count", "parameters": [ { "name": "cell_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Cell Id" }, "description": "Video id", "example": "7411193113223371043" }, { "name": "cell_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Video type", "default": 1, "title": "Cell Type" }, "description": "Video type", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_post_comment_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_post_comment_list", "summary": "Get post comment list", "description": "Get post comment list", "parameters": [ { "name": "cell_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Cell Id" }, "description": "Video id", "example": "7411193113223371043" }, { "name": "cell_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Video type", "default": 1, "title": "Cell Type" }, "description": "Video type", "example": 1 }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Page cursor", "default": "0", "title": "Offset" }, "description": "Page cursor", "example": "0" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_post_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_post_detail", "summary": "Get single video data", "description": "Get single video data", "parameters": [ { "name": "cell_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Cell Id" }, "description": "Video id", "example": "7411193113223371043" }, { "name": "cell_type", "in": "query", "required": false, "schema": { "type": "integer", "description": "Video type", "default": 1, "title": "Cell Type" }, "description": "Video type", "example": 1 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_post_statistics": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_post_statistics", "summary": "Get post statistics", "description": "Get post statistics", "parameters": [ { "name": "cell_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Cell Id" }, "description": "Video id", "example": "7411193113223371043" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_search", "summary": "Search API", "description": "Search API", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "See API documentation" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string", "description": "Page cursor", "default": "0", "title": "Offset" }, "description": "Page cursor", "example": "0" }, { "name": "search_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Search type", "default": "1", "title": "Search Type" }, "description": "Search type", "example": "1" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_short_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_short_url", "summary": "Generate short URL", "description": "Generate short URL", "parameters": [ { "name": "original_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Original URL", "title": "Original Url" }, "description": "Original URL", "example": "https://h5.pipix.com/item/7385813877985909043" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_user_follower_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_user_follower_list", "summary": "Get user follower list", "description": "Get user follower list", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "User Id" }, "description": "User id", "example": "1310254082831248" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Page cursor", "default": "0", "title": "Cursor" }, "description": "Page cursor", "example": "0" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_user_following_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_user_following_list", "summary": "Get user following list", "description": "Get user following list", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "User Id" }, "description": "User id", "example": "1310254082831248" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Page cursor", "default": "0", "title": "Cursor" }, "description": "Page cursor", "example": "0" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_user_info", "summary": "Get user information", "description": "Get user information", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "User Id" }, "description": "User id", "example": "1020401" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/pipixia/app/fetch_user_post_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Pipixia" ], "operationId": "get_tikhub_pipixia_app_fetch_user_post_list", "summary": "Get user post list", "description": "Get user post list", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "User Id" }, "description": "User id", "example": "1310254082831248" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Page cursor", "default": "0", "title": "Cursor" }, "description": "Page cursor", "example": "0" }, { "name": "feed_count", "in": "query", "required": false, "schema": { "type": "string", "description": "Page count", "default": "0", "title": "Feed Count" }, "description": "Page count", "example": "0" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/check_subreddit_muted": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_check_subreddit_muted", "summary": "Check if Subreddit is Muted", "description": "Check if Subreddit is Muted", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "subreddit_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^t5_[a-z0-9]{1,17}$", "description": "Subreddit ID", "title": "Subreddit Id" }, "description": "Subreddit ID", "example": "t5_2qh0u" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_comment_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_comment_replies", "summary": "Fetch Reddit APP Comment Replies (Sub-comments)", "description": "Fetch Reddit APP Comment Replies (Sub-comments)", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "post_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^t3_[a-z0-9]{1,17}$", "description": "Post ID", "title": "Post Id" }, "description": "Post ID", "example": "t3_1qmup73" }, { "name": "cursor", "in": "query", "required": true, "schema": { "type": "string", "minLength": 13, "maxLength": 4096, "pattern": "^commenttree:", "description": "Comment cursor from more.cursor field", "title": "Cursor" }, "description": "Comment cursor from more.cursor field", "example": "commenttree:ex:(RjiJd" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "enum": [ "CONFIDENCE", "NEW", "TOP", "HOT", "CONTROVERSIAL", "OLD", "RANDOM" ], "type": "string", "description": "Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM", "default": "CONFIDENCE", "title": "Sort Type" }, "description": "Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM", "example": "CONFIDENCE" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_community_highlights": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_community_highlights", "summary": "Fetch Reddit APP Community Highlights", "description": "Fetch Reddit APP Community Highlights", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "subreddit_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^t5_[a-z0-9]{1,17}$", "description": "Subreddit ID", "title": "Subreddit Id" }, "description": "Subreddit ID", "example": "t5_2qh0u" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_dynamic_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_dynamic_search", "summary": "Fetch Reddit APP Dynamic Search Results", "description": "Fetch Reddit APP Dynamic Search Results", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 512, "description": "Search query", "title": "Query" }, "description": "Search query", "example": "python programming" }, { "name": "search_type", "in": "query", "required": false, "schema": { "enum": [ "post", "community", "comment", "media", "people" ], "type": "string", "description": "Search type: post( ), community( ), comment( ), media( ), people", "default": "post", "title": "Search Type" }, "description": "Search type: post( ), community( ), comment( ), media( ), people", "example": "post" }, { "name": "sort", "in": "query", "required": false, "schema": { "description": "post/comment/media)/Sort method (only for post/comment/media): RELEVANCE( ), HOT( ), TOP( ), NEW( ), COMMENTS( , post", "title": "Sort", "nullable": true, "enum": [ "RELEVANCE", "HOT", "TOP", "NEW", "COMMENTS" ], "type": "string" }, "description": "post/comment/media)/Sort method (only for post/comment/media): RELEVANCE( ), HOT( ), TOP( ), NEW( ), COMMENTS( , post", "example": "RELEVANCE" }, { "name": "time_range", "in": "query", "required": false, "schema": { "description": "post/media)/Time range (only for post/media): all( ), year( ), month( ), week( ), day( ), hour( 1", "title": "Time Range", "nullable": true, "enum": [ "all", "year", "month", "week", "day", "hour" ], "type": "string" }, "description": "post/media)/Time range (only for post/media): all( ), year( ), month( ), week( ), day( ), hour( 1", "example": "all" }, { "name": "safe_search", "in": "query", "required": false, "schema": { "enum": [ "unset", "strict" ], "type": "string", "description": "Safe search setting: unset, strict", "default": "unset", "title": "Safe Search" }, "description": "Safe search setting: unset, strict", "example": "unset" }, { "name": "allow_nsfw", "in": "query", "required": false, "schema": { "enum": [ "0", "1" ], "type": "string", "description": "Allow NSFW content: 0, 1", "default": "0", "title": "Allow Nsfw" }, "description": "Allow NSFW content: 0, 1", "example": "0" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "description": "Pagination parameter", "default": "", "title": "After" }, "description": "Pagination parameter", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_explore_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_explore_feed", "summary": "Fetch Reddit APP Explore Feed", "description": "Fetch Reddit APP Explore Feed", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "BEST", "HOT", "NEW", "TOP", "CONTROVERSIAL", "RISING" ], "type": "string", "description": "Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL", "default": "BEST", "title": "Sort" }, "description": "Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL", "example": "BEST" }, { "name": "time", "in": "query", "required": false, "schema": { "enum": [ "ALL", "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ], "type": "string", "description": "Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR", "default": "ALL", "title": "Time" }, "description": "Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR", "example": "ALL" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_games_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_games_feed", "summary": "Fetch Reddit APP Games Feed", "description": "Fetch Reddit APP Games Feed", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "BEST", "HOT", "NEW", "TOP", "CONTROVERSIAL", "RISING" ], "type": "string", "description": "Sort method: NEW, HOT, TOP, RISING", "default": "NEW", "title": "Sort" }, "description": "Sort method: NEW, HOT, TOP, RISING", "example": "HOT" }, { "name": "time", "in": "query", "required": false, "schema": { "enum": [ "ALL", "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ], "type": "string", "description": "Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR", "default": "ALL", "title": "Time" }, "description": "Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR", "example": "WEEK" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "description": "Pagination parameter", "default": "", "title": "After" }, "description": "Pagination parameter", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_generated_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_generated_comments", "summary": "Fetch Reddit Answers Generated Comments", "description": "Fetch Reddit Answers Generated Comments", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "comment_ids", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 629, "pattern": "^t1_[a-z0-9]{1,17}(?:\\s*,\\s*t1_[a-z0-9]{1,17})*$", "description": "Comment IDs comma-separated, max 30", "title": "Comment Ids" }, "description": "Comment IDs comma-separated, max 30", "example": "t1_onfhplx,t1_onfk44g,t1_onfmbu3" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_generated_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_generated_posts", "summary": "Fetch Reddit Answers Generated Posts", "description": "Fetch Reddit Answers Generated Posts", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "post_ids", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 629, "pattern": "^t3_[a-z0-9]{1,17}(?:\\s*,\\s*t3_[a-z0-9]{1,17})*$", "description": "Post IDs comma-separated, max 30", "title": "Post Ids" }, "description": "Post IDs comma-separated, max 30", "example": "t3_1tlh0ir,t3_1tl1dlj,t3_1tl0br7" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_home_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_home_feed", "summary": "Fetch Reddit APP Home Feed", "description": "Fetch Reddit APP Home Feed", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "BEST", "HOT", "NEW", "TOP", "CONTROVERSIAL", "RISING" ], "type": "string", "description": "Sort method: HOT, NEW, TOP, BEST, CONTROVERSIAL", "default": "BEST", "title": "Sort" }, "description": "Sort method: HOT, NEW, TOP, BEST, CONTROVERSIAL", "example": "BEST" }, { "name": "filter_posts", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^t3_[a-z0-9]+$" }, "maxItems": 100, "description": "Filter out specified post IDs", "default": [], "title": "Filter Posts" }, "description": "Filter out specified post IDs", "example": [ "t3_1ojjquz", "t3_1ohepm2", "t3_1ojxzzz", "t3_1ojnvca", "t3_1oj9dcb", "t3_1ojxubp", "t3_1oj5x2b" ] }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "description": "Pagination parameter for fetching next page", "default": "", "title": "After" }, "description": "Pagination parameter for fetching next page", "example": "dDNfMW9qNXgyYg==" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_news_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_news_feed", "summary": "Fetch Reddit APP News Feed", "description": "Fetch Reddit APP News Feed", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "subtopic_ids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9_-]+$" }, "maxItems": 50, "description": "Subtopic IDs list", "default": [ "all" ], "title": "Subtopic Ids" }, "description": "Subtopic IDs list", "example": [ "all" ] }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "description": "Pagination parameter", "default": "", "title": "After" }, "description": "Pagination parameter", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_popular_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_popular_feed", "summary": "Fetch Reddit APP Popular Feed", "description": "Fetch Reddit APP Popular Feed", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "BEST", "HOT", "NEW", "TOP", "CONTROVERSIAL", "RISING" ], "type": "string", "description": "Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING", "default": "BEST", "title": "Sort" }, "description": "Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING", "example": "HOT" }, { "name": "time", "in": "query", "required": false, "schema": { "enum": [ "ALL", "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ], "type": "string", "description": "Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR", "default": "ALL", "title": "Time" }, "description": "Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR", "example": "DAY" }, { "name": "filter_posts", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^t3_[a-z0-9]+$" }, "maxItems": 100, "description": "Filter post IDs", "default": [], "title": "Filter Posts" }, "description": "Filter post IDs", "example": [] }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "description": "Pagination parameter", "default": "", "title": "After" }, "description": "Pagination parameter", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_post_comments", "summary": "Fetch Reddit APP Post Comments", "description": "Fetch Reddit APP Post Comments", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "post_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^t3_[a-z0-9]{1,17}$", "description": "Post ID", "title": "Post Id" }, "description": "Post ID", "example": "t3_1ojnvca" }, { "name": "sort_type", "in": "query", "required": false, "schema": { "enum": [ "CONFIDENCE", "NEW", "TOP", "HOT", "CONTROVERSIAL", "OLD", "RANDOM" ], "type": "string", "description": "Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM", "default": "CONFIDENCE", "title": "Sort Type" }, "description": "Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM", "example": "CONFIDENCE" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "description": "Pagination parameter for fetching next page", "default": "", "title": "After" }, "description": "Pagination parameter for fetching next page", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_post_details": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_post_details", "summary": "Fetch Single Reddit Post Details", "description": "Fetch Single Reddit Post Details", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "post_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^t3_[a-z0-9]{1,17}$", "description": "Post ID", "title": "Post Id" }, "description": "Post ID", "example": "t3_1ojnh50" }, { "name": "include_comment_id", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include specific comment ID", "default": false, "title": "Include Comment Id" }, "description": "Include specific comment ID", "example": false }, { "name": "comment_id", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 20, "pattern": "^(?:|t1_[a-z0-9]{1,17})$", "description": "Comment ID (when include_comment_id is True", "default": "", "title": "Comment Id" }, "description": "Comment ID (when include_comment_id is True", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_post_details_batch": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00725, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_post_details_batch", "summary": "Fetch Reddit Post Details in Batch (Max 5)", "description": "Fetch Reddit Post Details in Batch (Max 5)", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "post_ids", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 104, "pattern": "^t3_[a-z0-9]{1,17}(?:\\s*,\\s*t3_[a-z0-9]{1,17})*$", "description": "Post IDs comma-separated, max 5", "title": "Post Ids" }, "description": "Post IDs comma-separated, max 5", "example": "t3_1ojnh50,t3_1ok432f,t3_1nwil8j" }, { "name": "include_comment_id", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include specific comment ID", "default": false, "title": "Include Comment Id" }, "description": "Include specific comment ID", "example": false }, { "name": "comment_id", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 20, "pattern": "^(?:|t1_[a-z0-9]{1,17})$", "description": "Comment ID (when include_comment_id is True", "default": "", "title": "Comment Id" }, "description": "Comment ID (when include_comment_id is True", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_post_details_batch_large": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.03625, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_post_details_batch_large", "summary": "Fetch Reddit Post Details in Large Batch (Max 30)", "description": "Fetch Reddit Post Details in Large Batch (Max 30)", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "post_ids", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 629, "pattern": "^t3_[a-z0-9]{1,17}(?:\\s*,\\s*t3_[a-z0-9]{1,17})*$", "description": "Post IDs comma-separated, max 30", "title": "Post Ids" }, "description": "Post IDs comma-separated, max 30", "example": "t3_1ojnh50,t3_1ok432f,t3_1nwil8j,t3_1oj6vn6,t3_1nuenmd" }, { "name": "include_comment_id", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include specific comment ID", "default": false, "title": "Include Comment Id" }, "description": "Include specific comment ID", "example": false }, { "name": "comment_id", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 20, "pattern": "^(?:|t1_[a-z0-9]{1,17})$", "description": "Comment ID (when include_comment_id is True", "default": "", "title": "Comment Id" }, "description": "Comment ID (when include_comment_id is True", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_search_typeahead": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_search_typeahead", "summary": "Fetch Reddit APP Search Typeahead Suggestions", "description": "Fetch Reddit APP Search Typeahead Suggestions", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 512, "description": "Search query", "title": "Query" }, "description": "Search query", "example": "programming" }, { "name": "safe_search", "in": "query", "required": false, "schema": { "enum": [ "unset", "strict" ], "type": "string", "description": "Safe search setting: unset, strict", "default": "unset", "title": "Safe Search" }, "description": "Safe search setting: unset, strict", "example": "unset" }, { "name": "allow_nsfw", "in": "query", "required": false, "schema": { "enum": [ "0", "1" ], "type": "string", "description": "Allow NSFW content: 0 or 1", "default": "0", "title": "Allow Nsfw" }, "description": "Allow NSFW content: 0 or 1", "example": "0" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_subreddit_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_subreddit_feed", "summary": "Fetch Reddit APP Subreddit Feed", "description": "Fetch Reddit APP Subreddit Feed", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "subreddit_name", "in": "query", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 21, "pattern": "^[A-Za-z0-9_]+$", "description": "Subreddit name", "title": "Subreddit Name" }, "description": "Subreddit name", "example": "AskReddit" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "BEST", "HOT", "NEW", "TOP", "CONTROVERSIAL", "RISING" ], "type": "string", "description": "Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING", "default": "BEST", "title": "Sort" }, "description": "Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING", "example": "HOT" }, { "name": "filter_posts", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^t3_[a-z0-9]+$" }, "maxItems": 100, "description": "Filter post IDs", "default": [], "title": "Filter Posts" }, "description": "Filter post IDs", "example": [] }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "description": "Pagination parameter", "default": "", "title": "After" }, "description": "Pagination parameter", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_subreddit_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_subreddit_info", "summary": "Fetch Reddit APP Subreddit Info", "description": "Fetch Reddit APP Subreddit Info", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "subreddit_name", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 21, "pattern": "^[A-Za-z0-9_]+$", "description": "Subreddit name", "default": "pics", "title": "Subreddit Name" }, "description": "Subreddit name", "example": "pics" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_subreddit_post_channels": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_subreddit_post_channels", "summary": "Fetch Reddit APP Subreddit Post Channels", "description": "Fetch Reddit APP Subreddit Post Channels", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "subreddit_name", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 21, "pattern": "^[A-Za-z0-9_]+$", "description": "Subreddit name", "default": "pics", "title": "Subreddit Name" }, "description": "Subreddit name", "example": "pics" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "BEST", "HOT", "NEW", "TOP", "CONTROVERSIAL", "RISING" ], "type": "string", "description": "Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING", "default": "HOT", "title": "Sort" }, "description": "Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING", "example": "HOT" }, { "name": "range", "in": "query", "required": false, "schema": { "enum": [ "ALL", "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ], "type": "string", "description": "Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL", "default": "DAY", "title": "Range" }, "description": "Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL", "example": "DAY" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_subreddit_settings": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_subreddit_settings", "summary": "Fetch Reddit APP Subreddit Settings", "description": "Fetch Reddit APP Subreddit Settings", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "subreddit_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^t5_[a-z0-9]{1,17}$", "description": "Subreddit ID", "title": "Subreddit Id" }, "description": "Subreddit ID", "example": "t5_2qh0u" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_subreddit_style": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_subreddit_style", "summary": "Fetch Reddit APP Subreddit Rules and Style Info", "description": "Fetch Reddit APP Subreddit Rules and Style Info", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "subreddit_name", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 21, "pattern": "^[A-Za-z0-9_]+$", "description": "Subreddit name", "default": "pics", "title": "Subreddit Name" }, "description": "Subreddit name", "example": "pics" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_topic_feed": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_topic_feed", "summary": "Fetch Reddit APP Topic Feed", "description": "Fetch Reddit APP Topic Feed", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "topic_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 5, "maxLength": 20, "pattern": "^tx1_[a-z0-9]{1,16}$", "description": "ID/Topic ID ( /fetch_explore_feed topics", "title": "Topic Id" }, "description": "ID/Topic ID ( /fetch_explore_feed topics", "example": "tx1_29m4k39" }, { "name": "scheme_name", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-z0-9_]+$", "description": "scheme/Topic scheme name ( App communities_tab_taxonomy_topics_default", "default": "communities_tab_taxonomy_topics_default", "title": "Scheme Name" }, "description": "scheme/Topic scheme name ( App communities_tab_taxonomy_topics_default", "example": "communities_tab_taxonomy_topics_default" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "BEST", "HOT", "NEW", "TOP", "CONTROVERSIAL", "RISING" ], "type": "string", "description": "Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL", "default": "BEST", "title": "Sort" }, "description": "Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL", "example": "BEST" }, { "name": "time", "in": "query", "required": false, "schema": { "enum": [ "ALL", "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ], "type": "string", "description": "Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR", "default": "ALL", "title": "Time" }, "description": "Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR", "example": "ALL" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_trending_searches": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_trending_searches", "summary": "Fetch Reddit APP Trending Searches", "description": "Fetch Reddit APP Trending Searches", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_user_active_subreddits": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_user_active_subreddits", "summary": "Fetch User's Active Subreddits", "description": "Fetch User's Active Subreddits", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[A-Za-z0-9_-]+$", "description": "Username", "title": "Username" }, "description": "Username", "example": "spez" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_user_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_user_comments", "summary": "Fetch User Comments", "description": "Fetch User Comments", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[A-Za-z0-9_-]+$", "description": "Username", "title": "Username" }, "description": "Username", "example": "spez" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "NEW", "TOP", "HOT", "CONTROVERSIAL" ], "type": "string", "description": "Sort method: NEW, TOP, HOT, CONTROVERSIAL", "default": "NEW", "title": "Sort" }, "description": "Sort method: NEW, TOP, HOT, CONTROVERSIAL", "example": "NEW" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Page size (default: 25", "default": 25, "title": "Page Size" }, "description": "Page size (default: 25", "example": 25 }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "description": "Pagination parameter", "default": "", "title": "After" }, "description": "Pagination parameter", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_user_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_user_posts", "summary": "Fetch User Posts", "description": "Fetch User Posts", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[A-Za-z0-9_-]+$", "description": "Username", "title": "Username" }, "description": "Username", "example": "spez" }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "NEW", "TOP", "HOT", "CONTROVERSIAL" ], "type": "string", "description": "Sort method: NEW, TOP, HOT, CONTROVERSIAL", "default": "NEW", "title": "Sort" }, "description": "Sort method: NEW, TOP, HOT, CONTROVERSIAL", "example": "NEW" }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 4096, "description": "Pagination parameter", "default": "", "title": "After" }, "description": "Pagination parameter", "example": "" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_user_profile", "summary": "Fetch Reddit APP User Profile", "description": "Fetch Reddit APP User Profile", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[A-Za-z0-9_-]+$", "description": "Username", "title": "Username" }, "description": "Username", "example": "spez" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/reddit/app/fetch_user_trophies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Reddit" ], "operationId": "get_tikhub_reddit_app_fetch_user_trophies", "summary": "Fetch User Public Trophies", "description": "Fetch User Public Trophies", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "minLength": 2, "maxLength": 16, "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "description": "Preferred response language as an IETF language tag; default: en-US", "default": "en-US", "title": "Language" }, "description": "Preferred response language as an IETF language tag; default: en-US" }, { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[A-Za-z0-9_-]+$", "description": "Username", "title": "Username" }, "description": "Username", "example": "spez" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": false, "title": "Need Format" }, "description": "Whether to clean and format the data", "example": false } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/telegram/web/batch_channel_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Telegram" ], "operationId": "get_tikhub_telegram_web_batch_channel_info", "summary": "Batch channel info", "description": "Batch channel info", "parameters": [ { "name": "channels", "in": "query", "required": true, "schema": { "type": "string", "description": "Comma-separated usernames (max 20", "title": "Channels" }, "description": "Comma-separated usernames (max 20", "example": "durov,telegram" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/telegram/web/fetch_channel_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Telegram" ], "operationId": "get_tikhub_telegram_web_fetch_channel_info", "summary": "Get channel info", "description": "Get channel info", "parameters": [ { "name": "channel", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel username", "title": "Channel" }, "description": "Channel username", "example": "durov" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/telegram/web/fetch_channel_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Telegram" ], "operationId": "get_tikhub_telegram_web_fetch_channel_posts", "summary": "Get channel posts (paginated)", "description": "Get channel posts (paginated)", "parameters": [ { "name": "channel", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel username", "title": "Channel" }, "description": "Channel username", "example": "durov" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of posts", "default": 20, "title": "Limit" }, "description": "Number of posts", "example": 20 }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "description": "Older than this id", "default": 0, "title": "Before" }, "description": "Older than this id", "example": 0 }, { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "description": "Newer than this id", "default": 0, "title": "After" }, "description": "Newer than this id", "example": 0 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/telegram/web/fetch_channel_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Telegram" ], "operationId": "get_tikhub_telegram_web_fetch_channel_search", "summary": "Search posts in a channel", "description": "Search posts in a channel", "parameters": [ { "name": "channel", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel username", "title": "Channel" }, "description": "Channel username", "example": "durov" }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Query" }, "description": "Keyword", "example": "TON" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of hits", "default": 20, "title": "Limit" }, "description": "Number of hits", "example": 20 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/telegram/web/fetch_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Telegram" ], "operationId": "get_tikhub_telegram_web_fetch_post_comments", "summary": "Post comments", "description": "Post comments", "parameters": [ { "name": "channel", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel username", "title": "Channel" }, "description": "Channel username", "example": "durov" }, { "name": "post_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Post ID", "title": "Post Id" }, "description": "Post ID", "example": 510 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of comments", "default": 50, "title": "Limit" }, "description": "Number of comments", "example": 50 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/telegram/web/fetch_post_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Telegram" ], "operationId": "get_tikhub_telegram_web_fetch_post_detail", "summary": "Get single post", "description": "Get single post", "parameters": [ { "name": "channel", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel username", "title": "Channel" }, "description": "Channel username", "example": "durov" }, { "name": "post_id", "in": "query", "required": true, "schema": { "type": "integer", "description": "Post ID", "title": "Post Id" }, "description": "Post ID", "example": 510 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/telegram/web/fetch_similar_channels": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Telegram" ], "operationId": "get_tikhub_telegram_web_fetch_similar_channels", "summary": "Similar channels", "description": "Similar channels", "parameters": [ { "name": "channel", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel username", "title": "Channel" }, "description": "Channel username", "example": "durov" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/threads/web/fetch_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Threads" ], "operationId": "get_tikhub_threads_web_fetch_post_comments", "summary": "Get post comments (no pagination)", "description": "Get post comments (no pagination)", "parameters": [ { "name": "post_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Post Id" }, "description": "Post ID", "example": "3390920896561588969" }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor (no pagination, has no effect", "title": "End Cursor" }, "description": "Pagination cursor (no pagination, has no effect" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/threads/web/fetch_post_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Threads" ], "operationId": "get_tikhub_threads_web_fetch_post_detail", "summary": "Get post detail", "description": "Get post detail", "parameters": [ { "name": "post_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Post Id" }, "description": "Post ID", "example": "3349029093483693129" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/threads/web/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Threads" ], "operationId": "get_tikhub_threads_web_fetch_user_info", "summary": "Get user info", "description": "Get user info", "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string", "description": "Username", "title": "Username" }, "description": "Username", "example": "lilbieber" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/threads/web/fetch_user_info_by_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Threads" ], "operationId": "get_tikhub_threads_web_fetch_user_info_by_id", "summary": "Get user info by ID", "description": "Get user info by ID", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "67027868801" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/threads/web/fetch_user_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Threads" ], "operationId": "get_tikhub_threads_web_fetch_user_posts", "summary": "Get user posts (no pagination)", "description": "Get user posts (no pagination)", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "63625256886" }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor (no pagination, has no effect", "title": "End Cursor" }, "description": "Pagination cursor (no pagination, has no effect" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/threads/web/fetch_user_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Threads" ], "operationId": "get_tikhub_threads_web_fetch_user_replies", "summary": "Get user replies (no pagination)", "description": "Get user replies (no pagination)", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "63625256886" }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor (no pagination, has no effect", "title": "End Cursor" }, "description": "Pagination cursor (no pagination, has no effect" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/threads/web/fetch_user_reposts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Threads" ], "operationId": "get_tikhub_threads_web_fetch_user_reposts", "summary": "Get user reposts (no pagination)", "description": "Get user reposts (no pagination)", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "63625256886" }, { "name": "end_cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination cursor (no pagination, has no effect", "title": "End Cursor" }, "description": "Pagination cursor (no pagination, has no effect" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/threads/web/search_profiles": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0029, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Threads" ], "operationId": "get_tikhub_threads_web_search_profiles", "summary": "Search profiles", "description": "Search profiles", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search query", "title": "Query" }, "description": "Search query", "example": "mark" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/tiktok/web/fetch_home_feed": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Tiktok" ], "operationId": "post_tikhub_tiktok_web_fetch_home_feed", "summary": "Home Feed", "description": "Home Feed", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_fetch_home_feed_api_v1_tiktok_web_fetch_home_feed_post" } } } }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/toutiao/app/get_article_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Toutiao" ], "operationId": "get_tikhub_toutiao_app_get_article_info", "summary": "Get information of specified article", "description": "Get information of specified article", "parameters": [ { "name": "group_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Group Id" }, "description": "Post ID", "example": "7450114952884503059" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/toutiao/app/get_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Toutiao" ], "operationId": "get_tikhub_toutiao_app_get_comments", "summary": "Get comments of specified post", "description": "Get comments of specified post", "parameters": [ { "name": "group_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Group Id" }, "description": "Post ID", "example": "7453372680222523931" }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string", "description": "Offset", "title": "Offset" }, "description": "Offset", "example": "0" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/toutiao/app/get_user_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Toutiao" ], "operationId": "get_tikhub_toutiao_app_get_user_id", "summary": "Get user_id from user profile", "description": "Get user_id from user profile", "parameters": [ { "name": "user_profile_url", "in": "query", "required": true, "schema": { "type": "string", "description": "User profile URL", "title": "User Profile Url" }, "description": "User profile URL", "example": "https://www.toutiao.com/c/user/token/MS4wLjABAAAAwK6echNksY69R8l2vcZudupfhTItbGSGt-8ineO5UaB4L-djqkYDgB6TkAdMvrmW/" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/toutiao/app/get_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Toutiao" ], "operationId": "get_tikhub_toutiao_app_get_user_info", "summary": "Get information of specified user", "description": "Get information of specified user", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "User Id" }, "description": "User ID", "example": "1352838578180211" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/toutiao/app/get_video_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Toutiao" ], "operationId": "get_tikhub_toutiao_app_get_video_info", "summary": "Get information of specified video", "description": "Get information of specified video", "parameters": [ { "name": "group_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Group Id" }, "description": "Post ID", "example": "7431543350882206242" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/toutiao/web/get_article_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Toutiao" ], "operationId": "get_tikhub_toutiao_web_get_article_info", "summary": "Get information of specified article", "description": "Get information of specified article", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Aweme Id" }, "description": "Post ID", "example": "7450114952884503059" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/toutiao/web/get_video_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Toutiao" ], "operationId": "get_tikhub_toutiao_web_get_video_info", "summary": "Get information of specified video", "description": "Get information of specified video", "parameters": [ { "name": "aweme_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Aweme Id" }, "description": "Post ID", "example": "7431543350882206242" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_check_follow": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_check_follow", "summary": "Check follow", "description": "Check follow", "parameters": [ { "name": "user_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Source Screen Name", "title": "User Name" }, "description": "Source Screen Name", "example": "elonmusk" }, { "name": "follows", "in": "query", "required": true, "schema": { "type": "string", "description": "Target Screen Name", "title": "Follows" }, "description": "Target Screen Name", "example": "NASA" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_check_retweet": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_check_retweet", "summary": "Check retweet", "description": "Check retweet", "parameters": [ { "name": "screen_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Screen Name", "title": "Screen Name" }, "description": "Screen Name", "example": "elonmusk" }, { "name": "tweet_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Tweet ID", "title": "Tweet Id" }, "description": "Tweet ID", "example": "1808168603721650364" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_community_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_community_info", "summary": "Get community info", "description": "Get community info", "parameters": [ { "name": "community_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Community ID", "title": "Community Id" }, "description": "Community ID", "example": "1493290339532222469" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_community_members": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_community_members", "summary": "Get community members (no pagination)", "description": "Get community members (no pagination)", "parameters": [ { "name": "community_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Community ID", "title": "Community Id" }, "description": "Community ID", "example": "1493290339532222469" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor (no pagination, has no effect", "title": "Cursor" }, "description": "Cursor (no pagination, has no effect" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_community_timeline": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_community_timeline", "summary": "Get community timeline", "description": "Get community timeline", "parameters": [ { "name": "community_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Community ID", "title": "Community Id" }, "description": "Community ID", "example": "1493290339532222469" }, { "name": "ranking", "in": "query", "required": false, "schema": { "type": "string", "description": "Ranking", "title": "Ranking" }, "description": "Ranking" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_latest_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_latest_post_comments", "summary": "Get the latest tweet comments", "description": "Get the latest tweet comments", "parameters": [ { "name": "tweet_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Tweet ID", "title": "Tweet Id" }, "description": "Tweet ID", "example": "1808168603721650364" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_list_followers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_list_followers", "summary": "Get list followers", "description": "Get list followers", "parameters": [ { "name": "list_id", "in": "query", "required": true, "schema": { "type": "string", "description": "List ID", "title": "List Id" }, "description": "List ID", "example": "84839422" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_list_members": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_list_members", "summary": "Get list members", "description": "Get list members", "parameters": [ { "name": "list_id", "in": "query", "required": true, "schema": { "type": "string", "description": "List ID", "title": "List Id" }, "description": "List ID", "example": "84839422" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_list_timeline": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_list_timeline", "summary": "Get list timeline", "description": "Get list timeline", "parameters": [ { "name": "list_id", "in": "query", "required": true, "schema": { "type": "string", "description": "List ID", "title": "List Id" }, "description": "List ID", "example": "84839422" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_post_comments", "summary": "Get comments", "description": "Get comments", "parameters": [ { "name": "tweet_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Tweet ID", "title": "Tweet Id" }, "description": "Tweet ID", "example": "1835124037934367098" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_retweet_user_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_retweet_user_list", "summary": "ReTweet User list", "description": "ReTweet User list", "parameters": [ { "name": "tweet_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Tweet ID", "title": "Tweet Id" }, "description": "Tweet ID", "example": "1835124037934367098" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_search_communities": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_search_communities", "summary": "Search communities", "description": "Search communities", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keyword", "title": "Keyword" }, "description": "Search Keyword", "example": "superman" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_search_timeline": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_search_timeline", "summary": "Search", "description": "Search", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Search Keyword", "title": "Keyword" }, "description": "Search Keyword", "example": "Elon Musk" }, { "name": "search_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Search Type", "default": "Top", "title": "Search Type" }, "description": "Search Type", "example": "Top" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_trending": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_trending", "summary": "Trending", "description": "Trending", "parameters": [ { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "description": "Country", "default": "UnitedStates", "title": "Country" }, "description": "Country", "example": "UnitedStates" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_tweet_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_tweet_detail", "summary": "Get single tweet data", "description": "Get single tweet data", "parameters": [ { "name": "tweet_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Tweet ID", "title": "Tweet Id" }, "description": "Tweet ID", "example": "1808168603721650364" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_about": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_about", "summary": "Get user about profile", "description": "Get user about profile", "parameters": [ { "name": "screen_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Screen Name", "title": "Screen Name" }, "description": "Screen Name", "example": "elonmusk" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_affiliates": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_affiliates", "summary": "Get user affiliates", "description": "Get user affiliates", "parameters": [ { "name": "screen_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Screen Name", "title": "Screen Name" }, "description": "Screen Name", "example": "NASA" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_followers": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_followers", "summary": "User Followers", "description": "User Followers", "parameters": [ { "name": "screen_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Screen Name", "title": "Screen Name" }, "description": "Screen Name", "example": "elonmusk" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_followings": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_followings", "summary": "User Followings", "description": "User Followings", "parameters": [ { "name": "screen_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Screen Name", "title": "Screen Name" }, "description": "Screen Name", "example": "elonmusk" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_live_status": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_live_status", "summary": "Check user live status", "description": "Check user live status", "parameters": [ { "name": "rest_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User Rest ID", "title": "Rest Id" }, "description": "User Rest ID", "example": "44196397" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_media": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_media", "summary": "Get user media", "description": "Get user media", "parameters": [ { "name": "screen_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Screen Name", "title": "Screen Name" }, "description": "Screen Name", "example": "elonmusk" }, { "name": "rest_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "User ID", "title": "Rest Id" }, "description": "User ID", "example": "44196397" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Page Cursor", "title": "Cursor" }, "description": "Page Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_post_tweet": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_post_tweet", "summary": "Get user post", "description": "Get user post", "parameters": [ { "name": "screen_name", "in": "query", "required": false, "schema": { "type": "string", "description": "Screen Name", "title": "Screen Name" }, "description": "Screen Name", "example": "elonmusk" }, { "name": "rest_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "User ID", "title": "Rest Id" }, "description": "User ID", "example": "44196397" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_profile": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_profile", "summary": "Get user profile", "description": "Get user profile", "parameters": [ { "name": "screen_name", "in": "query", "required": false, "schema": { "type": "string", "description": "Screen Name", "title": "Screen Name" }, "description": "Screen Name", "example": "elonmusk" }, { "name": "rest_id", "in": "query", "required": false, "schema": { "type": "integer", "description": "User ID (If the user ID is used, the user name will be ignored", "title": "Rest Id" }, "description": "User ID (If the user ID is used, the user name will be ignored", "example": "44196397" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_profiles_by_rest_ids": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_profiles_by_rest_ids", "summary": "Get profiles by rest ids", "description": "Get profiles by rest ids", "parameters": [ { "name": "rest_ids", "in": "query", "required": true, "schema": { "type": "string", "description": "User IDs, comma separated", "title": "Rest Ids" }, "description": "User IDs, comma separated", "example": "44196397,34743251" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/twitter/web/fetch_user_tweet_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Twitter" ], "operationId": "get_tikhub_twitter_web_fetch_user_tweet_replies", "summary": "Get user tweet replies", "description": "Get user tweet replies", "parameters": [ { "name": "screen_name", "in": "query", "required": true, "schema": { "type": "string", "description": "Screen Name", "title": "Screen Name" }, "description": "Screen Name", "example": "elonmusk" }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "description": "Cursor", "title": "Cursor" }, "description": "Cursor" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_channel_id_to_username": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_channel_id_to_username", "summary": "Convert Channel ID to Finder Username", "description": "Convert Channel ID to Finder Username", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchChannelIdToUsernameRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_channel_info": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_channel_info", "summary": "Get WeChat Channels Account Info", "description": "Get WeChat Channels Account Info", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchChannelInfoRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_collection_videos": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_collection_videos", "summary": "Get WeChat Channels Collection Videos", "description": "Get WeChat Channels Collection Videos", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchCollectionVideosRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_live_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_live_detail", "summary": "Get WeChat Channels Live Detail", "description": "Get WeChat Channels Live Detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchLiveDetailRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_live_history": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_live_history", "summary": "Get WeChat Channels Live History", "description": "Get WeChat Channels Live History", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchLiveHistoryRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_search_channel_videos": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_search_channel_videos", "summary": "Search Videos Within a WeChat Channel", "description": "Search Videos Within a WeChat Channel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchSearchChannelVideosRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_user_collections": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_user_collections", "summary": "Get WeChat Channels User Collections", "description": "Get WeChat Channels User Collections", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchUserCollectionsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_user_profile": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_user_profile", "summary": "Get WeChat Channels User Profile & Stats", "description": "Get WeChat Channels User Profile & Stats", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchUserProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_user_videos": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_user_videos", "summary": "Get WeChat Channels User Videos", "description": "Get WeChat Channels User Videos", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchUserVideosRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_video_comments": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_video_comments", "summary": "Get WeChat Channels Video Comments", "description": "Get WeChat Channels Video Comments", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchVideoCommentsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_video_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_video_detail", "summary": "Get WeChat Channels Video Detail", "description": "Get WeChat Channels Video Detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchVideoDetailRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_channels/v2/fetch_video_share_url": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_channels" ], "operationId": "post_tikhub_wechat_channels_v2_fetch_video_share_url", "summary": "Generate WeChat Channels Video Share URL", "description": "Generate WeChat Channels Video Share URL", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchVideoShareUrlRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_account_articles": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_account_articles", "summary": "Get WeChat MP Account Articles", "description": "Get WeChat MP Account Articles", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAccountArticlesRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_account_profile": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_account_profile", "summary": "Get WeChat MP Account Profile", "description": "Get WeChat MP Account Profile", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAccountRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_account_services": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_account_services", "summary": "Get WeChat MP Account Services & Custom Menu", "description": "Get WeChat MP Account Services & Custom Menu", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAccountRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_article_ad": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_article_ad", "summary": "Get WeChat MP Article Ads", "description": "Get WeChat MP Article Ads", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchArticleDetailRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_article_comments": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_article_comments", "summary": "Get WeChat MP Article Comments", "description": "Get WeChat MP Article Comments", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchArticleCommentsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_article_detail": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_article_detail", "summary": "Get WeChat MP Article Detail", "description": "Get WeChat MP Article Detail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchArticleDetailRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_article_detail_h5": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_article_detail_h5", "summary": "Get WeChat MP Article Detail (H5, Recommended)", "description": "Get WeChat MP Article Detail (H5, Recommended)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchArticleDetailRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_article_stats": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_article_stats", "summary": "Get WeChat MP Article Stats", "description": "Get WeChat MP Article Stats", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchArticleDetailRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_article_stats_h5": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_article_stats_h5", "summary": "Get WeChat MP Article Stats (H5)", "description": "Get WeChat MP Article Stats (H5)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchArticleStatsH5Request" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_comment_replies": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_comment_replies", "summary": "Get WeChat MP Comment Replies", "description": "Get WeChat MP Comment Replies", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchCommentRepliesRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_mp/v2/fetch_related_articles": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_mp" ], "operationId": "post_tikhub_wechat_mp_v2_fetch_related_articles", "summary": "Get WeChat MP Related Articles", "description": "Get WeChat MP Related Articles", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchArticleDetailRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_search/v2/fetch_search": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_search" ], "operationId": "post_tikhub_wechat_search_v2_fetch_search", "summary": "WeChat Universal Search", "description": "WeChat Universal Search", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchSearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/wechat_search/v2/fetch_search_videos": { "post": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Wechat_search" ], "operationId": "post_tikhub_wechat_search_v2_fetch_search_videos", "summary": "WeChat Channels Video Search", "description": "WeChat Channels Video Search", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchSearchVideosRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/weibo/web_v2/fetch_hot_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_hot_search", "summary": "Get Weibo hot search ranking", "description": "Get Weibo hot search ranking", "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/weibo/web_v2/fetch_user_following": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_following", "summary": "Get user following list", "description": "Get user following list", "parameters": [ { "name": "uid", "in": "query", "required": true, "schema": { "type": "string", "description": "User ID", "title": "Uid" }, "description": "User ID", "example": "1722594714" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "description": "Page number", "default": 0, "title": "Page" }, "description": "Page number", "example": 0 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/weibo/web_v2/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Weibo" ], "operationId": "get_tikhub_weibo_web_v2_fetch_user_info", "summary": "Get user information", "description": "Get user information", "parameters": [ { "name": "uid", "in": "query", "required": false, "schema": { "description": "User id", "default": "", "title": "Uid", "nullable": true, "type": "string" }, "description": "User id", "example": "1722594714" }, { "name": "custom", "in": "query", "required": false, "schema": { "description": "Custom Weibo username", "default": "", "title": "Custom", "nullable": true, "type": "string" }, "description": "Custom Weibo username", "example": "shuqi" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xigua/app/v2/fetch_one_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xigua" ], "operationId": "get_tikhub_xigua_app_v2_fetch_one_video", "summary": "Get single video data", "description": "Get single video data", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Item Id" }, "description": "Video id", "example": "7354954305222377999" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xigua/app/v2/fetch_one_video_play_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xigua" ], "operationId": "get_tikhub_xigua_app_v2_fetch_one_video_play_url", "summary": "Get single video play URL", "description": "Get single video play URL", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Item Id" }, "description": "Video id", "example": "7354954305222377999" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xigua/app/v2/fetch_user_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xigua" ], "operationId": "get_tikhub_xigua_app_v2_fetch_user_info", "summary": "Personal information", "description": "Personal information", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "User Id" }, "description": "User id", "example": "52712347586" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xigua/app/v2/fetch_user_post_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xigua" ], "operationId": "get_tikhub_xigua_app_v2_fetch_user_post_list", "summary": "Get user post list", "description": "Get user post list", "parameters": [ { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "description": "User id", "title": "User Id" }, "description": "User id", "example": "1922379661976311" }, { "name": "max_behot_time", "in": "query", "required": false, "schema": { "type": "string", "description": "Maximum behavior time", "title": "Max Behot Time" }, "description": "Maximum behavior time" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xigua/app/v2/fetch_video_comment_list": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xigua" ], "operationId": "get_tikhub_xigua_app_v2_fetch_video_comment_list", "summary": "Video comment list", "description": "Video comment list", "parameters": [ { "name": "item_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video id", "title": "Item Id" }, "description": "Video id", "example": "7354954305222377999" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset" }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "description": "Count", "default": 20, "title": "Count" }, "description": "Count" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/xigua/app/v2/search_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Xigua" ], "operationId": "get_tikhub_xigua_app_v2_search_video", "summary": "Search video", "description": "Search video", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "description": "Keyword", "title": "Keyword" }, "description": "Keyword", "example": "See API documentation" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Offset", "default": 0, "title": "Offset" }, "description": "Offset" }, { "name": "order_type", "in": "query", "required": false, "schema": { "type": "string", "description": "Order type", "title": "Order Type" }, "description": "Order type" }, { "name": "min_duration", "in": "query", "required": false, "schema": { "type": "integer", "description": "Minimum duration", "title": "Min Duration" }, "description": "Minimum duration" }, { "name": "max_duration", "in": "query", "required": false, "schema": { "type": "integer", "description": "Maximum duration", "title": "Max Duration" }, "description": "Maximum duration" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web/get_channel_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_get_channel_info", "summary": "Get channel information", "description": "Get channel information", "parameters": [ { "name": "channel_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" }, "description": "Channel ID", "example": "UCXuqSBlHAE6Xw-yeJA0Tunw" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web/get_channel_short_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_get_channel_short_videos", "summary": "Get channel short videos", "description": "Get channel short videos", "parameters": [ { "name": "channel_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" }, "description": "Channel ID", "example": "UCXuqSBlHAE6Xw-yeJA0Tunw" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Continuation Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web/get_channel_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_get_channel_url", "summary": "Get channel URL from channel ID", "description": "Get channel URL from channel ID", "parameters": [ { "name": "channel_id", "in": "query", "required": true, "schema": { "type": "string", "description": "ID/Channel ID ( UCeu6U67OzJhV1KwBansH3Dg", "title": "Channel Id" }, "description": "ID/Channel ID ( UCeu6U67OzJhV1KwBansH3Dg", "example": "UCeu6U67OzJhV1KwBansH3Dg" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web/get_relate_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_get_relate_video", "summary": "Get related videos", "description": "Get related videos", "parameters": [ { "name": "video_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Video ID", "title": "Video Id" }, "description": "Video ID", "example": "LuIL5JATZsc" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Continuation Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web/get_trending_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_get_trending_videos", "summary": "Get trending videos", "description": "Get trending videos", "parameters": [ { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "en", "title": "Language Code" }, "description": "Language code" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "us", "title": "Country Code" }, "description": "Country code" }, { "name": "section", "in": "query", "required": false, "schema": { "type": "string", "description": "Section", "default": "Now", "title": "Section" }, "description": "Section" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web/search_channel": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_search_channel", "summary": "Search channel", "description": "Search channel", "parameters": [ { "name": "channel_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" }, "description": "Channel ID", "example": "UCXuqSBlHAE6Xw-yeJA0Tunw" }, { "name": "search_query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Search Query" }, "description": "Search keyword", "example": "AMD" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "en", "title": "Language Code" }, "description": "Language code" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "us", "title": "Country Code" }, "description": "Country code" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Continuation Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web/search_video": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_search_video", "summary": "Search video", "description": "Search video", "parameters": [ { "name": "search_query", "in": "query", "required": true, "schema": { "type": "string", "description": "Search keyword", "title": "Search Query" }, "description": "Search keyword", "example": "Minecraft" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "en", "title": "Language Code" }, "description": "Language code" }, { "name": "order_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Order by", "default": "this_month", "title": "Order By" }, "description": "Order by" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "us", "title": "Country Code" }, "description": "Country code" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Continuation Token" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_channel_community_posts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_channel_community_posts", "summary": "Get channel community posts", "description": "Get channel community posts", "parameters": [ { "name": "channel_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" }, "description": "Channel ID", "example": "UCkRfArvrzheW2E7b6SVT7vQ" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code", "example": "zh-CN" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code", "example": "US" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token for next page", "title": "Continuation Token" }, "description": "Pagination token for next page" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": true, "title": "Need Format" }, "description": "Whether to clean and format the data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_channel_description": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_channel_description", "summary": "Get channel description", "description": "Get channel description", "parameters": [ { "name": "channel_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Channel ID, can be obtained from channel URL via get_channel_id endpoint", "title": "Channel Id" }, "description": "Channel ID, can be obtained from channel URL via get_channel_id endpoint", "example": "UCeu6U67OzJhV1KwBansH3Dg" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Continuation token for getting advanced info like channel creation date", "title": "Continuation Token" }, "description": "Continuation token for getting advanced info like channel creation date" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code", "example": "zh-CN" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code", "example": "US" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": true, "title": "Need Format" }, "description": "Whether to clean and format the data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_channel_id": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_channel_id", "summary": "Get channel ID from URL", "description": "Get channel ID from URL", "parameters": [ { "name": "channel_url", "in": "query", "required": true, "schema": { "type": "string", "description": "channelname", "title": "Channel Url" }, "description": "channelname", "example": "https://www.youtube.com/@CozyCraftYT" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_channel_shorts": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_channel_shorts", "summary": "Get channel shorts", "description": "Get channel shorts", "parameters": [ { "name": "channel_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Channel ID (e.g., UCuAXFkgsw1L7xaCfnd5JJOw", "title": "Channel Id" }, "description": "Channel ID (e.g., UCuAXFkgsw1L7xaCfnd5JJOw", "example": "UCuAXFkgsw1L7xaCfnd5JJOw" }, { "name": "channel_url", "in": "query", "required": false, "schema": { "type": "string", "description": "Ignored if channel_id is provided", "title": "Channel Url" }, "description": "Ignored if channel_id is provided", "example": "https://www.youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Continuation Token" }, "description": "Pagination token" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to format data", "default": true, "title": "Need Format" }, "description": "Whether to format data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_channel_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_channel_url", "summary": "Get channel URL from channel ID", "description": "Get channel URL from channel ID", "parameters": [ { "name": "channel_id", "in": "query", "required": true, "schema": { "type": "string", "description": "ID/Channel ID ( UCeu6U67OzJhV1KwBansH3Dg", "title": "Channel Id" }, "description": "ID/Channel ID ( UCeu6U67OzJhV1KwBansH3Dg", "example": "UCeu6U67OzJhV1KwBansH3Dg" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_channel_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_channel_videos", "summary": "Get channel videos", "description": "Get channel videos", "parameters": [ { "name": "channel_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" }, "description": "Channel ID", "example": "UCJHBJ7F-nAIlMGolm0Hu4vg" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code", "example": "zh-CN" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code", "example": "US" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token for next page", "title": "Continuation Token" }, "description": "Pagination token for next page" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": true, "title": "Need Format" }, "description": "Whether to clean and format the data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_general_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_general_search", "summary": "General search (raw data, recommend V2)", "description": "General search (raw data, recommend V2)", "parameters": [ { "name": "search_query", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 200, "description": "Search keyword", "title": "Search Query" }, "description": "Search keyword", "example": "Python" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code" }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "description": "Time zone", "default": "America/Los_Angeles", "title": "Time Zone" }, "description": "Time zone" }, { "name": "upload_time", "in": "query", "required": false, "schema": { "description": "Upload time filter", "examples": { "hour": { "summary": "1", "value": "hour" }, "today": { "summary": "See API documentation", "value": "today" }, "week": { "summary": "See API documentation", "value": "week" }, "month": { "summary": "See API documentation", "value": "month" }, "year": { "summary": "See API documentation", "value": "year" } }, "title": "Upload Time", "nullable": true, "$ref": "#/components/schemas/YouTubeUploadTimeAPI" }, "description": "Upload time filter" }, { "name": "duration", "in": "query", "required": false, "schema": { "description": "Duration filter", "examples": { "short": { "summary": "<4", "value": "short" }, "medium": { "summary": "4-20", "value": "medium" }, "long": { "summary": ">20", "value": "long" } }, "title": "Duration", "nullable": true, "$ref": "#/components/schemas/YouTubeDurationAPI" }, "description": "Duration filter" }, { "name": "content_type", "in": "query", "required": false, "schema": { "description": "Content type filter", "examples": { "video": { "summary": "See API documentation", "value": "video" }, "channel": { "summary": "See API documentation", "value": "channel" }, "playlist": { "summary": "See API documentation", "value": "playlist" }, "movie": { "summary": "See API documentation", "value": "movie" } }, "title": "Content Type", "nullable": true, "$ref": "#/components/schemas/YouTubeContentTypeAPI" }, "description": "Content type filter" }, { "name": "feature", "in": "query", "required": false, "schema": { "description": "Feature filter", "examples": { "hd": { "summary": "See API documentation", "value": "hd" }, "4k": { "summary": "4K", "value": "4k" }, "subtitles": { "summary": "See API documentation", "value": "subtitles" }, "live": { "summary": "See API documentation", "value": "live" }, "creative_commons": { "summary": "See API documentation", "value": "creative_commons" }, "360": { "summary": "360", "value": "360" }, "vr180": { "summary": "VR180", "value": "vr180" }, "3d": { "summary": "3D", "value": "3d" }, "hdr": { "summary": "HDR", "value": "hdr" }, "location": { "summary": "See API documentation", "value": "location" }, "purchased": { "summary": "See API documentation", "value": "purchased" } }, "title": "Feature", "nullable": true, "$ref": "#/components/schemas/YouTubeFeatureAPI" }, "description": "Feature filter" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "description": "Sort by", "examples": { "relevance": { "summary": "See API documentation", "value": "relevance" }, "upload_date": { "summary": "See API documentation", "value": "upload_date" }, "view_count": { "summary": "See API documentation", "value": "view_count" }, "rating": { "summary": "See API documentation", "value": "rating" } }, "title": "Sort By", "nullable": true, "$ref": "#/components/schemas/YouTubeSearchSortAPI" }, "description": "Sort by" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "description": "Pagination token", "title": "Continuation Token", "nullable": true, "type": "string" }, "description": "Pagination token" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_post_comment_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_post_comment_replies", "summary": "Get post comment replies", "description": "Get post comment replies", "parameters": [ { "name": "continuation_token", "in": "query", "required": true, "schema": { "type": "string", "description": "Reply continuation token from post comment", "title": "Continuation Token" }, "description": "Reply continuation token from post comment" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code", "example": "zh-CN" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code", "example": "US" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": true, "title": "Need Format" }, "description": "Whether to clean and format the data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_post_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_post_comments", "summary": "Get post comments", "description": "Get post comments", "parameters": [ { "name": "post_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Post ID (required for first request", "title": "Post Id" }, "description": "Post ID (required for first request", "example": "UgkxiCSRfD6g7SPlWGPDa3vbP7aIsytXRkvy" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Continuation Token" }, "description": "Pagination token" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code", "example": "zh-CN" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code", "example": "US" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": true, "title": "Need Format" }, "description": "Whether to clean and format the data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_post_detail": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_post_detail", "summary": "Get post detail", "description": "Get post detail", "parameters": [ { "name": "post_id", "in": "query", "required": true, "schema": { "type": "string", "description": "Post ID", "title": "Post Id" }, "description": "Post ID", "example": "UgkxiCSRfD6g7SPlWGPDa3vbP7aIsytXRkvy" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code", "example": "zh-CN" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code", "example": "US" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": true, "title": "Need Format" }, "description": "Whether to clean and format the data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_related_videos": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_related_videos", "summary": "Get related videos", "description": "Get related videos", "parameters": [ { "name": "video_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Video ID", "title": "Video Id" }, "description": "Video ID", "example": "dQw4w9WgXcQ" }, { "name": "video_url", "in": "query", "required": false, "schema": { "type": "string", "description": "Ignored if video_id is provided", "title": "Video Url" }, "description": "Ignored if video_id is provided", "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to format data. true: return formatted structured data, false: return raw API structure", "default": true, "title": "Need Format" }, "description": "Whether to format data. true: return formatted structured data, false: return raw API structure" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_search_suggestions": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_search_suggestions", "summary": "Get search suggestions", "description": "Get search suggestions", "parameters": [ { "name": "keyword", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 200, "description": "Search keyword", "title": "Keyword" }, "description": "Search keyword", "example": "Rick Astley" }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code (e.g., en, zh-cn, ja", "default": "en", "title": "Language" }, "description": "Language code (e.g., en, zh-cn, ja", "example": "en" }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "description": "Region code (e.g., US, SG, CN, JP", "default": "US", "title": "Region" }, "description": "Region code (e.g., US, SG, CN, JP", "example": "US" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_shorts_search": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_shorts_search", "summary": "Shorts search (raw data, recommend V2)", "description": "Shorts search (raw data, recommend V2)", "parameters": [ { "name": "search_query", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 200, "description": "Search keyword", "title": "Search Query" }, "description": "Search keyword", "example": "Python" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "en-US", "title": "Language Code" }, "description": "Language code", "example": "en-US" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code", "example": "US" }, { "name": "time_zone", "in": "query", "required": false, "schema": { "type": "string", "description": "Time zone", "default": "America/Los_Angeles", "title": "Time Zone" }, "description": "Time zone", "example": "America/Los_Angeles" }, { "name": "upload_time", "in": "query", "required": false, "schema": { "description": "Upload time filter for Shorts", "examples": { "hour": { "summary": "1", "value": "hour" }, "today": { "summary": "See API documentation", "value": "today" }, "week": { "summary": "See API documentation", "value": "week" }, "month": { "summary": "See API documentation", "value": "month" }, "year": { "summary": "See API documentation", "value": "year" } }, "title": "Upload Time", "nullable": true, "$ref": "#/components/schemas/YouTubeUploadTimeAPI" }, "description": "Upload time filter for Shorts" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "description": "Sort by for Shorts", "examples": { "relevance": { "summary": "See API documentation", "value": "relevance" }, "upload_date": { "summary": "See API documentation", "value": "upload_date" }, "view_count": { "summary": "See API documentation", "value": "view_count" }, "rating": { "summary": "See API documentation", "value": "rating" } }, "title": "Sort By", "nullable": true, "$ref": "#/components/schemas/YouTubeSearchSortAPI" }, "description": "Sort by for Shorts" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "description": "Pagination token", "title": "Continuation Token", "nullable": true, "type": "string" }, "description": "Pagination token", "example": "" }, { "name": "filter_mixed_content", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter mixed content (long videos), default True", "default": true, "title": "Filter Mixed Content" }, "description": "Filter mixed content (long videos), default True", "example": true } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_signed_stream_url": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_signed_stream_url", "summary": "Get signed video stream URL", "description": "Get signed video stream URL", "parameters": [ { "name": "video_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Video ID", "title": "Video Id" }, "description": "Video ID", "example": "dQw4w9WgXcQ" }, { "name": "video_url", "in": "query", "required": false, "schema": { "type": "string", "description": "Ignored if video_id is provided", "title": "Video Url" }, "description": "Ignored if video_id is provided", "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, { "name": "itag", "in": "query", "required": true, "schema": { "type": "integer", "description": "Format identifier itag (obtained from get_video_streams endpoint", "title": "Itag" }, "description": "Format identifier itag (obtained from get_video_streams endpoint", "example": 18 } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_video_captions": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0116, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_video_captions", "summary": "Get video captions", "description": "Get video captions", "parameters": [ { "name": "video_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Video ID", "title": "Video Id" }, "description": "Video ID", "example": "dQw4w9WgXcQ" }, { "name": "video_url", "in": "query", "required": false, "schema": { "type": "string", "description": "Video URL", "title": "Video Url" }, "description": "Video URL", "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code, returns available caption list if empty", "title": "Language Code" }, "description": "Language code, returns available caption list if empty", "example": "en" }, { "name": "format", "in": "query", "required": false, "schema": { "enum": [ "srt", "xml", "json3", "txt" ], "type": "string", "description": "Caption format", "default": "srt", "title": "Format" }, "description": "Caption format", "example": "srt" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_video_captions_result": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.0001, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_video_captions_result", "summary": "Get video captions async job result", "description": "Get video captions async job result", "parameters": [ { "name": "job_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "pattern": "^[A-Za-z0-9_-]+$", "description": "Async job ID", "title": "Job Id" }, "description": "Async job ID", "example": "123e4567-e89b-12d3-a456-426614174000" }, { "name": "format", "in": "query", "required": false, "schema": { "enum": [ "srt", "xml", "json3", "txt" ], "type": "string", "description": "Caption format", "default": "srt", "title": "Format" }, "description": "Caption format", "example": "srt" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_video_comment_replies": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_video_comment_replies", "summary": "Get video sub comments", "description": "Get video sub comments", "parameters": [ { "name": "continuation_token", "in": "query", "required": true, "schema": { "type": "string", "description": "Reply continuation token from first-level comment", "title": "Continuation Token" }, "description": "Reply continuation token from first-level comment" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code", "example": "zh-CN" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code", "example": "US" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": true, "title": "Need Format" }, "description": "Whether to clean and format the data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_video_comments": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_video_comments", "summary": "Get video comments", "description": "Get video comments", "parameters": [ { "name": "video_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 11, "maxLength": 11, "description": "Video ID", "title": "Video Id" }, "description": "Video ID", "example": "LuIL5JATZsc" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code", "example": "zh-CN" }, { "name": "country_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Country code", "default": "US", "title": "Country Code" }, "description": "Country code", "example": "US" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/CommentSortByAPI", "description": "Sort by", "examples": { "top": { "summary": "See API documentation", "value": "top" }, "newest": { "summary": "See API documentation", "value": "newest" } }, "default": "top" }, "description": "Sort by" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Continuation Token" }, "description": "Pagination token" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": true, "title": "Need Format" }, "description": "Whether to clean and format the data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_video_info": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_video_info", "summary": "Get video information", "description": "Get video information", "parameters": [ { "name": "video_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 11, "maxLength": 11, "description": "Video ID", "title": "Video Id" }, "description": "Video ID", "example": "oaSNBz4qMQY" }, { "name": "language_code", "in": "query", "required": false, "schema": { "type": "string", "description": "Language code", "default": "zh-CN", "title": "Language Code" }, "description": "Language code", "example": "zh-CN" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to clean and format the data", "default": true, "title": "Need Format" }, "description": "Whether to clean and format the data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/get_video_streams": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_get_video_streams", "summary": "Get video streams info", "description": "Get video streams info", "parameters": [ { "name": "video_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Video ID", "title": "Video Id" }, "description": "Video ID", "example": "dQw4w9WgXcQ" }, { "name": "video_url", "in": "query", "required": false, "schema": { "type": "string", "description": "Ignored if video_id is provided", "title": "Video Url" }, "description": "Ignored if video_id is provided", "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } }, "/tikhub/youtube/web_v2/search_channels": { "get": { "x-aisa-pricing": { "model": "dynamic", "currency": "USD", "basis": "provider_cost x 1.45", "nominal_usd": 0.00145, "cost_tier": "fixed", "note": "nominal_usd is the base (catalog) price = provider_cost x 1.45. Final charge = base x your subscription plan multiplier (Team 1.0x / Builder 1.2x / PAYG 1.5x). Charged only on a successful response (upstream body code == 200)." }, "tags": [ "TikHub - Youtube" ], "operationId": "get_tikhub_youtube_web_v2_search_channels", "summary": "Search channels", "description": "Search channels", "parameters": [ { "name": "keyword", "in": "query", "required": false, "schema": { "description": "Search keyword", "title": "Keyword", "nullable": true, "type": "string", "maxLength": 200 }, "description": "Search keyword", "example": "Rick Astley" }, { "name": "continuation_token", "in": "query", "required": false, "schema": { "type": "string", "description": "Pagination token", "title": "Continuation Token" }, "description": "Pagination token" }, { "name": "need_format", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to format data", "default": true, "title": "Need Format" }, "description": "Whether to format data" } ], "responses": { "200": { "description": "Successful response. Response structure varies; refer to the actual API response." } } } } } }